Package org.tribuo.multilabel

Class MultiLabelFactory

java.lang.Object

org.tribuo.multilabel.MultiLabelFactory

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<OutputFactoryProvenance>, Serializable, OutputFactory<MultiLabel>, ProtoSerializable<org.tribuo.protos.core.OutputFactoryProto>

public final class MultiLabelFactory
extends Object
implements OutputFactory<MultiLabel>

A factory for generating MultiLabel objects and their associated OutputInfo and Evaluator objects.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiLabelFactory.MultiLabelFactoryProvenance	Provenance for MultiLabelFactory.

Field Summary

Fields

Modifier and Type	Field	Description
static final MultiLabel	UNKNOWN_MULTILABEL	The sentinel unknown multi-label output used to signal there is no ground truth value.

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Constructor Summary

Constructors

Constructor	Description
MultiLabelFactory()	Construct a MultiLabelFactory.

Method Summary

Modifier and Type	Method	Description
ImmutableOutputInfo<MultiLabel>	constructInfoForExternalModel(Map<MultiLabel,Integer> mapping)	Creates an ImmutableOutputInfo from the supplied mapping.
static MultiLabelFactory	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
boolean	equals(Object obj)
MutableOutputInfo<MultiLabel>	generateInfo()	Generates the appropriate MutableOutputInfo so the output values can be tracked by a Dataset or other aggregate.
static String	generateLabelString(Set<Label> input)	Generates a comma separated string of labels from a Set of Label.
<V> MultiLabel	generateOutput(V label)	Parses the MultiLabel value either by toStringing the input and calling MultiLabel.parseString(java.lang.String) or if it's a Collection iterating over the elements calling toString on each element in turn and using MultiLabel.parseElement(java.lang.String).
Evaluator<MultiLabel,MultiLabelEvaluation>	getEvaluator()	Gets an Evaluator suitable for measuring performance of predictions for the Output subclass.
OutputFactoryProvenance	getProvenance()
Class<MultiLabel>	getTypeWitness()	Gets the output class that this factory supports.
MultiLabel	getUnknownOutput()	Returns the singleton unknown output of type T which can be used for prediction time examples.
int	hashCode()
org.tribuo.protos.core.OutputFactoryProto	serialize()	Serializes this object to a protobuf.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Configurable

postConfig

Methods inherited from interface org.tribuo.OutputFactory

generateOutputs

Field Details

UNKNOWN_MULTILABEL

public static final MultiLabel UNKNOWN_MULTILABEL

The sentinel unknown multi-label output used to signal there is no ground truth value.

Constructor Details

MultiLabelFactory

public MultiLabelFactory()

Construct a MultiLabelFactory.

Method Details

deserializeFromProto

public static MultiLabelFactory deserializeFromProto(int version,
 String className,
 com.google.protobuf.Any message)

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

serialize

public org.tribuo.protos.core.OutputFactoryProto serialize()

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

serialize in interface ProtoSerializable<org.tribuo.protos.core.OutputFactoryProto>

Returns:

The protobuf.

generateOutput

public <V> MultiLabel generateOutput(V label)

Parses the MultiLabel value either by toStringing the input and calling MultiLabel.parseString(java.lang.String) or if it's a Collection iterating over the elements calling toString on each element in turn and using MultiLabel.parseElement(java.lang.String).

Specified by:

generateOutput in interface OutputFactory<MultiLabel>

Type Parameters:

V - The type of the input value.

Parameters:

label - An input value.

Returns:

A MultiLabel

getUnknownOutput

public MultiLabel getUnknownOutput()

Description copied from interface: OutputFactory

Returns the singleton unknown output of type T which can be used for prediction time examples.

Specified by:

getUnknownOutput in interface OutputFactory<MultiLabel>

Returns:

An unknown output.

generateInfo

public MutableOutputInfo<MultiLabel> generateInfo()

Description copied from interface: OutputFactory

Generates the appropriate MutableOutputInfo so the output values can be tracked by a Dataset or other aggregate.

Specified by:

generateInfo in interface OutputFactory<MultiLabel>

Returns:

The appropriate subclass of MutableOutputInfo initialised to zero.

constructInfoForExternalModel

public ImmutableOutputInfo<MultiLabel> constructInfoForExternalModel(Map<MultiLabel,Integer> mapping)

Description copied from interface: OutputFactory

Creates an ImmutableOutputInfo from the supplied mapping. Requires that the mapping is dense in the integers [0,mapping.size()) and each mapping is unique.

This call is used to import external models, and should not be used for other purposes.

Specified by:

constructInfoForExternalModel in interface OutputFactory<MultiLabel>

Parameters:

mapping - The mapping to use.

Returns:

The appropriate subclass of ImmutableOutputInfo with a single observation of each element.

getEvaluator

public Evaluator<MultiLabel,MultiLabelEvaluation> getEvaluator()

Description copied from interface: OutputFactory

Gets an Evaluator suitable for measuring performance of predictions for the Output subclass.

Evaluator instances are thread safe and immutable, and commonly this is a singleton stored in the OutputFactory implementation.

Specified by:

getEvaluator in interface OutputFactory<MultiLabel>

Returns:

An evaluator.

getTypeWitness

public Class<MultiLabel> getTypeWitness()

Description copied from interface: OutputFactory

Gets the output class that this factory supports.

Specified by:

getTypeWitness in interface OutputFactory<MultiLabel>

Returns:

The output class.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getProvenance

public OutputFactoryProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<OutputFactoryProvenance>

generateLabelString

public static String generateLabelString(Set<Label> input)

Generates a comma separated string of labels from a Set of Label.

Parameters:

input - A Set of Label objects.

Returns:

A (possibly empty) comma separated string.