Package org.tribuo.regression.sgd.fm

Class FMRegressionModel

java.lang.Object
org.tribuo.Model<T>
org.tribuo.common.sgd.AbstractSGDModel<T>
org.tribuo.common.sgd.AbstractFMModel<Regressor>
org.tribuo.regression.sgd.fm.FMRegressionModel
All Implemented Interfaces:
com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>, Serializable, ONNXExportable
public class FMRegressionModel extends AbstractFMModel<Regressor> implements ONNXExportable
The inference time model of a regression factorization machine trained using SGD. Independently predicts each output dimension, unless they are tied together in the optimiser.

See: 

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

  • Method Details

    • predict

      public Prediction<Regressor> predict(Example<Regressor> 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<Regressor>
      Parameters:
      example - the example to predict.
      Returns:
      the result of the prediction.

    • copy

      protected FMRegressionModel 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<Regressor>
      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<Regressor>
      Parameters:
      index - The output dimension index.
      Returns:
      The name of the requested output dimension.

    • onnxModelName

      protected String onnxModelName()
      Specified by:
      onnxModelName in class AbstractFMModel<Regressor>
      Returns:
      Name to write into the ONNX Model.

    • onnxOutput

      protected ONNXNode onnxOutput(ONNXNode fmOutput)
      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<Regressor>
      Parameters:
      fmOutput - Unnormalized ONNX leaf node.
      Returns:
      Normalized ONNX leaf node.