org.tribuo.interop.tensorflow

Class LabelTransformer

java.lang.Object

org.tribuo.interop.tensorflow.LabelTransformer

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>, Serializable, OutputTransformer<Label>

public class LabelTransformer
extends Object
implements OutputTransformer<Label>

Can convert a Label into a Tensor containing a 32-bit integer and can convert a vector of 32-bit floats into a Prediction or a Label.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LabelTransformer()

Method Summary

Modifier and Type	Method and Description
boolean	generatesProbabilities() Does this OutputTransformer generate probabilities.
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
String	toString()
org.tensorflow.Tensor<?>	transform(Label example, ImmutableOutputInfo<Label> outputIDInfo) Converts an Output into a Tensor representing it's output.
org.tensorflow.Tensor<?>	transform(List<Example<Label>> examples, ImmutableOutputInfo<Label> outputIDInfo) Converts a list of Example into a Tensor representing all the outputs in the list.
List<Label>	transformToBatchOutput(org.tensorflow.Tensor<?> tensor, ImmutableOutputInfo<Label> outputIDInfo) Converts a Tensor containing multiple outputs into a list of Outputs.
List<Prediction<Label>>	transformToBatchPrediction(org.tensorflow.Tensor<?> tensor, ImmutableOutputInfo<Label> outputIDInfo, int[] numValidFeatures, List<Example<Label>> examples) Converts a Tensor containing multiple outputs into a list of Predictions.
Label	transformToOutput(org.tensorflow.Tensor<?> tensor, ImmutableOutputInfo<Label> outputIDInfo) Converts a Tensor into the specified output type.
Prediction<Label>	transformToPrediction(org.tensorflow.Tensor<?> tensor, ImmutableOutputInfo<Label> outputIDInfo, int numValidFeatures, Example<Label> example) Converts a Tensor into a Prediction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

postConfig

Constructor Detail

LabelTransformer

public LabelTransformer()

Method Detail

transformToPrediction

public Prediction<Label> transformToPrediction(org.tensorflow.Tensor<?> tensor,
                                               ImmutableOutputInfo<Label> outputIDInfo,
                                               int numValidFeatures,
                                               Example<Label> example)

Description copied from interface: OutputTransformer

Converts a Tensor into a Prediction.

Specified by:

transformToPrediction in interface OutputTransformer<Label>

Parameters:

tensor - The tensor to convert.

outputIDInfo - The output info to use to identify the outputs.

numValidFeatures - The number of valid features used by the prediction.

example - The example to insert into the prediction.

Returns:

A prediction object.

transformToOutput

public Label transformToOutput(org.tensorflow.Tensor<?> tensor,
                               ImmutableOutputInfo<Label> outputIDInfo)

Description copied from interface: OutputTransformer

Converts a Tensor into the specified output type.

Specified by:

transformToOutput in interface OutputTransformer<Label>

Parameters:

tensor - The tensor to convert.

outputIDInfo - The output info to use to identify the outputs.

Returns:

A output.

transformToBatchPrediction

public List<Prediction<Label>> transformToBatchPrediction(org.tensorflow.Tensor<?> tensor,
                                                          ImmutableOutputInfo<Label> outputIDInfo,
                                                          int[] numValidFeatures,
                                                          List<Example<Label>> examples)

Description copied from interface: OutputTransformer

Converts a Tensor containing multiple outputs into a list of Predictions.

Specified by:

transformToBatchPrediction in interface OutputTransformer<Label>

Parameters:

tensor - The tensor to convert.

outputIDInfo - The output info to use to identify the outputs.

numValidFeatures - The number of valid features used by the prediction.

examples - The example to insert into the prediction.

Returns:

A list of predictions.

transformToBatchOutput

public List<Label> transformToBatchOutput(org.tensorflow.Tensor<?> tensor,
                                          ImmutableOutputInfo<Label> outputIDInfo)

Description copied from interface: OutputTransformer

Converts a Tensor containing multiple outputs into a list of Outputs.

Specified by:

transformToBatchOutput in interface OutputTransformer<Label>

Parameters:

tensor - The tensor to convert.

outputIDInfo - The output info to use to identify the outputs.

Returns:

A list of outputs.

transform

public org.tensorflow.Tensor<?> transform(Label example,
                                          ImmutableOutputInfo<Label> outputIDInfo)

Description copied from interface: OutputTransformer

Converts an Output into a Tensor representing it's output.

Specified by:

transform in interface OutputTransformer<Label>

Parameters:

example - The output to convert.

outputIDInfo - The output info to use to identify the outputs.

Returns:

A Tensor representing this output.

transform

public org.tensorflow.Tensor<?> transform(List<Example<Label>> examples,
                                          ImmutableOutputInfo<Label> outputIDInfo)

Description copied from interface: OutputTransformer

Converts a list of Example into a Tensor representing all the outputs in the list. It accepts a list of Example rather than a list of Output for efficiency reasons.

Specified by:

transform in interface OutputTransformer<Label>

Parameters:

examples - The examples to convert.

outputIDInfo - The output info to use to identify the outputs.

Returns:

A Tensor representing all the supplied Outputs.

generatesProbabilities

public boolean generatesProbabilities()

Description copied from interface: OutputTransformer

Does this OutputTransformer generate probabilities.

Specified by:

generatesProbabilities in interface OutputTransformer<Label>

Returns:

True if it produces a probability distribution in the Prediction.

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance getProvenance()

Specified by:

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