• Home
• com.amazonaws
• aws-java-sdk-osgi
• 1.11.21
• source code
• Prediction.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.machinelearning.model.Prediction Maven / Gradle / Ivy

/*
 * Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not
 * use this file except in compliance with the License. A copy of the License is
 * located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.machinelearning.model;

import java.io.Serializable;

/**
 * 

 * 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.
 * 
 * 
 * 
 */
public class Prediction implements Serializable, Cloneable {

    /**
     * 

     * The prediction label for either a BINARY or
     * MULTICLASS MLModel.
     * 
     */
    private String predictedLabel;
    /** The prediction value for REGRESSION MLModel. */
    private Float predictedValue;

    private com.amazonaws.internal.SdkInternalMap predictedScores;

    private com.amazonaws.internal.SdkInternalMap details;

    /**
     * 

     * The prediction label for either a BINARY or
     * MULTICLASS MLModel.
     * 
     * 
     * @param predictedLabel
     *        The prediction label for either a BINARY or
     *        MULTICLASS MLModel.
     */

    public void setPredictedLabel(String predictedLabel) {
        this.predictedLabel = predictedLabel;
    }

    /**
     * 

     * The prediction label for either a BINARY or
     * MULTICLASS MLModel.
     * 
     * 
     * @return The prediction label for either a BINARY or
     *         MULTICLASS MLModel.
     */

    public String getPredictedLabel() {
        return this.predictedLabel;
    }

    /**
     * 

     * The prediction label for either a BINARY or
     * MULTICLASS MLModel.
     * 
     * 
     * @param predictedLabel
     *        The prediction label for either a BINARY or
     *        MULTICLASS MLModel.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Prediction withPredictedLabel(String predictedLabel) {
        setPredictedLabel(predictedLabel);
        return this;
    }

    /**
     * The prediction value for REGRESSION MLModel.
     * 
     * @param predictedValue
     *        The prediction value for REGRESSION
     *        MLModel.
     */

    public void setPredictedValue(Float predictedValue) {
        this.predictedValue = predictedValue;
    }

    /**
     * The prediction value for REGRESSION MLModel.
     * 
     * @return The prediction value for REGRESSION
     *         MLModel.
     */

    public Float getPredictedValue() {
        return this.predictedValue;
    }

    /**
     * The prediction value for REGRESSION MLModel.
     * 
     * @param predictedValue
     *        The prediction value for REGRESSION
     *        MLModel.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Prediction withPredictedValue(Float predictedValue) {
        setPredictedValue(predictedValue);
        return this;
    }

    /**
     * @return
     */

    public java.util.Map getPredictedScores() {
        if (predictedScores == null) {
            predictedScores = new com.amazonaws.internal.SdkInternalMap();
        }
        return predictedScores;
    }

    /**
     * @param predictedScores
     */

    public void setPredictedScores(java.util.Map predictedScores) {
        this.predictedScores = predictedScores == null ? null
                : new com.amazonaws.internal.SdkInternalMap(
                        predictedScores);
    }

    /**
     * @param predictedScores
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Prediction withPredictedScores(
            java.util.Map predictedScores) {
        setPredictedScores(predictedScores);
        return this;
    }

    public Prediction addPredictedScoresEntry(String key, Float value) {
        if (null == this.predictedScores) {
            this.predictedScores = new com.amazonaws.internal.SdkInternalMap();
        }
        if (this.predictedScores.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys ("
                    + key.toString() + ") are provided.");
        this.predictedScores.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into PredictedScores. <p> Returns a
     * reference to this object so that method calls can be chained together.
     */

    public Prediction clearPredictedScoresEntries() {
        this.predictedScores = null;
        return this;
    }

    /**
     * @return
     */

    public java.util.Map getDetails() {
        if (details == null) {
            details = new com.amazonaws.internal.SdkInternalMap();
        }
        return details;
    }

    /**
     * @param details
     */

    public void setDetails(java.util.Map details) {
        this.details = details == null ? null
                : new com.amazonaws.internal.SdkInternalMap(
                        details);
    }

    /**
     * @param details
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public Prediction withDetails(java.util.Map details) {
        setDetails(details);
        return this;
    }

    public Prediction addDetailsEntry(String key, String value) {
        if (null == this.details) {
            this.details = new com.amazonaws.internal.SdkInternalMap();
        }
        if (this.details.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys ("
                    + key.toString() + ") are provided.");
        this.details.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Details. <p> Returns a reference to
     * this object so that method calls can be chained together.
     */

    public Prediction clearDetailsEntries() {
        this.details = null;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getPredictedLabel() != null)
            sb.append("PredictedLabel: " + getPredictedLabel() + ",");
        if (getPredictedValue() != null)
            sb.append("PredictedValue: " + getPredictedValue() + ",");
        if (getPredictedScores() != null)
            sb.append("PredictedScores: " + getPredictedScores() + ",");
        if (getDetails() != null)
            sb.append("Details: " + getDetails());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof Prediction == false)
            return false;
        Prediction other = (Prediction) obj;
        if (other.getPredictedLabel() == null
                ^ this.getPredictedLabel() == null)
            return false;
        if (other.getPredictedLabel() != null
                && other.getPredictedLabel().equals(this.getPredictedLabel()) == false)
            return false;
        if (other.getPredictedValue() == null
                ^ this.getPredictedValue() == null)
            return false;
        if (other.getPredictedValue() != null
                && other.getPredictedValue().equals(this.getPredictedValue()) == false)
            return false;
        if (other.getPredictedScores() == null
                ^ this.getPredictedScores() == null)
            return false;
        if (other.getPredictedScores() != null
                && other.getPredictedScores().equals(this.getPredictedScores()) == false)
            return false;
        if (other.getDetails() == null ^ this.getDetails() == null)
            return false;
        if (other.getDetails() != null
                && other.getDetails().equals(this.getDetails()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime
                * hashCode
                + ((getPredictedLabel() == null) ? 0 : getPredictedLabel()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getPredictedValue() == null) ? 0 : getPredictedValue()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getPredictedScores() == null) ? 0 : getPredictedScores()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getDetails() == null) ? 0 : getDetails().hashCode());
        return hashCode;
    }

    @Override
    public Prediction clone() {
        try {
            return (Prediction) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}