org.nd4j.autodiff.validation

Class TestCase

java.lang.Object

org.nd4j.autodiff.validation.TestCase

public class TestCase
extends Object

TestCase: Validate a SameDiff instance. Can be used to validate gradients (enabled by default) and expected outputs (forward pass for variables) if such outputs are provided.

Used with OpValidation

Author:

Alex Black

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestCase.TestSerialization

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	GC_DEFAULT_DEBUG_MODE
static double	GC_DEFAULT_EPS
static boolean	GC_DEFAULT_EXIT_FIRST_FAILURE
static double	GC_DEFAULT_MAX_REL_ERROR
static double	GC_DEFAULT_MIN_ABS_ERROR
static boolean	GC_DEFAULT_PRINT

Constructor Summary

Constructors

Constructor and Description
TestCase(SameDiff sameDiff)

Method Summary

Modifier and Type	Method and Description
void	assertConfigValid()
TestCase	expected(SDVariable var, Function<INDArray,String> validationFn)
TestCase	expected(@NonNull SDVariable var, @NonNull INDArray output) Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)
TestCase	expected(String name, Function<INDArray,String> validationFn)
TestCase	expected(@NonNull String name, @NonNull INDArray output) Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)
TestCase	expectedOutput(@NonNull String name, @NonNull INDArray expected) Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)
TestCase	expectedOutputRelError(@NonNull String name, @NonNull INDArray expected, double maxRelError, double minAbsError) Validate the output (forward pass) for a single variable using element-wise relative error: relError = abs(x-y)/(abs(x)+abs(y)), with x=y=0 case defined to be 0.0.
Map<String,INDArray>	gradCheckMask()
Set<String>	gradCheckSkipVariables()
TestCase	gradCheckSkipVariables(String... toSkip) Specify the input variables that should NOT be gradient checked.
TestCase	placeholderValue(String variable, INDArray value)
TestCase	placeholderValues(Map<String,INDArray> placeholderValues)
String	testNameErrMsg()

Methods inherited from class java.lang.Object

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

Field Detail

GC_DEFAULT_PRINT

public static final boolean GC_DEFAULT_PRINT

See Also:

Constant Field Values

GC_DEFAULT_EXIT_FIRST_FAILURE

public static final boolean GC_DEFAULT_EXIT_FIRST_FAILURE

See Also:

Constant Field Values

GC_DEFAULT_DEBUG_MODE

public static final boolean GC_DEFAULT_DEBUG_MODE

See Also:

Constant Field Values

GC_DEFAULT_EPS

public static final double GC_DEFAULT_EPS

See Also:

Constant Field Values

GC_DEFAULT_MAX_REL_ERROR

public static final double GC_DEFAULT_MAX_REL_ERROR

See Also:

Constant Field Values

GC_DEFAULT_MIN_ABS_ERROR

public static final double GC_DEFAULT_MIN_ABS_ERROR

See Also:

Constant Field Values

Constructor Detail

TestCase

public TestCase(SameDiff sameDiff)

Parameters:

sameDiff - SameDiff instance to test. Note: All of the required inputs should already be set

Method Detail

expectedOutput

public TestCase expectedOutput(@NonNull
                               @NonNull String name,
                               @NonNull
                               @NonNull INDArray expected)

Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)

Parameters:

name - Name of the variable to check

expected - Expected INDArray

expectedOutputRelError

public TestCase expectedOutputRelError(@NonNull
                                       @NonNull String name,
                                       @NonNull
                                       @NonNull INDArray expected,
                                       double maxRelError,
                                       double minAbsError)

Validate the output (forward pass) for a single variable using element-wise relative error: relError = abs(x-y)/(abs(x)+abs(y)), with x=y=0 case defined to be 0.0. Also has a minimum absolute error condition, which must be satisfied for the relative error failure to be considered legitimate

Parameters:

name - Name of the variable to check

expected - Expected INDArray

maxRelError - Maximum allowable relative error

minAbsError - Minimum absolute error for a failure to be considered legitimate

expected

public TestCase expected(@NonNull
                         @NonNull SDVariable var,
                         @NonNull
                         @NonNull INDArray output)

Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)

Parameters:

var - Variable to check

output - Expected INDArray

expected

public TestCase expected(@NonNull
                         @NonNull String name,
                         @NonNull
                         @NonNull INDArray output)

Validate the output (forward pass) for a single variable using INDArray.equals(INDArray)

Parameters:

name - Name of the variable to check

output - Expected INDArray

expected

public TestCase expected(SDVariable var,
                         Function<INDArray,String> validationFn)

expected

public TestCase expected(String name,
                         Function<INDArray,String> validationFn)

Parameters:

name - The name of the variable to check

validationFn - Function to use to validate the correctness of the specific Op. Should return null if validation passes, or an error message if the op validation fails

gradCheckSkipVariables

public Set<String> gradCheckSkipVariables()

gradCheckMask

public Map<String,INDArray> gradCheckMask()

gradCheckSkipVariables

public TestCase gradCheckSkipVariables(String... toSkip)

Specify the input variables that should NOT be gradient checked. For example, if an input is an integer index (not real valued) it should be skipped as such an input cannot be gradient checked

Parameters:

toSkip - Name of the input variables to skip gradient check for

placeholderValues

public TestCase placeholderValues(Map<String,INDArray> placeholderValues)

placeholderValue

public TestCase placeholderValue(String variable,
                                 INDArray value)

assertConfigValid

public void assertConfigValid()

testNameErrMsg

public String testNameErrMsg()