WeightInit (deeplearning4j-nn 1.0.0-M2 API)

java.lang.Object
- java.lang.Enum<WeightInit>
- - org.deeplearning4j.nn.weights.WeightInit

All Implemented Interfaces:

Serializable, Comparable<WeightInit>
```
public enum WeightInit
extends Enum<WeightInit>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DISTRIBUTION`
`IDENTITY`
`LECUN_NORMAL`
`LECUN_UNIFORM`
`NORMAL`
`ONES`
`RELU`
`RELU_UNIFORM`
`SIGMOID_UNIFORM`
`UNIFORM`
`VAR_SCALING_NORMAL_FAN_AVG`
`VAR_SCALING_NORMAL_FAN_IN`
`VAR_SCALING_NORMAL_FAN_OUT`
`VAR_SCALING_UNIFORM_FAN_AVG`
`VAR_SCALING_UNIFORM_FAN_IN`
`VAR_SCALING_UNIFORM_FAN_OUT`
`XAVIER`
`XAVIER_FAN_IN`
`XAVIER_LEGACY`
`XAVIER_UNIFORM`
`ZERO`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IWeightInit`	`getWeightInitFunction()` Create an instance of the weight initialization function
`IWeightInit`	`getWeightInitFunction(Distribution distribution)` Create an instance of the weight initialization function
`static WeightInit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WeightInit[]`	`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
  - DISTRIBUTION
```
public static final WeightInit DISTRIBUTION
```
  - ZERO
```
public static final WeightInit ZERO
```
  - ONES
```
public static final WeightInit ONES
```
  - SIGMOID_UNIFORM
```
public static final WeightInit SIGMOID_UNIFORM
```
  - NORMAL
```
public static final WeightInit NORMAL
```
  - LECUN_NORMAL
```
public static final WeightInit LECUN_NORMAL
```
  - UNIFORM
```
public static final WeightInit UNIFORM
```
  - XAVIER
```
public static final WeightInit XAVIER
```
  - XAVIER_UNIFORM
```
public static final WeightInit XAVIER_UNIFORM
```
  - XAVIER_FAN_IN
```
public static final WeightInit XAVIER_FAN_IN
```
  - XAVIER_LEGACY
```
public static final WeightInit XAVIER_LEGACY
```
  - RELU
```
public static final WeightInit RELU
```
  - RELU_UNIFORM
```
public static final WeightInit RELU_UNIFORM
```
  - IDENTITY
```
public static final WeightInit IDENTITY
```
  - LECUN_UNIFORM
```
public static final WeightInit LECUN_UNIFORM
```
  - VAR_SCALING_NORMAL_FAN_IN
```
public static final WeightInit VAR_SCALING_NORMAL_FAN_IN
```
  - VAR_SCALING_NORMAL_FAN_OUT
```
public static final WeightInit VAR_SCALING_NORMAL_FAN_OUT
```
  - VAR_SCALING_NORMAL_FAN_AVG
```
public static final WeightInit VAR_SCALING_NORMAL_FAN_AVG
```
  - VAR_SCALING_UNIFORM_FAN_IN
```
public static final WeightInit VAR_SCALING_UNIFORM_FAN_IN
```
  - VAR_SCALING_UNIFORM_FAN_OUT
```
public static final WeightInit VAR_SCALING_UNIFORM_FAN_OUT
```
  - VAR_SCALING_UNIFORM_FAN_AVG
```
public static final WeightInit VAR_SCALING_UNIFORM_FAN_AVG
```
- Method Detail
  - values
```
public static WeightInit[] 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 (WeightInit c : WeightInit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WeightInit 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
  - getWeightInitFunction
```
public IWeightInit getWeightInitFunction()
```
    Create an instance of the weight initialization function
    
    Returns:
    
    a new IWeightInit instance
  - getWeightInitFunction
```
public IWeightInit getWeightInitFunction(Distribution distribution)
```
    Create an instance of the weight initialization function
    
    Parameters:
    
    distribution - Distribution of the weights (Only used in case DISTRIBUTION)
    
    Returns:
    
    a new IWeightInit instance

Enum WeightInit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DISTRIBUTION

ZERO

ONES

SIGMOID_UNIFORM

NORMAL

LECUN_NORMAL

UNIFORM

XAVIER

XAVIER_UNIFORM

XAVIER_FAN_IN

XAVIER_LEGACY

RELU

RELU_UNIFORM

IDENTITY

LECUN_UNIFORM

VAR_SCALING_NORMAL_FAN_IN

VAR_SCALING_NORMAL_FAN_OUT

VAR_SCALING_NORMAL_FAN_AVG

VAR_SCALING_UNIFORM_FAN_IN

VAR_SCALING_UNIFORM_FAN_OUT

VAR_SCALING_UNIFORM_FAN_AVG

Method Detail

values

valueOf

getWeightInitFunction

getWeightInitFunction