org.deeplearning4j.nn.modelimport.keras.utils

Class KerasLayerUtils

java.lang.Object

org.deeplearning4j.nn.modelimport.keras.utils.KerasLayerUtils

public class KerasLayerUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
KerasLayerUtils()

Method Summary

Modifier and Type	Method and Description
static void	checkForUnsupportedConfigurations(Map<String,Object> layerConfig, boolean enforceTrainingConfig, KerasLayerConfiguration conf) Checks whether layer config contains unsupported options.
static double	getBiasL1RegularizationFromConfig(Map<String,Object> layerConfig, boolean enforceTrainingConfig, KerasLayerConfiguration conf) Get L1 bias regularization (if any) from Keras bias regularization configuration.
static String	getClassNameFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get Keras layer class name from Keras layer configuration.
static KerasLayer.DimOrder	getDimOrderFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get Keras (backend) dimension order from Keras layer configuration.
static double	getDropoutFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get dropout from Keras layer configuration.
static boolean	getHasBiasFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Determine if layer should be instantiated with bias
static List<String>	getInboundLayerNamesFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get list of inbound layers from Keras layer configuration.
static Map<String,Object>	getInnerLayerConfigFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get inner layer config from Keras layer configuration.
static int[]	getInputShapeFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get Keras input shape from Keras layer configuration.
static KerasLayer	getKerasLayerFromConfig(Map<String,Object> layerConfig, boolean enforceTrainingConfig, KerasLayerConfiguration conf, Map<String,Class<? extends KerasLayer>> customLayers, Map<String,SameDiffLambdaLayer> lambdaLayers, Map<String,? extends KerasLayer> previousLayers) Build KerasLayer from a Keras layer configuration.
static KerasLayer	getKerasLayerFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf, Map<String,Class<? extends KerasLayer>> customLayers, Map<String,SameDiffLambdaLayer> lambdaLayers, Map<String,? extends KerasLayer> previousLayers) Build KerasLayer from a Keras layer configuration.
static String	getLayerNameFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get layer name from Keras layer configuration.
static org.nd4j.common.primitives.Pair<Boolean,Double>	getMaskingConfiguration(List<String> inboundLayerNames, Map<String,? extends KerasLayer> previousLayers)
static double	getMaskingValueFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get mask value
static Integer	getNInFromInputDim(Map<String,Object> layerConfig, KerasLayerConfiguration conf)
static int	getNOutFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get number of outputs from Keras layer configuration.
static List<String>	getOutboundLayerNamesFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get list of inbound layers from Keras layer configuration.
static Map<String,Object>	getTimeDistributedLayerConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Extract inner layer config from TimeDistributed configuration and merge it into the outer config.
static boolean	getZeroMaskingFromConfig(Map<String,Object> layerConfig, KerasLayerConfiguration conf) Get zero masking flag
static void	removeDefaultWeights(Map<String,INDArray> weights, KerasLayerConfiguration conf) Remove weights from config after weight setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

KerasLayerUtils

public KerasLayerUtils()

Method Detail

checkForUnsupportedConfigurations

public static void checkForUnsupportedConfigurations(Map<String,Object> layerConfig,
                                                     boolean enforceTrainingConfig,
                                                     KerasLayerConfiguration conf)
                                              throws UnsupportedKerasConfigurationException,
                                                     InvalidKerasConfigurationException

Checks whether layer config contains unsupported options.

Parameters:

layerConfig - dictionary containing Keras layer configuration

enforceTrainingConfig - whether to use Keras training configuration

Throws:

InvalidKerasConfigurationException - Invalid Keras config

UnsupportedKerasConfigurationException - Unsupported Keras config

getBiasL1RegularizationFromConfig

public static double getBiasL1RegularizationFromConfig(Map<String,Object> layerConfig,
                                                       boolean enforceTrainingConfig,
                                                       KerasLayerConfiguration conf)
                                                throws UnsupportedKerasConfigurationException,
                                                       InvalidKerasConfigurationException

Get L1 bias regularization (if any) from Keras bias regularization configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

L1 regularization strength (0.0 if none)

Throws:

UnsupportedKerasConfigurationException

InvalidKerasConfigurationException

getKerasLayerFromConfig

public static KerasLayer getKerasLayerFromConfig(Map<String,Object> layerConfig,
                                                 KerasLayerConfiguration conf,
                                                 Map<String,Class<? extends KerasLayer>> customLayers,
                                                 Map<String,SameDiffLambdaLayer> lambdaLayers,
                                                 Map<String,? extends KerasLayer> previousLayers)
                                          throws InvalidKerasConfigurationException,
                                                 UnsupportedKerasConfigurationException

Build KerasLayer from a Keras layer configuration.

Parameters:

layerConfig - map containing Keras layer properties

Returns:

KerasLayer

Throws:

InvalidKerasConfigurationException

UnsupportedKerasConfigurationException

See Also:

Layer

getKerasLayerFromConfig

public static KerasLayer getKerasLayerFromConfig(Map<String,Object> layerConfig,
                                                 boolean enforceTrainingConfig,
                                                 KerasLayerConfiguration conf,
                                                 Map<String,Class<? extends KerasLayer>> customLayers,
                                                 Map<String,SameDiffLambdaLayer> lambdaLayers,
                                                 Map<String,? extends KerasLayer> previousLayers)
                                          throws InvalidKerasConfigurationException,
                                                 UnsupportedKerasConfigurationException

