VariationalAutoencoderParamInitializer (deeplearning4j-nn 1.0.0-beta5 API)

java.lang.Object
- org.deeplearning4j.nn.params.DefaultParamInitializer
- - org.deeplearning4j.nn.params.VariationalAutoencoderParamInitializer

All Implemented Interfaces:

ParamInitializer
```
public class VariationalAutoencoderParamInitializer
extends DefaultParamInitializer
```
Parameter initializer for the Variational Autoencoder model. See: Kingma & Welling, 2013: Auto-Encoding Variational Bayes - https://arxiv.org/abs/1312.6114

Author:

Alex Black

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIAS_KEY_SUFFIX`
`static String`	`DECODER_PREFIX`
`static String`	`ENCODER_PREFIX`
`static String`	`PXZ_B` Key for bias parameters connecting the last decoder layer and p(data\|z) (according to whatever `ReconstructionDistribution` is set for the VAE)
`static String`	`PXZ_PREFIX`
`static String`	`PXZ_W` Key for weight parameters connecting the last decoder layer and p(data\|z) (according to whatever `ReconstructionDistribution` is set for the VAE)
`static String`	`PZX_LOGSTD2_B` Key for bias parameters for log(sigma^2) in p(z\|data)
`static String`	`PZX_LOGSTD2_PREFIX`
`static String`	`PZX_LOGSTD2_W` Key for weight parameters connecting the last encoder layer and the log(sigma^2) values for p(z\|data)
`static String`	`PZX_MEAN_B` Key for bias parameters for the mean values for p(z\|data)
`static String`	`PZX_MEAN_PREFIX`
`static String`	`PZX_MEAN_W` Key for weight parameters connecting the last encoder layer and the mean values for p(z\|data)
`static String`	`PZX_PREFIX`
`static String`	`WEIGHT_KEY_SUFFIX`

Fields inherited from class org.deeplearning4j.nn.params.DefaultParamInitializer
BIAS_KEY, GAIN_KEY, WEIGHT_KEY

Constructor Summary

Constructors
Constructor and Description

VariationalAutoencoderParamInitializer()

Constructors
Constructor and Description
`VariationalAutoencoderParamInitializer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`biasKeys(Layer layer)` Bias parameter keys given the layer configuration
`Map<String,INDArray>`	`getGradientsFromFlattened(NeuralNetConfiguration conf, INDArray gradientView)` Return a map of gradients (in their standard non-flattened representation), taken from the flattened (row vector) gradientView array.
`static VariationalAutoencoderParamInitializer`	`getInstance()`
`Map<String,INDArray>`	`init(NeuralNetConfiguration conf, INDArray paramsView, boolean initializeParams)` Initialize the parameters
`boolean`	`isBiasParam(Layer layer, String key)` Is the specified parameter a bias?
`boolean`	`isWeightParam(Layer layer, String key)` Is the specified parameter a weight?
`long`	`numParams(NeuralNetConfiguration conf)`
`List<String>`	`paramKeys(Layer l)` Get a list of all parameter keys given the layer configuration
`List<String>`	`weightKeys(Layer layer)` Weight parameter keys given the layer configuration

Methods inherited from class org.deeplearning4j.nn.params.DefaultParamInitializer
createBias, createBias, createGain, createGain, createWeightMatrix, createWeightMatrix, hasBias, hasLayerNorm, numParams

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WEIGHT_KEY_SUFFIX
```
public static final String WEIGHT_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - BIAS_KEY_SUFFIX
```
public static final String BIAS_KEY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - PZX_PREFIX
```
public static final String PZX_PREFIX
```
    See Also:
    
    Constant Field Values
  - PZX_MEAN_PREFIX
```
public static final String PZX_MEAN_PREFIX
```
    See Also:
    
    Constant Field Values
  - PZX_LOGSTD2_PREFIX
```
public static final String PZX_LOGSTD2_PREFIX
```
    See Also:
    
    Constant Field Values
  - ENCODER_PREFIX
```
public static final String ENCODER_PREFIX
```
    See Also:
    
    Constant Field Values
  - DECODER_PREFIX
```
public static final String DECODER_PREFIX
```
    See Also:
    
    Constant Field Values
  - PZX_MEAN_W
```
public static final String PZX_MEAN_W
```
    Key for weight parameters connecting the last encoder layer and the mean values for p(z|data)
    
    See Also:
    
    Constant Field Values
  - PZX_MEAN_B
```
public static final String PZX_MEAN_B
```
    Key for bias parameters for the mean values for p(z|data)
    
    See Also:
    
    Constant Field Values
  - PZX_LOGSTD2_W
```
public static final String PZX_LOGSTD2_W
```
    Key for weight parameters connecting the last encoder layer and the log(sigma^2) values for p(z|data)
    
    See Also:
    
    Constant Field Values
  - PZX_LOGSTD2_B
```
public static final String PZX_LOGSTD2_B
```
    Key for bias parameters for log(sigma^2) in p(z|data)
    
    See Also:
    
    Constant Field Values
  - PXZ_PREFIX
```
public static final String PXZ_PREFIX
```
    See Also:
    
    Constant Field Values
  - PXZ_W
```
public static final String PXZ_W
```
    Key for weight parameters connecting the last decoder layer and p(data|z) (according to whatever ReconstructionDistribution is set for the VAE)
    
    See Also:
    
    Constant Field Values
  - PXZ_B
