org.nd4j.autodiff.samediff

Enum VariableType

java.lang.Object

java.lang.Enum<VariableType>

org.nd4j.autodiff.samediff.VariableType

All Implemented Interfaces:

Serializable, Comparable<VariableType>

public enum VariableType
extends Enum<VariableType>

An SDVarible may have different uses in a SameDiff graph - VariableType represents these different roles/uses.

VARIABLE: an array of trainable parameters in the SameDiff instance. Must be floating point (to be trainable by backprop)
CONSTANT: a fixed value that should not be modified during training/inference. May be replaced by the user.
ARRAY: an intermediate array (ie., output of an op) that is not trainable and is usually not persisted. For example, activations.
PLACEHOLDER: represents an array to be provided later. Your input features and labels are placeholders.

 Type         Trainable   Gradients       Persisted       Workspaces      DataTypes
 VARIABLE     Yes         Yes             Yes             No              Floating point only
 CONSTANT     No          No              Yes             No              All
 ARRAY        No          Yes             No              Yes             All
 PLACEHOLDER  No          No              No              No              All
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY
CONSTANT
PLACEHOLDER
VARIABLE

Method Summary

Modifier and Type	Method and Description
static VariableType	valueOf(String name) Returns the enum constant of this type with the specified name.
static VariableType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VARIABLE

public static final VariableType VARIABLE

CONSTANT

public static final VariableType CONSTANT

ARRAY

public static final VariableType ARRAY

PLACEHOLDER

public static final VariableType PLACEHOLDER

Method Detail

values

public static VariableType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VariableType c : VariableType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VariableType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null