Build KerasLayer from a Keras layer configuration. Building layer with enforceTrainingConfig=true will throw exceptions for unsupported Keras options related to training (e.g., unknown regularizers). Otherwise we only generate warnings.

Parameters:

layerConfig - map containing Keras layer properties

enforceTrainingConfig - whether to enforce training-only configurations

Returns:

KerasLayer

Throws:

InvalidKerasConfigurationException

UnsupportedKerasConfigurationException

See Also:

Layer

getClassNameFromConfig

public static String getClassNameFromConfig(Map<String,Object> layerConfig,
                                            KerasLayerConfiguration conf)
                                     throws InvalidKerasConfigurationException

Get Keras layer class name from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

Keras layer class name

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getTimeDistributedLayerConfig

public static Map<String,Object> getTimeDistributedLayerConfig(Map<String,Object> layerConfig,
                                                               KerasLayerConfiguration conf)
                                                        throws InvalidKerasConfigurationException

Extract inner layer config from TimeDistributed configuration and merge it into the outer config.

Parameters:

layerConfig - dictionary containing Keras TimeDistributed configuration

Returns:

Time distributed layer config

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getInnerLayerConfigFromConfig

public static Map<String,Object> getInnerLayerConfigFromConfig(Map<String,Object> layerConfig,
                                                               KerasLayerConfiguration conf)
                                                        throws InvalidKerasConfigurationException

Get inner layer config from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

Inner layer config for a nested Keras layer configuration

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getLayerNameFromConfig

public static String getLayerNameFromConfig(Map<String,Object> layerConfig,
                                            KerasLayerConfiguration conf)
                                     throws InvalidKerasConfigurationException

Get layer name from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

Keras layer name

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getInputShapeFromConfig

public static int[] getInputShapeFromConfig(Map<String,Object> layerConfig,
                                            KerasLayerConfiguration conf)
                                     throws InvalidKerasConfigurationException

Get Keras input shape from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

input shape array

Throws:

InvalidKerasConfigurationException

getDimOrderFromConfig

public static KerasLayer.DimOrder getDimOrderFromConfig(Map<String,Object> layerConfig,
                                                        KerasLayerConfiguration conf)
                                                 throws InvalidKerasConfigurationException

Get Keras (backend) dimension order from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

Dimension order

Throws:

InvalidKerasConfigurationException

getInboundLayerNamesFromConfig

public static List<String> getInboundLayerNamesFromConfig(Map<String,Object> layerConfig,
                                                          KerasLayerConfiguration conf)

Get list of inbound layers from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

List of inbound layer names

getOutboundLayerNamesFromConfig

public static List<String> getOutboundLayerNamesFromConfig(Map<String,Object> layerConfig,
                                                           KerasLayerConfiguration conf)

Get list of inbound layers from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

List of inbound layer names

getNOutFromConfig

public static int getNOutFromConfig(Map<String,Object> layerConfig,
                                    KerasLayerConfiguration conf)
                             throws InvalidKerasConfigurationException

Get number of outputs from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

Number of output neurons of the Keras layer

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getNInFromInputDim

public static Integer getNInFromInputDim(Map<String,Object> layerConfig,
                                         KerasLayerConfiguration conf)
                                  throws InvalidKerasConfigurationException

Throws:

InvalidKerasConfigurationException

getDropoutFromConfig

public static double getDropoutFromConfig(Map<String,Object> layerConfig,
                                          KerasLayerConfiguration conf)
                                   throws InvalidKerasConfigurationException

Get dropout from Keras layer configuration.

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

get dropout value from Keras config

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getHasBiasFromConfig

public static boolean getHasBiasFromConfig(Map<String,Object> layerConfig,
                                           KerasLayerConfiguration conf)
                                    throws InvalidKerasConfigurationException

Determine if layer should be instantiated with bias

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

whether layer has a bias term

Throws:

InvalidKerasConfigurationException - Invalid Keras config

getZeroMaskingFromConfig

public static boolean getZeroMaskingFromConfig(Map<String,Object> layerConfig,
                                               KerasLayerConfiguration conf)
                                        throws InvalidKerasConfigurationException

Get zero masking flag

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

if masking zeros or not

Throws:

InvalidKerasConfigurationException - Invalid Keras configuration

getMaskingValueFromConfig

public static double getMaskingValueFromConfig(Map<String,Object> layerConfig,
                                               KerasLayerConfiguration conf)
                                        throws InvalidKerasConfigurationException

Get mask value

Parameters:

layerConfig - dictionary containing Keras layer configuration

Returns:

mask value, defaults to 0.0

Throws:

InvalidKerasConfigurationException - Invalid Keras configuration

removeDefaultWeights

public static void removeDefaultWeights(Map<String,INDArray> weights,
                                        KerasLayerConfiguration conf)

Remove weights from config after weight setting.

Parameters:

weights - layer weights

conf - Keras layer configuration

getMaskingConfiguration

public static org.nd4j.common.primitives.Pair<Boolean,Double> getMaskingConfiguration(List<String> inboundLayerNames,
                                                                                      Map<String,? extends KerasLayer> previousLayers)