NeuralNetConfiguration (deeplearning4j-core 0.4-rc3.2 API)

java.lang.Object
- org.deeplearning4j.nn.conf.NeuralNetConfiguration

All Implemented Interfaces:

Serializable, Cloneable
```
public class NeuralNetConfiguration
extends Object
implements Serializable, Cloneable
```
A Serializable configuration for neural nets that covers per layer parameters

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NeuralNetConfiguration.Builder`
`static class`	`NeuralNetConfiguration.ListBuilder` Fluent interface for building a list of configurations

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`batchSize`
`protected boolean`	`constrainGradientToUnitNorm`
`protected double`	`l1`
`protected double`	`l2`
`protected Layer`	`layer`
`protected int`	`maxNumLineSearchIterations`
`protected boolean`	`miniBatch`
`protected boolean`	`minimize`
`protected double`	`momentum`
`protected Map<Integer,Double>`	`momentumAfter`
`protected int`	`numIterations`
`protected OptimizationAlgorithm`	`optimizationAlgo`
`protected double`	`rho`
`protected double`	`rmsDecay`
`protected long`	`seed`
`protected StepFunction`	`stepFunction`
`protected boolean`	`useDropConnect`
`protected boolean`	`useRegularization`
`protected List<String>`	`variables`

Constructor Summary

Constructors
Constructor and Description

NeuralNetConfiguration()

Constructors
Constructor and Description
`NeuralNetConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariable(String variable)`
`void`	`clearVariables()`
`NeuralNetConfiguration`	`clone()` Creates and returns a deep copy of the configuration.
`static NeuralNetConfiguration`	`fromJson(String json)` Create a neural net configuration from json
`static NeuralNetConfiguration`	`fromYaml(String json)` Create a neural net configuration from json
`static com.fasterxml.jackson.databind.ObjectMapper`	`mapper()` Object mapper for serialization of configurations
`static com.fasterxml.jackson.databind.ObjectMapper`	`mapperYaml()` Object mapper for serialization of configurations
`String`	`toJson()` Return this configuration as json
`String`	`toYaml()` Return this configuration as json
`List<String>`	`variables()`

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

Field Detail

numIterations
```
protected int numIterations
```

momentum
```
protected double momentum
```

l2
```
protected double l2
```

useRegularization
```
protected boolean useRegularization
```

momentumAfter

protected Map<Integer,Double> momentumAfter

maxNumLineSearchIterations

protected int maxNumLineSearchIterations

optimizationAlgo

protected OptimizationAlgorithm optimizationAlgo

constrainGradientToUnitNorm

protected boolean constrainGradientToUnitNorm

rho
```
protected double rho
```

seed
```
protected long seed
```

stepFunction
```
protected StepFunction stepFunction
```

layer
```
protected Layer layer
```

variables
```
protected List<String> variables
```

useDropConnect
```
protected boolean useDropConnect
```

batchSize
```
protected int batchSize
```

minimize
```
protected boolean minimize
```

l1
```
protected double l1
```

rmsDecay
```
protected double rmsDecay
```

miniBatch
```
protected boolean miniBatch
```

Constructor Detail
- NeuralNetConfiguration
```
public NeuralNetConfiguration()
```

Method Detail
- clone
```
public NeuralNetConfiguration clone()
```
  Creates and returns a deep copy of the configuration.
  
  Overrides:
  
  clone in class Object
- variables
```
public List<String> variables()
```
- addVariable
```
public void addVariable(String variable)
```
- clearVariables
```
public void clearVariables()
```
- toYaml
```
public String toYaml()
```
  Return this configuration as json
  
  Returns:
  
  this configuration represented as json
- fromYaml
```
public static NeuralNetConfiguration fromYaml(String json)
```
  Create a neural net configuration from json
  
  Parameters:
  
  json - the neural net configuration from json
  
  Returns:
- toJson
```
public String toJson()
```
  Return this configuration as json
  
  Returns:
  
  this configuration represented as json
- fromJson
```
public static NeuralNetConfiguration fromJson(String json)
```
  Create a neural net configuration from json
  
  Parameters:
  
  json - the neural net configuration from json
  
  Returns:
- mapperYaml
```
public static com.fasterxml.jackson.databind.ObjectMapper mapperYaml()
```
  Object mapper for serialization of configurations
  
  Returns:
- mapper
```
public static com.fasterxml.jackson.databind.ObjectMapper mapper()
```
  Object mapper for serialization of configurations
  
  Returns:

Class NeuralNetConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numIterations

momentum

l2

useRegularization

momentumAfter

maxNumLineSearchIterations

optimizationAlgo

constrainGradientToUnitNorm

rho

seed

stepFunction

layer

variables

useDropConnect

batchSize

minimize

l1

rmsDecay

miniBatch

Constructor Detail

NeuralNetConfiguration

Method Detail

clone

variables

addVariable

clearVariables

toYaml

fromYaml

toJson

fromJson

mapperYaml

mapper