org.deeplearning4j.util

Class ModelSerializer

java.lang.Object

org.deeplearning4j.util.ModelSerializer

public class ModelSerializer
extends java.lang.Object

Utility class suited to save/restore neural net models

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NORMALIZER_BIN
static java.lang.String	OLD_UPDATER_BIN
static java.lang.String	UPDATER_BIN

Method Summary

Modifier and Type	Method and Description
static void	addNormalizerToModel(java.io.File f, org.nd4j.linalg.dataset.api.preprocessor.Normalizer<?> normalizer) This method appends normalizer to a given persisted model.
static ComputationGraph	restoreComputationGraph(java.io.File file) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(java.io.File file, boolean loadUpdater) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(java.io.InputStream is) Load a computation graph from a InputStream
static ComputationGraph	restoreComputationGraph(java.io.InputStream is, boolean loadUpdater) Load a computation graph from a InputStream
static ComputationGraph	restoreComputationGraph(java.lang.String path) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(java.lang.String path, boolean loadUpdater) Load a computation graph from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(java.io.File file) Load a multi layer network from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(java.io.File file, boolean loadUpdater) Load a multi layer network from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(java.io.InputStream is)
static MultiLayerNetwork	restoreMultiLayerNetwork(java.io.InputStream is, boolean loadUpdater) Load a MultiLayerNetwork from InputStream from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(java.lang.String path) Load a MultilayerNetwork model from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(java.lang.String path, boolean loadUpdater) Load a MultilayerNetwork model from a file
static <T extends org.nd4j.linalg.dataset.api.preprocessor.Normalizer> T	restoreNormalizerFromFile(java.io.File file) This method restores normalizer from a given persisted model file PLEASE NOTE: File should be model file saved earlier with ModelSerializer with addNormalizerToModel being called
static org.nd4j.linalg.heartbeat.reports.Task	taskByModel(Model model)
static void	writeModel(Model model, java.io.File file, boolean saveUpdater) Write a model to a file
static void	writeModel(Model model, java.io.OutputStream stream, boolean saveUpdater) Write a model to an output stream
static void	writeModel(Model model, java.lang.String path, boolean saveUpdater) Write a model to a file path

Methods inherited from class java.lang.Object

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

Field Detail

OLD_UPDATER_BIN

public static final java.lang.String OLD_UPDATER_BIN

See Also:

Constant Field Values

UPDATER_BIN

public static final java.lang.String UPDATER_BIN

See Also:

Constant Field Values

NORMALIZER_BIN

public static final java.lang.String NORMALIZER_BIN

See Also:

Constant Field Values

Method Detail

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              java.io.File file,
                              boolean saveUpdater)
                       throws java.io.IOException

Write a model to a file

Parameters:

model - the model to write

file - the file to write to

saveUpdater - whether to save the updater or not

Throws:

java.io.IOException

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              java.lang.String path,
                              boolean saveUpdater)
                       throws java.io.IOException

Write a model to a file path

Parameters:

model - the model to write

path - the path to write to

saveUpdater - whether to save the updater or not

Throws:

java.io.IOException

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              java.io.OutputStream stream,
                              boolean saveUpdater)
                       throws java.io.IOException

Write a model to an output stream

Parameters:

model - the model to save

stream - the output stream to write to

saveUpdater - whether to save the updater for the model or not

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.io.File file)
                                                  throws java.io.IOException

Load a multi layer network from a file

Parameters:

file - the file to load from

Returns:

the loaded multi layer network

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.io.File file,
                                                         boolean loadUpdater)
                                                  throws java.io.IOException

Load a multi layer network from a file

Parameters:

file - the file to load from

Returns:

the loaded multi layer network

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.io.InputStream is,
                                                         boolean loadUpdater)
                                                  throws java.io.IOException

Load a MultiLayerNetwork from InputStream from a file

Parameters:

is - the inputstream to load from

Returns:

the loaded multi layer network

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.io.InputStream is)
                                                  throws java.io.IOException

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.lang.String path)
                                                  throws java.io.IOException

Load a MultilayerNetwork model from a file

Parameters:

path - path to the model file, to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         java.lang.String path,
                                                         boolean loadUpdater)
                                                  throws java.io.IOException

Load a MultilayerNetwork model from a file

Parameters:

path - path to the model file, to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.lang.String path)
                                                throws java.io.IOException

Load a computation graph from a file

Parameters:

path - path to the model file, to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.lang.String path,
                                                       boolean loadUpdater)
                                                throws java.io.IOException

Load a computation graph from a file

Parameters:

path - path to the model file, to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.io.InputStream is,
                                                       boolean loadUpdater)
                                                throws java.io.IOException

Load a computation graph from a InputStream

Parameters:

is - the inputstream to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.io.InputStream is)
                                                throws java.io.IOException

Load a computation graph from a InputStream

Parameters:

is - the inputstream to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.io.File file)
                                                throws java.io.IOException

Load a computation graph from a file

Parameters:

file - the file to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       java.io.File file,
                                                       boolean loadUpdater)
                                                throws java.io.IOException

Load a computation graph from a file

Parameters:

file - the file to get the computation graph from

Returns:

the loaded computation graph

Throws:

java.io.IOException

taskByModel

public static org.nd4j.linalg.heartbeat.reports.Task taskByModel(Model model)

Parameters:

model -

Returns:

addNormalizerToModel

public static void addNormalizerToModel(java.io.File f,
                                        org.nd4j.linalg.dataset.api.preprocessor.Normalizer<?> normalizer)

This method appends normalizer to a given persisted model. PLEASE NOTE: File should be model file saved earlier with ModelSerializer

Parameters:

f -

normalizer -

restoreNormalizerFromFile

public static <T extends org.nd4j.linalg.dataset.api.preprocessor.Normalizer> T restoreNormalizerFromFile(java.io.File file)

This method restores normalizer from a given persisted model file PLEASE NOTE: File should be model file saved earlier with ModelSerializer with addNormalizerToModel being called

Parameters:

file -

Returns: