org.deeplearning4j.nn.conf

Class NeuralNetConfiguration

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 Map<String,Double>	l1ByParam
protected Map<String,Double>	l2ByParam
protected Layer	layer
protected double	leakyreluAlpha
protected Map<String,Double>	learningRateByParam
protected LearningRatePolicy	learningRatePolicy
protected double	lrPolicyDecayRate
protected double	lrPolicyPower
protected double	lrPolicySteps
protected int	maxNumLineSearchIterations
protected boolean	miniBatch
protected boolean	minimize
protected int	numIterations
protected OptimizationAlgorithm	optimizationAlgo
protected long	seed
protected StepFunction	stepFunction
protected boolean	useDropConnect
protected boolean	useRegularization
protected List<String>	variables

Constructor Summary

Constructors

Constructor and Description
NeuralNetConfiguration()

Method Summary

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
Object[]	getExtraArgs()
double	getL1ByParam(String variable)
double	getL2ByParam(String variable)
double	getLearningRateByParam(String variable)
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
static com.fasterxml.jackson.databind.ObjectMapper	reinitMapperWithSubtypes(Collection<com.fasterxml.jackson.databind.jsontype.NamedType> additionalTypes) Reinitialize and return the Jackson/json ObjectMapper with additional named types.
void	setLayerParamLR(String variable)
void	setLearningRateByParam(String variable, double rate)
String	toJson() Return this configuration as json
String	toYaml() Return this configuration as json
List<String>	variables()
List<String>	variables(boolean copy)

Methods inherited from class java.lang.Object

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

Field Detail

layer

protected Layer layer

leakyreluAlpha

protected double leakyreluAlpha

miniBatch

protected boolean miniBatch

numIterations

protected int numIterations

maxNumLineSearchIterations

protected int maxNumLineSearchIterations

seed

protected long seed

optimizationAlgo

protected OptimizationAlgorithm optimizationAlgo

variables

protected List<String> variables

stepFunction

protected StepFunction stepFunction

useRegularization

protected boolean useRegularization

useDropConnect

protected boolean useDropConnect

minimize

protected boolean minimize

learningRateByParam

protected Map<String,Double> learningRateByParam

l1ByParam

protected Map<String,Double> l1ByParam

l2ByParam

protected Map<String,Double> l2ByParam

learningRatePolicy

protected LearningRatePolicy learningRatePolicy

lrPolicyDecayRate

protected double lrPolicyDecayRate

lrPolicySteps

protected double lrPolicySteps

lrPolicyPower

protected double lrPolicyPower

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()

variables

public List<String> variables(boolean copy)

addVariable

public void addVariable(String variable)

clearVariables

public void clearVariables()

setLayerParamLR

public void setLayerParamLR(String variable)

getLearningRateByParam

public double getLearningRateByParam(String variable)

setLearningRateByParam

public void setLearningRateByParam(String variable,
                                   double rate)

getL1ByParam

public double getL1ByParam(String variable)

getL2ByParam

public double getL2ByParam(String variable)

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:

reinitMapperWithSubtypes

public static com.fasterxml.jackson.databind.ObjectMapper reinitMapperWithSubtypes(Collection<com.fasterxml.jackson.databind.jsontype.NamedType> additionalTypes)

Reinitialize and return the Jackson/json ObjectMapper with additional named types. This can be used to add additional subtypes at runtime (i.e., for JSON mapping with types defined outside of the main DL4J codebase)

getExtraArgs

public Object[] getExtraArgs()