Package org.tribuo.classification.sgd.fm

Class FMClassificationModel

java.lang.Object

org.tribuo.Model<T>

org.tribuo.common.sgd.AbstractSGDModel<T>

org.tribuo.common.sgd.AbstractFMModel<Label>

org.tribuo.classification.sgd.fm.FMClassificationModel

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>, Serializable, ONNXExportable, ProtoSerializable<org.tribuo.protos.core.ModelProto>

public class FMClassificationModel
extends AbstractFMModel<Label>
implements ONNXExportable

The inference time version of a factorization machine trained using SGD.

See:

 Rendle, S.
 Factorization machines.
 2010 IEEE International Conference on Data Mining
 

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.tribuo.common.sgd.AbstractSGDModel

AbstractSGDModel.PredAndActive

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CURRENT_VERSION	Protobuf serialization version.

Fields inherited from class org.tribuo.common.sgd.AbstractSGDModel

addBias, modelParameters

Fields inherited from class org.tribuo.Model

ALL_OUTPUTS, BIAS_FEATURE, featureIDMap, generatesProbabilities, name, outputIDInfo, provenance, provenanceOutput

Fields inherited from interface org.tribuo.ONNXExportable

PROVENANCE_METADATA_FIELD, SERIALIZER

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Method Summary

Modifier and Type	Method	Description
protected FMClassificationModel	copy(String newName, ModelProvenance newProvenance)	Copies a model, replacing its provenance and name with the supplied values.
static FMClassificationModel	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
protected String	getDimensionName(int index)	Gets the name of the indexed output dimension.
protected String	onnxModelName()
protected ONNXNode	onnxOutput(ONNXNode input)	Takes the unnormalized ONNX output of this model and applies an appropriate normalizer from the concrete class.
Prediction<Label>	predict(Example<Label> example)	Uses the model to predict the output for a single example.
org.tribuo.protos.core.ModelProto	serialize()	Serializes this object to a protobuf.

Methods inherited from class org.tribuo.common.sgd.AbstractFMModel

exportONNXModel, getBiasesCopy, getExcuse, getFactorsCopy, getLinearWeightsCopy, getTopFeatures, writeONNXGraph

Methods inherited from class org.tribuo.common.sgd.AbstractSGDModel

getModelParameters, predictSingle

Methods inherited from class org.tribuo.Model

castModel, copy, createDataCarrier, deserialize, deserializeFromFile, deserializeFromStream, generatesProbabilities, getExcuses, getFeatureIDMap, getName, getOutputIDInfo, getProvenance, innerPredict, predict, predict, serializeToFile, serializeToStream, setName, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tribuo.ONNXExportable

exportONNXModel, saveONNXModel, serializeProvenance, writeONNXGraph

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Protobuf serialization version.

See Also:

• Constant Field Values

Method Details

deserializeFromProto

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

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

Throws:

com.google.protobuf.InvalidProtocolBufferException - If the protobuf could not be parsed from the message.

predict

public Prediction<Label> predict(Example<Label> example)

Description copied from class: Model

Uses the model to predict the output for a single example.

predict does not mutate the example.

Throws IllegalArgumentException if the example has no features or no feature overlap with the model.

Specified by:

predict in class Model<Label>

Parameters:

example - the example to predict.

Returns:

the result of the prediction.

serialize

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

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

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

Overrides:

serialize in class Model<Label>

Returns:

The protobuf.

copy

protected FMClassificationModel copy(String newName,
 ModelProvenance newProvenance)

Description copied from class: Model

Copies a model, replacing its provenance and name with the supplied values.

Used to provide the provenance removal functionality.

Specified by:

copy in class Model<Label>

Parameters:

newName - The new name.

newProvenance - The new provenance.

Returns:

A copy of the model.

getDimensionName

protected String getDimensionName(int index)

Description copied from class: AbstractFMModel

Gets the name of the indexed output dimension.

Specified by:

getDimensionName in class AbstractFMModel<Label>

Parameters:

index - The output dimension index.

Returns:

The name of the requested output dimension.

onnxModelName

protected String onnxModelName()

Specified by:

onnxModelName in class AbstractFMModel<Label>

Returns:

Name to write into the ONNX Model.

onnxOutput

protected ONNXNode onnxOutput(ONNXNode input)

Description copied from class: AbstractFMModel

Takes the unnormalized ONNX output of this model and applies an appropriate normalizer from the concrete class.

Specified by:

onnxOutput in class AbstractFMModel<Label>

Parameters:

input - Unnormalized ONNX leaf node.

Returns:

Normalized ONNX leaf node.