Uses of Interface
org.tribuo.protos.ProtoSerializable

Packages that use ProtoSerializable

Package	Description
org.tribuo	Provides the core interfaces and classes for using Tribuo.
org.tribuo.dataset	Provides utility datasets which subsample or otherwise transform the wrapped dataset.
org.tribuo.ensemble	Provides an interface for model prediction combinations, two base classes for ensemble models, a base class for ensemble excuses, and a Bagging implementation.
org.tribuo.hash	Provides the base interface and implementations of the Model hashing which obscures the feature names stored in a model.
org.tribuo.impl	Provides implementations of base classes and interfaces from org.tribuo.
org.tribuo.protos	Classes which control the serialization of Tribuo objects to and from protocol buffers.
org.tribuo.sequence	Provides core classes for working with sequences of Examples.
org.tribuo.transform	Provides infrastructure for applying transformations to a Dataset.
org.tribuo.transform.transformations	Provides implementations of standard transformations like binning, scaling, taking logs and exponents.

Uses of ProtoSerializable in org.tribuo

Subinterfaces of ProtoSerializable in org.tribuo

Modifier and Type	Interface	Description
interface	ImmutableOutputInfo<T extends Output<T>>	An OutputInfo that is fixed, and contains an id number for each valid output.
interface	MutableOutputInfo<T extends Output<T>>	A mutable OutputInfo that can record observed output values.
interface	Output<T extends Output<T>>	Output is the root interface for the supported prediction types.
interface	OutputFactory<T extends Output<T>>	An interface associated with a specific Output, which can generate the appropriate Output subclass, and OutputInfo subclass.
interface	OutputInfo<T extends Output<T>>	Tracks relevant properties of the appropriate Output subclass.
interface	VariableIDInfo	Adds an id number to a VariableInfo.
interface	VariableInfo	A VariableInfo subclass contains information about a feature and its observed values.

Classes in org.tribuo that implement ProtoSerializable

Modifier and Type	Class	Description
class	CategoricalIDInfo	Same as a CategoricalInfo, but with an additional int id field.
class	CategoricalInfo	Stores information about Categorical features.
class	Dataset<T extends Output<T>>	A class for sets of data, which are used to train and evaluate classifiers.
class	Example<T extends Output<T>>	An example used for training and evaluation.
class	FeatureMap	A map from Strings to VariableInfo objects storing information about a feature.
class	ImmutableDataset<T extends Output<T>>	This is a Dataset which has an ImmutableFeatureMap to store the feature information.
class	ImmutableFeatureMap	ImmutableFeatureMap is used when unknown features should not be added to the FeatureMap.
class	Model<T extends Output<T>>	A prediction model, which is used to predict outputs for unseen instances.
class	MutableDataset<T extends Output<T>>	A MutableDataset is a Dataset with a MutableFeatureMap which grows over time.
class	MutableFeatureMap	A feature map that can record new feature value observations.
class	Prediction<T extends Output<T>>	A prediction made by a Model.
class	RealIDInfo	Same as a RealInfo, but with an additional int id field.
class	RealInfo	Stores information about real valued features.
final class	SelectedFeatureSet	A record-like class for a selected feature set.
class	SkeletalVariableInfo	Contains information about a feature and can be stored in the feature map in a Dataset.
class	SparseModel<T extends Output<T>>	A model which uses a subset of the features it knows about to make predictions.

Uses of ProtoSerializable in org.tribuo.dataset

Classes in org.tribuo.dataset that implement ProtoSerializable

Modifier and Type	Class	Description
final class	DatasetView<T extends Output<T>>	DatasetView provides an immutable view on another Dataset that only exposes selected examples.
class	MinimumCardinalityDataset<T extends Output<T>>	This class creates a pruned dataset in which low frequency features that occur less than the provided minimum cardinality have been removed.
final class	SelectedFeatureDataset<T extends Output<T>>	This class creates a pruned dataset which only contains the selected features.

Uses of ProtoSerializable in org.tribuo.ensemble

Subinterfaces of ProtoSerializable in org.tribuo.ensemble

Modifier and Type	Interface	Description
interface	EnsembleCombiner<T extends Output<T>>	An interface for combining predictions.

Classes in org.tribuo.ensemble that implement ProtoSerializable

Modifier and Type	Class	Description
class	EnsembleModel<T extends Output<T>>	A model which contains a list of other Models.
final class	WeightedEnsembleModel<T extends Output<T>>	An ensemble model that uses weights to combine the ensemble member predictions.

