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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-machinelearning Show documentation
The AWS Java SDK for Amazon Machine Learning module holds the client classes that is used for communicating with Amazon Machine Learning Service
There is a newer version: 1.11.69
Show newest version
/*
 * Copyright 2010-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;

/**
 * 
 * Measurements of how well the MLModel performed on known
 * observations. One of the following metrics is returned, based on the type of
 * the MLModel:
 * 
 * 
 * 
 * 
 * BinaryAUC: The binary MLModel uses the Area Under the Curve
 * (AUC) technique to measure performance.
 * 
 * 
 * 
 * 
 * RegressionRMSE: The regression MLModel uses the Root Mean Square
 * Error (RMSE) technique to measure performance. RMSE measures the difference
 * between predicted and actual values for a single variable.
 * 
 * 
 * 
 * 
 * MulticlassAvgFScore: The multiclass MLModel uses the F1 score
 * technique to measure performance.
 * 
 * 
 * 
 * 
 * For more information about performance metrics, please see the Amazon Machine
 * Learning Developer Guide.
 * 
 */
public class PerformanceMetrics implements Serializable, Cloneable {

    private com.amazonaws.internal.SdkInternalMap properties;

    /**
     * @return
     */

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

    /**
     * @param properties
     */

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

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

    public PerformanceMetrics withProperties(
            java.util.Map properties) {
        setProperties(properties);
        return this;
    }

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

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

    public PerformanceMetrics clearPropertiesEntries() {
        this.properties = 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 (getProperties() != null)
            sb.append("Properties: " + getProperties());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof PerformanceMetrics == false)
            return false;
        PerformanceMetrics other = (PerformanceMetrics) obj;
        if (other.getProperties() == null ^ this.getProperties() == null)
            return false;
        if (other.getProperties() != null
                && other.getProperties().equals(this.getProperties()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode
                + ((getProperties() == null) ? 0 : getProperties().hashCode());
        return hashCode;
    }

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