Class FMClassificationModel

java.lang.Object

org.tribuo.Model<Label>

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

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

org.tribuo.classification.sgd.fm.FMClassificationModel

All Implemented Interfaces:

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

public class FMClassificationModel
extends AbstractFMModel<Label>
implements org.tribuo.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, org.tribuo.provenance.ModelProvenance newProvenance)
static FMClassificationModel	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
protected String	getDimensionName(int index)
protected String	onnxModelName()
protected org.tribuo.util.onnx.ONNXNode	onnxOutput(org.tribuo.util.onnx.ONNXNode input)
org.tribuo.Prediction<Label>	predict(org.tribuo.Example<Label> example)
org.tribuo.protos.core.ModelProto	serialize()

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 org.tribuo.Prediction<Label> predict(org.tribuo.Example<Label> example)

Specified by:

predict in class org.tribuo.Model<Label>

serialize

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

Specified by:

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

Overrides:

serialize in class org.tribuo.Model<Label>

copy

protected FMClassificationModel copy(String newName,
 org.tribuo.provenance.ModelProvenance newProvenance)

Specified by:

copy in class org.tribuo.Model<Label>

getDimensionName

protected String getDimensionName(int index)

Specified by:

getDimensionName in class AbstractFMModel<Label>

onnxModelName

protected String onnxModelName()

Specified by:

onnxModelName in class AbstractFMModel<Label>

onnxOutput

protected org.tribuo.util.onnx.ONNXNode onnxOutput(org.tribuo.util.onnx.ONNXNode input)

Specified by:

onnxOutput in class AbstractFMModel<Label>