Package org.nd4j.autodiff.listeners.records

Class EvaluationRecord

java.lang.Object

org.nd4j.autodiff.listeners.records.EvaluationRecord

public class EvaluationRecord
extends Object

Constructor Summary

Constructors

Constructor	Description
EvaluationRecord(Map<String,List<IEvaluation>> evaluations)

Method Summary

Modifier and Type	Method	Description
<T extends IEvaluation<T>> T	evaluation(Class<T> evalClass)	Get the evaluation of a given type
<T extends IEvaluation> T	evaluation(String param)	Get the evaluation for a given param/variable
IEvaluation	evaluation(String param, int index)	Get the evaluation for param at the specified index
<T extends IEvaluation<T>> T	evaluation(String param, Class<T> evalClass)	Get the evaluation of a given type, for a given param/variable
<T extends IEvaluation> T	evaluation(SDVariable param)	Get the evaluation for a given param/variable
IEvaluation	evaluation(SDVariable param, int index)	Get the evaluation for param at the specified index
<T extends IEvaluation<T>> T	evaluation(SDVariable param, Class<T> evalClass)	Get the evaluation of a given type, for a given param/variable
Map<String,List<IEvaluation>>	evaluations()	Get all evaluations
List<IEvaluation>	evaluations(String param)	Get evaluations for a given param/variable
List<IEvaluation>	evaluations(SDVariable param)	Get evaluations for a given param/variable
double	getValue(String param, int index, IMetric metric)	Get the metric's value for the evaluation for a given param/variable at the given index
double	getValue(String param, IMetric metric)	Get the metric's value for the evaluation of the metric's type, for a given param/variable
double	getValue(SDVariable param, int index, IMetric metric)	Get the metric's value for the evaluation for a given param/variable at the given index
double	getValue(SDVariable param, IMetric metric)	Get the metric's value for the evaluation of the metric's type, for a given param/variable
double	getValue(IMetric metric)	Get the metric's value for the evaluation of the metric's type
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationRecord

public EvaluationRecord(Map<String,List<IEvaluation>> evaluations)

Method Detail

isEmpty

public boolean isEmpty()

evaluations

public Map<String,List<IEvaluation>> evaluations()

Get all evaluations

evaluations

public List<IEvaluation> evaluations(String param)

Get evaluations for a given param/variable

Parameters:

param - The target param/variable

evaluations

public List<IEvaluation> evaluations(SDVariable param)

Get evaluations for a given param/variable

Parameters:

param - The target param/variable

evaluation

public IEvaluation evaluation(String param,
                              int index)

Get the evaluation for param at the specified index

evaluation

public IEvaluation evaluation(SDVariable param,
                              int index)

Get the evaluation for param at the specified index

evaluation

public <T extends IEvaluation> T evaluation(String param)

Get the evaluation for a given param/variable

Will throw an exception if there are more than one or no evaluations for the param

Parameters:

param - The target param/variable

evaluation

public <T extends IEvaluation> T evaluation(SDVariable param)

Get the evaluation for a given param/variable

Will throw an exception if there are more than one or no evaluations for the param

Parameters:

param - The target param/variable

evaluation

public <T extends IEvaluation<T>> T evaluation(Class<T> evalClass)

Get the evaluation of a given type

Will throw an exception if there are more than one or no evaluations of that type

Parameters:

evalClass - The type of evaluation to look for

evaluation

public <T extends IEvaluation<T>> T evaluation(String param,
                                               Class<T> evalClass)

Get the evaluation of a given type, for a given param/variable

Will throw an exception if there are more than one or no evaluations of that type for the given param

Parameters:

param - The target param/variable

evalClass - The type of evaluation to look for

evaluation

public <T extends IEvaluation<T>> T evaluation(SDVariable param,
                                               Class<T> evalClass)

Get the evaluation of a given type, for a given param/variable

Will throw an exception if there are more than one or no evaluations of that type for the given param

Parameters:

param - The target param/variable

evalClass - The type of evaluation to look for

getValue

public double getValue(IMetric metric)

Get the metric's value for the evaluation of the metric's type

Will throw an exception if there are more than one or no evaluations of that type

Parameters:

metric - The metric to calculate

getValue

public double getValue(String param,
                       IMetric metric)

Get the metric's value for the evaluation of the metric's type, for a given param/variable

Will throw an exception if there are more than one or no evaluations of that type for the given param

Parameters:

param - The target param/variable

metric - The metric to calculate

getValue

public double getValue(SDVariable param,
                       IMetric metric)

Get the metric's value for the evaluation of the metric's type, for a given param/variable

Will throw an exception if there are more than one or no evaluations of that type for the given param

Parameters:

param - The target param/variable

metric - The metric to calculate

getValue

public double getValue(String param,
                       int index,
                       IMetric metric)

Get the metric's value for the evaluation for a given param/variable at the given index

Will throw an exception if the target evaluation doesn't support the given metric

Parameters:

param - The target param/variable

index - The index of the target evaluation on the param

metric - The metric to calculate

getValue

public double getValue(SDVariable param,
                       int index,
                       IMetric metric)

Get the metric's value for the evaluation for a given param/variable at the given index

Will throw an exception if the target evaluation doesn't support the given metric

Parameters:

param - The target param/variable

index - The index of the target evaluation on the param

metric - The metric to calculate