org.deeplearning4j.eval.meta.Prediction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deeplearning4j-nn Show documentation

There is a newer version: 1.0.0-M2.1

package org.deeplearning4j.eval.meta;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * Prediction: a prediction for classification, used with the {@link org.deeplearning4j.eval.Evaluation} class.
 * Holds predicted and actual classes, along with an object for the example/record that produced this evaluation.
 *
 * @author Alex Black
 */
@AllArgsConstructor
@Data
public class Prediction {

    private int actualClass;
    private int predictedClass;
    private Object recordMetaData;

    @Override
    public String toString() {
        return "Prediction(actualClass=" + actualClass + ",predictedClass=" + predictedClass + ",RecordMetaData="
                        + recordMetaData + ")";
    }

    /**
     * Convenience method for getting the record meta data as a particular class (as an alternative to casting it manually).
     * NOTE: This uses an unchecked cast inernally.
     *
     * @param recordMetaDataClass Class of the record metadata
     * @param                  Type to return
     */
    public  T getRecordMetaData(Class recordMetaDataClass) {
        return (T) recordMetaData;
    }
}