Class Prediction

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class Prediction
    extends Object
    implements Serializable, Cloneable

    The output from a Predict operation:

    • Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD

    • PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.

    • PredictedScores - Contains the raw classification score corresponding to each label.

    • PredictedValue - Present for a REGRESSION MLModel request.

    See Also:
    Serialized Form
    • Constructor Detail

      • Prediction

        public Prediction()
    • Method Detail

      • setPredictedLabel

        public void setPredictedLabel​(String predictedLabel)
        The prediction label for either a BINARY or MULTICLASS MLModel.
        Parameters:
        predictedLabel - The prediction label for either a BINARY or MULTICLASS MLModel.
      • getPredictedLabel

        public String getPredictedLabel()
        The prediction label for either a BINARY or MULTICLASS MLModel.
        Returns:
        The prediction label for either a BINARY or MULTICLASS MLModel.
      • withPredictedLabel

        public Prediction withPredictedLabel​(String predictedLabel)
        The prediction label for either a BINARY or MULTICLASS MLModel.
        Parameters:
        predictedLabel - The prediction label for either a BINARY or MULTICLASS MLModel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPredictedValue

        public void setPredictedValue​(Float predictedValue)
        The prediction value for REGRESSION MLModel.
        Parameters:
        predictedValue - The prediction value for REGRESSION MLModel.
      • getPredictedValue

        public Float getPredictedValue()
        The prediction value for REGRESSION MLModel.
        Returns:
        The prediction value for REGRESSION MLModel.
      • withPredictedValue

        public Prediction withPredictedValue​(Float predictedValue)
        The prediction value for REGRESSION MLModel.
        Parameters:
        predictedValue - The prediction value for REGRESSION MLModel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getPredictedScores

        public Map<String,​Float> getPredictedScores()
        Returns:
      • setPredictedScores

        public void setPredictedScores​(Map<String,​Float> predictedScores)
        Parameters:
        predictedScores -
      • withPredictedScores

        public Prediction withPredictedScores​(Map<String,​Float> predictedScores)
        Parameters:
        predictedScores -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearPredictedScoresEntries

        public Prediction clearPredictedScoresEntries()
        Removes all the entries added into PredictedScores. <p> Returns a reference to this object so that method calls can be chained together.
      • setDetails

        public void setDetails​(Map<String,​String> details)
        Parameters:
        details -
      • withDetails

        public Prediction withDetails​(Map<String,​String> details)
        Parameters:
        details -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearDetailsEntries

        public Prediction clearDetailsEntries()
        Removes all the entries added into Details. <p> Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object