Uses of ProtoSerializable in org.tribuo.hash

Classes in org.tribuo.hash that implement ProtoSerializable

Modifier and Type	Class	Description
final class	HashCodeHasher	Hashes names using String.hashCode().
final class	HashedFeatureMap	A FeatureMap used by the HashingTrainer to provide feature name hashing and guarantee that the Model does not contain feature name information, but still works with unhashed features names.
class	Hasher	An abstract base class for hash functions used to hash the names of features.
final class	MessageDigestHasher	Hashes Strings using the supplied MessageDigest type.
final class	ModHashCodeHasher	Hashes names using String.hashCode(), then reduces the dimension.

Uses of ProtoSerializable in org.tribuo.impl

Classes in org.tribuo.impl that implement ProtoSerializable

Modifier and Type	Class	Description
class	ArrayExample<T extends Output<T>>	An Example backed by two arrays, one of String and one of double.
final class	BinaryFeaturesExample<T extends Output<T>>	An Example backed by a single array of feature names.
class	IndexedArrayExample<T extends Output<T>>	A version of ArrayExample which also has the id numbers.
class	ListExample<T extends Output<T>>	This class will not be performant until value types are available in Java.

Uses of ProtoSerializable in org.tribuo.protos

Methods in org.tribuo.protos with type parameters of type ProtoSerializable

Modifier and Type	Method	Description
static <SERIALIZED extends com.google.protobuf.Message, PROTO_SERIALIZABLE extends ProtoSerializable<SERIALIZED>> PROTO_SERIALIZABLE	ProtoUtil.deserialize(SERIALIZED serialized)	Instantiates the class from the supplied protobuf fields.
static <SERIALIZED_CLASS extends com.google.protobuf.Message, SERIALIZED_DATA extends com.google.protobuf.Message, PROTO_SERIALIZABLE extends ProtoSerializable<SERIALIZED_CLASS>> SERIALIZED_CLASS	ProtoUtil.serialize(PROTO_SERIALIZABLE protoSerializable)	Serializes a ProtoSerializable class which has the appropriate ProtoSerializableClass annotations.

Method parameters in org.tribuo.protos with type arguments of type ProtoSerializable

Modifier and Type	Method	Description
static int	ProtoUtil.getCurrentVersion(Class<? extends ProtoSerializable<?>> clazz)	If this class is annotated with ProtoSerializableClass returns the version number, otherwise returns -1.

Uses of ProtoSerializable in org.tribuo.sequence

Classes in org.tribuo.sequence that implement ProtoSerializable

Modifier and Type	Class	Description
class	ImmutableSequenceDataset<T extends Output<T>>	This is a SequenceDataset which has an ImmutableFeatureMap to store the feature information.
class	IndependentSequenceModel<T extends Output<T>>	A SequenceModel which independently predicts each element of the sequence.
class	MinimumCardinalitySequenceDataset<T extends Output<T>>	This class creates a pruned dataset in which low frequency features that occur less than the provided minimum cardinality have been removed.
class	MutableSequenceDataset<T extends Output<T>>	A MutableSequenceDataset is a SequenceDataset with a MutableFeatureMap which grows over time.
class	SequenceDataset<T extends Output<T>>	A class for sets of data, which are used to train and evaluate classifiers.
class	SequenceExample<T extends Output<T>>	A sequence of examples, used for sequence classification.
class	SequenceModel<T extends Output<T>>	A prediction model, which is used to predict outputs for unseen instances.

Uses of ProtoSerializable in org.tribuo.transform

Subinterfaces of ProtoSerializable in org.tribuo.transform

Modifier and Type	Interface	Description
interface	Transformer	A fitted Transformation which can apply a transform to the input value.

Classes in org.tribuo.transform that implement ProtoSerializable

Modifier and Type	Class	Description
class	TransformedModel<T extends Output<T>>	Wraps a Model with it's TransformerMap so all Examples are transformed appropriately before the model makes predictions.
final class	TransformerMap	A collection of Transformers which can be applied to a Dataset or Example.

Uses of ProtoSerializable in org.tribuo.transform.transformations

Classes in org.tribuo.transform.transformations that implement ProtoSerializable

Modifier and Type	Class	Description
static final class	BinningTransformation.BinningTransformer	The implementation of a Transformer which splits the input into n bins.
final class	SimpleTransform	This is used for stateless functions such as exp, log, addition or multiplication by a constant.