```
public static final String PXZ_B
```
    Key for bias parameters connecting the last decoder layer and p(data|z) (according to whatever ReconstructionDistribution is set for the VAE)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VariationalAutoencoderParamInitializer
```
public VariationalAutoencoderParamInitializer()
```
- Method Detail
  - getInstance
```
public static VariationalAutoencoderParamInitializer getInstance()
```
  - numParams
```
public long numParams(NeuralNetConfiguration conf)
```
    Specified by:
    
    numParams in interface ParamInitializer
    
    Overrides:
    
    numParams in class DefaultParamInitializer
  - paramKeys
```
public List<String> paramKeys(Layer l)
```
    Description copied from interface: ParamInitializer
    
    Get a list of all parameter keys given the layer configuration
    
    Specified by:
    
    paramKeys in interface ParamInitializer
    
    Overrides:
    
    paramKeys in class DefaultParamInitializer
    
    Parameters:
    
    l - Layer
    
    Returns:
    
    All parameter keys
  - weightKeys
```
public List<String> weightKeys(Layer layer)
```
    Description copied from interface: ParamInitializer
    
    Weight parameter keys given the layer configuration
    
    Specified by:
    
    weightKeys in interface ParamInitializer
    
    Overrides:
    
    weightKeys in class DefaultParamInitializer
    
    Parameters:
    
    layer - Layer
    
    Returns:
    
    Weight parameter keys
  - biasKeys
```
public List<String> biasKeys(Layer layer)
```
    Description copied from interface: ParamInitializer
    
    Bias parameter keys given the layer configuration
    
    Specified by:
    
    biasKeys in interface ParamInitializer
    
    Overrides:
    
    biasKeys in class DefaultParamInitializer
    
    Parameters:
    
    layer - Layer
    
    Returns:
    
    Bias parameter keys
  - isWeightParam
```
public boolean isWeightParam(Layer layer,
                             String key)
```
    Description copied from interface: ParamInitializer
    
    Is the specified parameter a weight?
    
    Specified by:
    
    isWeightParam in interface ParamInitializer
    
    Overrides:
    
    isWeightParam in class DefaultParamInitializer
    
    Parameters:
    
    layer - Layer
    
    key - Key to check
    
    Returns:
    
    True if parameter is a weight
  - isBiasParam
```
public boolean isBiasParam(Layer layer,
                           String key)
```
    Description copied from interface: ParamInitializer
    
    Is the specified parameter a bias?
    
    Specified by:
    
    isBiasParam in interface ParamInitializer
    
    Overrides:
    
    isBiasParam in class DefaultParamInitializer
    
    Parameters:
    
    layer - Layer
    
    key - Key to check
    
    Returns:
    
    True if parameter is a bias
  - init
```
public Map<String,INDArray> init(NeuralNetConfiguration conf,
                                 INDArray paramsView,
                                 boolean initializeParams)
```
    Description copied from interface: ParamInitializer
    
    Initialize the parameters
    
    Specified by:
    
    init in interface ParamInitializer
    
    Overrides:
    
    init in class DefaultParamInitializer
    
    Parameters:
    
    conf - the configuration
    
    paramsView - a view of the full network (backprop) parameters
    
    initializeParams - if true: initialize the parameters according to the configuration. If false: don't modify the values in the paramsView array (but do select out the appropriate subset, reshape etc as required)
    
    Returns:
    
    Map of parameters keyed by type (view of the 'paramsView' array)
  - getGradientsFromFlattened
```
public Map<String,INDArray> getGradientsFromFlattened(NeuralNetConfiguration conf,
                                                      INDArray gradientView)
```
    Description copied from interface: ParamInitializer
    
    Return a map of gradients (in their standard non-flattened representation), taken from the flattened (row vector) gradientView array. The idea is that operates in exactly the same way as the paramsView does in #init(Map, NeuralNetConfiguration, INDArray); thus the position in the view (and, the array orders) must match those of the parameters
    
    Specified by:
    
    getGradientsFromFlattened in interface ParamInitializer
    
    Overrides:
    
    getGradientsFromFlattened in class DefaultParamInitializer
    
    Parameters:
    
    conf - Configuration
    
    gradientView - The flattened gradients array, as a view of the larger array
    
    Returns:
    
    A map containing an array by parameter type, that is a view of the full network gradients array

Class VariationalAutoencoderParamInitializer

Field Summary

Fields inherited from class org.deeplearning4j.nn.params.DefaultParamInitializer

Constructor Summary

Method Summary

Methods inherited from class org.deeplearning4j.nn.params.DefaultParamInitializer

Methods inherited from class java.lang.Object

Field Detail

WEIGHT_KEY_SUFFIX

BIAS_KEY_SUFFIX

PZX_PREFIX

PZX_MEAN_PREFIX

PZX_LOGSTD2_PREFIX

ENCODER_PREFIX

DECODER_PREFIX

PZX_MEAN_W

PZX_MEAN_B

PZX_LOGSTD2_W

PZX_LOGSTD2_B

PXZ_PREFIX

PXZ_W

PXZ_B

Constructor Detail

VariationalAutoencoderParamInitializer

Method Detail

getInstance

numParams

paramKeys

weightKeys

biasKeys

isWeightParam

isBiasParam

init

getGradientsFromFlattened