org.nd4j.autodiff.samediff.config

Class EvaluationConfig

java.lang.Object

org.nd4j.autodiff.samediff.config.EvaluationConfig

public class EvaluationConfig
extends Object

Configuration for a SameDiff evaluation operation. Used in SameDiff.evaluate().

Constructor Summary

Constructors

Constructor and Description
EvaluationConfig(@NonNull SameDiff sd)

Method Summary

Modifier and Type	Method and Description
EvaluationConfig	data(@NonNull DataSetIterator data) Set the data to evaluate on.
EvaluationConfig	data(@NonNull MultiDataSetIterator data) Set the data to evaluate on.
EvaluationConfig	evaluate(@NonNull SDVariable variable, IEvaluation... evaluations) See evaluate(String, IEvaluation[])
EvaluationConfig	evaluate(@NonNull SDVariable variable, int labelIndex, IEvaluation... evaluations) See evaluate(String, int, IEvaluation[])
EvaluationConfig	evaluate(@NonNull String param, IEvaluation... evaluations) Add evaluations to be preformed on a specified variable, without setting a label index.
EvaluationConfig	evaluate(@NonNull String param, int labelIndex, IEvaluation... evaluations) Add evaluations to be preformed on a specified variable, and set that variable's label index.
EvaluationRecord	exec() Run the evaluation.
EvaluationConfig	labelIndex(@NonNull SDVariable variable, int labelIndex) See labelIndex(String, int)
EvaluationConfig	labelIndex(@NonNull String param, int labelIndex) Set the label index for a parameter
EvaluationConfig	listeners(Listener... listeners) Add listeners for this operation

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationConfig

public EvaluationConfig(@NonNull
                        @NonNull SameDiff sd)

Method Detail

evaluate

public EvaluationConfig evaluate(@NonNull
                                 @NonNull String param,
                                 int labelIndex,
                                 @NonNull
                                 IEvaluation... evaluations)

Add evaluations to be preformed on a specified variable, and set that variable's label index. Setting a label index is required if using a MultiDataSetIterator.

Parameters:

param - The param to evaluate

labelIndex - The label index of that parameter

evaluations - The evaluations to preform

evaluate

public EvaluationConfig evaluate(@NonNull
                                 @NonNull SDVariable variable,
                                 int labelIndex,
                                 @NonNull
                                 IEvaluation... evaluations)

See evaluate(String, int, IEvaluation[])

evaluate

public EvaluationConfig evaluate(@NonNull
                                 @NonNull String param,
                                 @NonNull
                                 IEvaluation... evaluations)

Add evaluations to be preformed on a specified variable, without setting a label index. Setting a label index (which is not done here) is required if using a MultiDataSetIterator.

Parameters:

param - The param to evaluate

evaluations - The evaluations to preform

evaluate

public EvaluationConfig evaluate(@NonNull
                                 @NonNull SDVariable variable,
                                 @NonNull
                                 IEvaluation... evaluations)

See evaluate(String, IEvaluation[])

labelIndex

public EvaluationConfig labelIndex(@NonNull
                                   @NonNull String param,
                                   int labelIndex)

Set the label index for a parameter

labelIndex

public EvaluationConfig labelIndex(@NonNull
                                   @NonNull SDVariable variable,
                                   int labelIndex)

See labelIndex(String, int)

listeners

public EvaluationConfig listeners(@NonNull
                                  Listener... listeners)

Add listeners for this operation

data

public EvaluationConfig data(@NonNull
                             @NonNull MultiDataSetIterator data)

Set the data to evaluate on. Setting a label index for each variable to evaluate is required

data

public EvaluationConfig data(@NonNull
                             @NonNull DataSetIterator data)

Set the data to evaluate on. Setting a label index for each variable to evaluate is NOT required (since there is only one input)

exec

public EvaluationRecord exec()

Run the evaluation. Note that the evaluations in the returned EvaluationRecord are the evaluations set using evaluate(String, int, IEvaluation[]), it does not matter which you use to access results.

Returns:

The specified listeners, in an EvaluationRecord for easy access.