org.nd4j.evaluation

Class BaseEvaluation<T extends BaseEvaluation>

java.lang.Object

org.nd4j.evaluation.BaseEvaluation<T>

All Implemented Interfaces:

Serializable, IEvaluation<T>

Direct Known Subclasses:

CustomEvaluation, Evaluation, EvaluationBinary, EvaluationCalibration, RegressionEvaluation, ROC, ROCBinary, ROCMultiClass

public abstract class BaseEvaluation<T extends BaseEvaluation>
extends Object
implements IEvaluation<T>

BaseEvaluation implement common evaluation functionality (for time series, etc) for Evaluation, RegressionEvaluation, ROC, ROCMultiClass etc.

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseEvaluation()

Method Summary

Modifier and Type	Method and Description
protected static <T extends IEvaluation> T	attempFromLegacyFromJson(String json, org.nd4j.shade.jackson.databind.exc.InvalidTypeIdException originalException) Attempt to load DL4J IEvaluation JSON from 1.0.0-beta2 or earlier.
void	eval(INDArray labels, INDArray networkPredictions)
void	eval(INDArray labels, INDArray networkPredictions, INDArray maskArray)
void	eval(@NonNull INDArray labels, @NonNull INDArray predictions, List<? extends Serializable> recordMetaData)
void	evalTimeSeries(INDArray labels, INDArray predicted)
void	evalTimeSeries(INDArray labels, INDArray predictions, INDArray labelsMask)
static <T extends IEvaluation> T	fromJson(String json, Class<T> clazz)
static <T extends IEvaluation> T	fromYaml(String yaml, Class<T> clazz)
static Triple<INDArray,INDArray,INDArray>	reshapeAndExtractNotMasked(INDArray labels, INDArray predictions, INDArray mask, int axis)
String	toJson()
String	toString()
String	toYaml()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nd4j.evaluation.IEvaluation

eval, getValue, merge, newInstance, reset, stats

Constructor Detail

BaseEvaluation

public BaseEvaluation()

Method Detail

fromYaml

public static <T extends IEvaluation> T fromYaml(String yaml,
                                                 Class<T> clazz)

Type Parameters:

T - Type to return

Parameters:

yaml - YAML representation

clazz - Class

Returns:

Evaluation instance

fromJson

public static <T extends IEvaluation> T fromJson(String json,
                                                 Class<T> clazz)

Type Parameters:

T - Type to return

Parameters:

json - Jason representation of the evaluation instance

clazz - Class

Returns:

Evaluation instance

attempFromLegacyFromJson

protected static <T extends IEvaluation> T attempFromLegacyFromJson(String json,
                                                                    org.nd4j.shade.jackson.databind.exc.InvalidTypeIdException originalException)
                                                             throws org.nd4j.shade.jackson.databind.exc.InvalidTypeIdException

Attempt to load DL4J IEvaluation JSON from 1.0.0-beta2 or earlier. Given IEvaluation classes were moved to ND4J with no major changes, a simple "find and replace" for the class names is used.

Parameters:

json - JSON to attempt to deserialize

originalException - Original exception to be re-thrown if it isn't legacy JSON

Throws:

org.nd4j.shade.jackson.databind.exc.InvalidTypeIdException

reshapeAndExtractNotMasked

public static Triple<INDArray,INDArray,INDArray> reshapeAndExtractNotMasked(INDArray labels,
                                                                            INDArray predictions,
                                                                            INDArray mask,
                                                                            int axis)

eval

public void eval(INDArray labels,
                 INDArray networkPredictions)

Specified by:

eval in interface IEvaluation<T extends BaseEvaluation>

eval

public void eval(@NonNull
                 @NonNull INDArray labels,
                 @NonNull
                 @NonNull INDArray predictions,
                 List<? extends Serializable> recordMetaData)

Specified by:

eval in interface IEvaluation<T extends BaseEvaluation>

eval

public void eval(INDArray labels,
                 INDArray networkPredictions,
                 INDArray maskArray)

Specified by:

eval in interface IEvaluation<T extends BaseEvaluation>

evalTimeSeries

public void evalTimeSeries(INDArray labels,
                           INDArray predicted)

Specified by:

evalTimeSeries in interface IEvaluation<T extends BaseEvaluation>

evalTimeSeries

public void evalTimeSeries(INDArray labels,
                           INDArray predictions,
                           INDArray labelsMask)

Specified by:

evalTimeSeries in interface IEvaluation<T extends BaseEvaluation>

toJson

public String toJson()

Specified by:

toJson in interface IEvaluation<T extends BaseEvaluation>

Returns:

JSON representation of the evaluation instance

toString

public String toString()

Overrides:

toString in class Object

toYaml

public String toYaml()

Specified by:

toYaml in interface IEvaluation<T extends BaseEvaluation>

Returns:

YAML representation of the evaluation instance