weka.dl4j.layers

Class SubsamplingLayer

java.lang.Object

weka.dl4j.layers.Layer<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

weka.dl4j.layers.SubsamplingLayer

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler, ApiWrapper<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

public class SubsamplingLayer
extends Layer<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>
implements weka.core.OptionHandler, java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubsamplingLayer() Constructor for setting some defaults.

Method Summary

Modifier and Type	Method and Description
ConvolutionMode	getConvolutionMode()
double	getEps()
int[]	getKernelSize()
int	getKernelSizeX()
int	getKernelSizeY()
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
int[]	getPadding()
int	getPaddingColumns()
int	getPaddingRows()
int	getPnorm()
PoolingType	getPoolingType()
int[]	getStride()
int	getStrideColumns()
int	getStrideRows()
java.lang.String	globalInfo() Global info.
void	initializeBackend() Initialize the DL4J backend.
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
void	setConvolutionMode(ConvolutionMode convolutionMode)
void	setEps(double e)
void	setKernelSize(int[] kernelSize)
void	setKernelSizeX(int kernelSizeX)
void	setKernelSizeY(int kernelSizeY)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setPadding(int[] padding)
void	setPaddingColumns(int padding)
void	setPaddingRows(int padding)
void	setPnorm(int p)
void	setPoolingType(PoolingType poolingType)
void	setStride(int[] stride)
void	setStrideColumns(int columns)
void	setStrideRows(int rows)

Methods inherited from class weka.dl4j.layers.Layer

create, getBackend, getLayerName, setBackend, setLayerName

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

SubsamplingLayer

public SubsamplingLayer()

Constructor for setting some defaults.

Method Detail

initializeBackend

public void initializeBackend()

Description copied from interface: ApiWrapper

Initialize the DL4J backend.

Specified by:

initializeBackend in interface ApiWrapper<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

globalInfo

public java.lang.String globalInfo()

Global info.

Returns:

string describing this class.

getEps

@OptionMetadata(displayName="eps",
                description="The value of the eps parameter (default = 1e-8).",
                commandLineParamName="eps",
                commandLineParamSynopsis="-eps <double>",
                displayOrder=2)
public double getEps()

setEps

public void setEps(double e)

getPnorm

@OptionMetadata(displayName="pnorm",
                description="The value of the pnorm parameter (default = 1).",
                commandLineParamName="pnorm",
                commandLineParamSynopsis="-pnorm <int>",
                displayOrder=3)
public int getPnorm()

setPnorm

public void setPnorm(int p)

getConvolutionMode

@OptionMetadata(displayName="convolution mode",
                description="The convolution mode (default = Truncate).",
                commandLineParamName="mode",
                commandLineParamSynopsis="-mode <string>",
                displayOrder=2)
public ConvolutionMode getConvolutionMode()

setConvolutionMode

public void setConvolutionMode(ConvolutionMode convolutionMode)

getKernelSizeX

@OptionMetadata(displayName="number of rows in kernel",
                description="The number of rows in the kernel (default = 5).",
                commandLineParamName="rows",
                commandLineParamSynopsis="-rows <int>",
                displayOrder=4)
public int getKernelSizeX()

setKernelSizeX

public void setKernelSizeX(int kernelSizeX)

getKernelSizeY

@OptionMetadata(displayName="number of columns in kernel",
                description="The number of columns in the kernel (default = 5).",
                commandLineParamName="columns",
                commandLineParamSynopsis="-columns <int>",
                displayOrder=5)
public int getKernelSizeY()

setKernelSizeY

public void setKernelSizeY(int kernelSizeY)

getKernelSize

@ProgrammaticProperty
public int[] getKernelSize()

setKernelSize

public void setKernelSize(int[] kernelSize)

getStrideRows

@OptionMetadata(displayName="number of rows in stride",
                description="The stride along the rows (default = 1).",
                commandLineParamName="strideRows",
                commandLineParamSynopsis="-strideRows <int>",
                displayOrder=6)
public int getStrideRows()

setStrideRows

public void setStrideRows(int rows)

getStride

@ProgrammaticProperty
public int[] getStride()

setStride

public void setStride(int[] stride)

getStrideColumns

@OptionMetadata(displayName="number of columns in stride",
                description="The stride along the columns (default = 1).",
                commandLineParamName="strideColumns",
                commandLineParamSynopsis="-strideColumns <int>",
                displayOrder=7)
public int getStrideColumns()

setStrideColumns

public void setStrideColumns(int columns)

getPaddingRows

@OptionMetadata(displayName="number of rows in padding",
                description="The number of rows in the padding (default = 0).",
                commandLineParamName="paddingRows",
                commandLineParamSynopsis="-paddingRows <int>",
                displayOrder=8)
public int getPaddingRows()

setPaddingRows

public void setPaddingRows(int padding)

getPadding

@ProgrammaticProperty
public int[] getPadding()

setPadding

public void setPadding(int[] padding)

getPaddingColumns

@OptionMetadata(displayName="number of columns in padding",
                description="The number of columns in the padding (default = 0).",
                commandLineParamName="paddingColumns",
                commandLineParamSynopsis="-paddingColumns <int>",
                displayOrder=9)
public int getPaddingColumns()

setPaddingColumns

public void setPaddingColumns(int padding)

getPoolingType

@OptionMetadata(displayName="pooling type",
                description="The type of pooling to use (default = MAX; options: MAX, AVG, SUM, NONE).",
                commandLineParamName="poolingType",
                commandLineParamSynopsis="-poolingType <string>",
                displayOrder=10)
public PoolingType getPoolingType()

setPoolingType

public void setPoolingType(PoolingType poolingType)

listOptions

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

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class Layer<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

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 weka.core.OptionHandler

Overrides:

getOptions in class Layer<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

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 weka.core.OptionHandler

Overrides:

setOptions in class Layer<org.deeplearning4j.nn.conf.layers.SubsamplingLayer>

Parameters:

options - the list of options as an array of strings

Throws:

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