Class LinearSGDModel

java.lang.Object
org.tribuo.Model<Label>
org.tribuo.common.sgd.AbstractSGDModel<Label>
org.tribuo.common.sgd.AbstractLinearSGDModel<Label>
org.tribuo.classification.sgd.linear.LinearSGDModel
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 LinearSGDModel extends AbstractLinearSGDModel<Label> implements org.tribuo.ONNXExportable
The inference time version of a linear model trained using SGD.

See: 

 Bottou L.
 "Large-Scale Machine Learning with Stochastic Gradient Descent"
 Proceedings of COMPSTAT, 2010.
See Also:

  • 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 LinearSGDModel
    copy(String newName, org.tribuo.provenance.ModelProvenance newProvenance)
     
    static LinearSGDModel
    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.AbstractLinearSGDModel

    exportONNXModel, getExcuse, getTopFeatures, getWeightsCopy, 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

  • Method Details

    • deserializeFromProto

      public static LinearSGDModel 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 LinearSGDModel 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 AbstractLinearSGDModel<Label>

    • onnxOutput

      protected org.tribuo.util.onnx.ONNXNode onnxOutput(org.tribuo.util.onnx.ONNXNode input)
      Specified by:
      onnxOutput in class AbstractLinearSGDModel<Label>

    • onnxModelName

      protected String onnxModelName()
      Specified by:
      onnxModelName in class AbstractLinearSGDModel<Label>