weka.dl4j

Class NeuralNetConfiguration

java.lang.Object

org.deeplearning4j.nn.conf.NeuralNetConfiguration

weka.dl4j.NeuralNetConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, OptionHandler

public class NeuralNetConfiguration
extends org.deeplearning4j.nn.conf.NeuralNetConfiguration
implements java.io.Serializable, OptionHandler

A version of DeepLearning4j's NeuralNetConfiguration that implements WEKA option handling.

Version:

$Revision: 11711 $

Author:

Eibe Frank

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.deeplearning4j.nn.conf.NeuralNetConfiguration

org.deeplearning4j.nn.conf.NeuralNetConfiguration.Builder, org.deeplearning4j.nn.conf.NeuralNetConfiguration.ListBuilder

Field Summary

Fields inherited from class org.deeplearning4j.nn.conf.NeuralNetConfiguration

CUSTOM_FUNCTIONALITY

Constructor Summary

Constructors

Constructor and Description
NeuralNetConfiguration() Constructor that provides default values for the settings.

Method Summary

Modifier and Type	Method and Description
int	getIterationCount()
double	getLeakyreluAlpha()
org.deeplearning4j.nn.conf.LearningRatePolicy	getLearningRatePolicy()
double	getLrPolicyDecayRate()
double	getLrPolicyPower()
double	getLrPolicySteps()
int	getMaxNumLineSearchIterations()
int	getNumIterations()
org.deeplearning4j.nn.api.OptimizationAlgorithm	getOptimizationAlgo()
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
long	getSeed()
org.deeplearning4j.nn.conf.stepfunctions.StepFunction	getStepFunction()
boolean	isMiniBatch()
boolean	isMinimize()
boolean	isPretrain()
boolean	isUseDropConnect()
boolean	isUseRegularization()
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
void	setIterationCount(int n)
void	setLeakyreluAlpha(double a)
void	setLearningRatePolicy(org.deeplearning4j.nn.conf.LearningRatePolicy p)
void	setLrPolicyDecayRate(double r)
void	setLrPolicyPower(double r)
void	setLrPolicySteps(double r)
void	setMaxNumLineSearchIterations(int n)
void	setMiniBatch(boolean b)
void	setMinimize(boolean b)
void	setNumIterations(int n)
void	setOptimizationAlgo(org.deeplearning4j.nn.api.OptimizationAlgorithm optimAlgorithm)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setPretrain(boolean b)
void	setSeed(long n)
void	setStepFunction(org.deeplearning4j.nn.conf.stepfunctions.StepFunction f)
void	setUseDropConnect(boolean b)
void	setUseRegularization(boolean b)

Methods inherited from class org.deeplearning4j.nn.conf.NeuralNetConfiguration

addVariable, clearVariables, clone, equals, fromJson, fromYaml, getL1ByParam, getL1ByParam, getL2ByParam, getL2ByParam, getLayer, getLearningRateByParam, getLearningRateByParam, getVariables, hashCode, mapper, mapperYaml, reinitMapperWithSubtypes, setL1ByParam, setL2ByParam, setLayer, setLayerParamLR, setLearningRateByParam, setLearningRateByParam, setVariables, toJson, toString, toYaml, variables, variables

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NeuralNetConfiguration

public NeuralNetConfiguration()

Constructor that provides default values for the settings.

Method Detail

getOptimizationAlgo

@OptionMetadata(description="Optimization algorithm (LINE_GRADIENT_DESCENT, CONJUGATE_GRADIENT, HESSIAN_FREE, LBFGS, STOCHASTIC_GRADIENT_DESCENT)",
                displayName="optimization algorithm",
                commandLineParamName="algorithm",
                commandLineParamSynopsis="-algorithm <string>",
                displayOrder=0)
public org.deeplearning4j.nn.api.OptimizationAlgorithm getOptimizationAlgo()

Overrides:

getOptimizationAlgo in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setOptimizationAlgo

public void setOptimizationAlgo(org.deeplearning4j.nn.api.OptimizationAlgorithm optimAlgorithm)

Overrides:

setOptimizationAlgo in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getLeakyreluAlpha

@OptionMetadata(displayName="leaky relu alpha",
                description="The parameter for the leaky relu (default = 0.1).",
                commandLineParamName="leakyreluAlpha",
                commandLineParamSynopsis="-leakyreluAlpha <double>",
                displayOrder=1)
public double getLeakyreluAlpha()

Overrides:

getLeakyreluAlpha in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setLeakyreluAlpha

public void setLeakyreluAlpha(double a)

Overrides:

setLeakyreluAlpha in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getLearningRatePolicy

@OptionMetadata(displayName="learning rate policy",
                description="The learning rate policy (default = None).",
                commandLineParamName="learningRatePolicy",
                commandLineParamSynopsis="-learningRatePolicy <string>",
                displayOrder=2)
public org.deeplearning4j.nn.conf.LearningRatePolicy getLearningRatePolicy()

Overrides:

getLearningRatePolicy in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setLearningRatePolicy

public void setLearningRatePolicy(org.deeplearning4j.nn.conf.LearningRatePolicy p)

