org.tribuo.classification

Class LabelFactory

java.lang.Object

org.tribuo.classification.LabelFactory

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<OutputFactoryProvenance>, Serializable, OutputFactory<Label>

public final class LabelFactory
extends Object
implements OutputFactory<Label>

A factory for making Label related classes.

Parses the Label by calling toString on the input.

Label factories have no state, and are all equal to each other.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelFactory.LabelFactoryProvenance Provenance for LabelFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static Label	UNKNOWN_LABEL The singleton unknown label, used for unlablled examples.

Constructor Summary

Constructors

Constructor and Description
LabelFactory() Constructs a label factory.

Method Summary

Modifier and Type	Method and Description
ImmutableOutputInfo<Label>	constructInfoForExternalModel(Map<Label,Integer> mapping) Creates an ImmutableOutputInfo from the supplied mapping.
boolean	equals(Object obj)
MutableOutputInfo<Label>	generateInfo() Generates an empty MutableLabelInfo.
<V> Label	generateOutput(V label) Generates the Label string by calling toString on the input.
Evaluator<Label,LabelEvaluation>	getEvaluator() Gets an Evaluator suitable for measuring performance of predictions for the Output subclass.
OutputFactoryProvenance	getProvenance()
Label	getUnknownOutput() Returns the singleton unknown output of type T which can be used for prediction time examples.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tribuo.OutputFactory

generateOutputs, validateMapping

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

postConfig

Field Detail

UNKNOWN_LABEL

public static final Label UNKNOWN_LABEL

The singleton unknown label, used for unlablled examples.

Constructor Detail

LabelFactory

public LabelFactory()

Constructs a label factory.

Method Detail

generateOutput

public <V> Label generateOutput(V label)

Generates the Label string by calling toString on the input.

Specified by:

generateOutput in interface OutputFactory<Label>

Type Parameters:

V - The type of the input.

Parameters:

label - An input value.

Returns:

A Label object.

getUnknownOutput

public Label 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<Label>

Returns:

An unknown output.

generateInfo

public MutableOutputInfo<Label> generateInfo()

Generates an empty MutableLabelInfo.

Specified by:

generateInfo in interface OutputFactory<Label>

Returns:

An empty MutableLabelInfo.

constructInfoForExternalModel

public ImmutableOutputInfo<Label> constructInfoForExternalModel(Map<Label,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<Label>

Parameters:

mapping - The mapping to use.

Returns:

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

getEvaluator

public Evaluator<Label,LabelEvaluation> 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<Label>

Returns:

An evaluator.

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>