Overrides:

setLearningRatePolicy in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getLrPolicyDecayRate

@OptionMetadata(displayName="learning rate policy decay rate",
                description="The learning rate policy decay rate (default = NaN).",
                commandLineParamName="lrPolicyDecayRate",
                commandLineParamSynopsis="-lrPolicyDecayRate <double>",
                displayOrder=3)
public double getLrPolicyDecayRate()

Overrides:

getLrPolicyDecayRate in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setLrPolicyDecayRate

public void setLrPolicyDecayRate(double r)

Overrides:

setLrPolicyDecayRate in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getLrPolicyPower

@OptionMetadata(displayName="learning rate policy power",
                description="The learning rate policy power (default = NaN).",
                commandLineParamName="lrPolicyPower",
                commandLineParamSynopsis="-lrPolicyPower <double>",
                displayOrder=4)
public double getLrPolicyPower()

Overrides:

getLrPolicyPower in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setLrPolicyPower

public void setLrPolicyPower(double r)

Overrides:

setLrPolicyPower in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getLrPolicySteps

@OptionMetadata(displayName="learning rate policy steps",
                description="The learning rate policy steps (default = NaN).",
                commandLineParamName="lrPolicySteps",
                commandLineParamSynopsis="-lrPolicySteps <double>",
                displayOrder=5)
public double getLrPolicySteps()

Overrides:

getLrPolicySteps in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setLrPolicySteps

public void setLrPolicySteps(double r)

Overrides:

setLrPolicySteps in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getMaxNumLineSearchIterations

@OptionMetadata(displayName="maximum number of line search iterations",
                description="The maximum number of line search iterations (default = 5).",
                commandLineParamName="maxNumLineSearchIterations",
                commandLineParamSynopsis="-maxNumLineSearchIterations <int>",
                displayOrder=6)
public int getMaxNumLineSearchIterations()

Overrides:

getMaxNumLineSearchIterations in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setMaxNumLineSearchIterations

public void setMaxNumLineSearchIterations(int n)

Overrides:

setMaxNumLineSearchIterations in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

isMinimize

@OptionMetadata(displayName="whether to minimize objective",
                description="Whether to minimize objective.",
                commandLineParamIsFlag=true,
                commandLineParamName="minimize",
                commandLineParamSynopsis="-minimize",
                displayOrder=7)
public boolean isMinimize()

Overrides:

isMinimize in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setMinimize

public void setMinimize(boolean b)

Overrides:

setMinimize in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

isUseDropConnect

@OptionMetadata(displayName="whether to use drop connect",
                description="Whether to use drop connect.",
                commandLineParamIsFlag=true,
                commandLineParamName="useDropConnect",
                commandLineParamSynopsis="-useDropConnect",
                displayOrder=8)
public boolean isUseDropConnect()

Overrides:

isUseDropConnect in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setUseDropConnect

public void setUseDropConnect(boolean b)

Overrides:

setUseDropConnect in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

isUseRegularization

@OptionMetadata(displayName="whether to use regularization",
                description="Whether to use regularization.",
                commandLineParamIsFlag=true,
                commandLineParamName="useRegularization",
                commandLineParamSynopsis="-useRegularization",
                displayOrder=9)
public boolean isUseRegularization()

Overrides:

isUseRegularization in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setUseRegularization

public void setUseRegularization(boolean b)

Overrides:

setUseRegularization in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getNumIterations

@OptionMetadata(displayName="number of iterations for optimization",
                description="The number of iterations for optimization (default = 1).",
                commandLineParamName="numIterations",
                commandLineParamSynopsis="-numIterations <int>",
                displayOrder=10)
public int getNumIterations()

Overrides:

getNumIterations in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setNumIterations

public void setNumIterations(int n)

Overrides:

setNumIterations in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getStepFunction

@OptionMetadata(displayName="step function",
                description="The step function to use (default = default).",
                commandLineParamName="stepFunction",
                commandLineParamSynopsis="-stepFunction <string>",
                displayOrder=11)
public org.deeplearning4j.nn.conf.stepfunctions.StepFunction getStepFunction()

Overrides:

getStepFunction in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setStepFunction

public void setStepFunction(org.deeplearning4j.nn.conf.stepfunctions.StepFunction f)

Overrides:

setStepFunction in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getIterationCount

@ProgrammaticProperty
public int getIterationCount()

Overrides:

getIterationCount in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setIterationCount

public void setIterationCount(int n)

Overrides:

setIterationCount in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

getSeed

@ProgrammaticProperty
public long getSeed()

Overrides:

getSeed in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setSeed

public void setSeed(long n)

Overrides:

setSeed in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

isMiniBatch

@ProgrammaticProperty
public boolean isMiniBatch()

Overrides:

isMiniBatch in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setMiniBatch

public void setMiniBatch(boolean b)

Overrides:

setMiniBatch in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

isPretrain

@ProgrammaticProperty
public boolean isPretrain()

Overrides:

isPretrain in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

setPretrain

public void setPretrain(boolean b)

Overrides:

setPretrain in class org.deeplearning4j.nn.conf.NeuralNetConfiguration

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Classifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported