org.deeplearning4j.util

Class ModelSerializer

java.lang.Object

org.deeplearning4j.util.ModelSerializer

public class ModelSerializer
extends Object

Utility class suited to save/restore neural net models

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
static String	NORMALIZER_BIN
static String	OLD_UPDATER_BIN
static String	UPDATER_BIN

Method Summary

Modifier and Type	Method and Description
static void	addNormalizerToModel(File f, org.nd4j.linalg.dataset.api.preprocessor.Normalizer<?> normalizer) This method appends normalizer to a given persisted model.
static ComputationGraph	restoreComputationGraph(File file) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(File file, boolean loadUpdater) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(InputStream is) Load a computation graph from a InputStream
static ComputationGraph	restoreComputationGraph(InputStream is, boolean loadUpdater) Load a computation graph from a InputStream
static ComputationGraph	restoreComputationGraph(String path) Load a computation graph from a file
static ComputationGraph	restoreComputationGraph(String path, boolean loadUpdater) Load a computation graph from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(File file) Load a multi layer network from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(File file, boolean loadUpdater) Load a multi layer network from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(InputStream is)
static MultiLayerNetwork	restoreMultiLayerNetwork(InputStream is, boolean loadUpdater) Load a MultiLayerNetwork from InputStream from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(String path) Load a MultilayerNetwork model from a file
static MultiLayerNetwork	restoreMultiLayerNetwork(String path, boolean loadUpdater) Load a MultilayerNetwork model from a file
static <T extends org.nd4j.linalg.dataset.api.preprocessor.Normalizer> T	restoreNormalizerFromFile(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 <T extends org.nd4j.linalg.dataset.api.preprocessor.Normalizer> T	restoreNormalizerFromInputStream(InputStream is) This method restores the normalizer form a persisted model file.
static org.nd4j.linalg.heartbeat.reports.Task	taskByModel(Model model)
static void	writeModel(Model model, File file, boolean saveUpdater) Write a model to a file
static void	writeModel(Model model, OutputStream stream, boolean saveUpdater) Write a model to an output stream
static void	writeModel(Model model, 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 String OLD_UPDATER_BIN

See Also:

Constant Field Values

UPDATER_BIN

public static final String UPDATER_BIN

See Also:

Constant Field Values

NORMALIZER_BIN

public static final String NORMALIZER_BIN

See Also:

Constant Field Values

Method Detail

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              File file,
                              boolean saveUpdater)
                       throws 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:

IOException

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              String path,
                              boolean saveUpdater)
                       throws 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:

IOException

writeModel

public static void writeModel(@NonNull
                              Model model,
                              @NonNull
                              OutputStream stream,
                              boolean saveUpdater)
                       throws 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:

IOException

restoreMultiLayerNetwork

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

Load a multi layer network from a file

Parameters:

file - the file to load from

Returns:

the loaded multi layer network

Throws:

IOException

restoreMultiLayerNetwork

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

Load a multi layer network from a file

Parameters:

file - the file to load from

Returns:

the loaded multi layer network

Throws:

IOException

restoreMultiLayerNetwork

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

Load a MultiLayerNetwork from InputStream from a file

Parameters:

is - the inputstream to load from

Returns:

the loaded multi layer network

Throws:

IOException

restoreMultiLayerNetwork

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

Throws:

IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         String path)
                                                  throws 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:

IOException

restoreMultiLayerNetwork

public static MultiLayerNetwork restoreMultiLayerNetwork(@NonNull
                                                         String path,
                                                         boolean loadUpdater)
                                                  throws 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:

IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       String path)
                                                throws 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:

IOException

restoreComputationGraph

public static ComputationGraph restoreComputationGraph(@NonNull
                                                       String path,
                                                       boolean loadUpdater)
                                                throws 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:

IOException

restoreComputationGraph

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

Load a computation graph from a InputStream

Parameters:

is - the inputstream to get the computation graph from

Returns:

the loaded computation graph

Throws:

IOException

restoreComputationGraph

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

Load a computation graph from a InputStream

Parameters:

is - the inputstream to get the computation graph from

Returns:

the loaded computation graph

Throws:

IOException

restoreComputationGraph

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

Load a computation graph from a file

Parameters:

file - the file to get the computation graph from

Returns:

the loaded computation graph

Throws:

IOException

restoreComputationGraph

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

Load a computation graph from a file

Parameters:

file - the file to get the computation graph from

Returns:

the loaded computation graph

Throws:

IOException

taskByModel

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

Parameters:

model -

Returns:

addNormalizerToModel

public static void addNormalizerToModel(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(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:

restoreNormalizerFromInputStream

public static <T extends org.nd4j.linalg.dataset.api.preprocessor.Normalizer> T restoreNormalizerFromInputStream(InputStream is)
                                                                                                          throws IOException

This method restores the normalizer form a persisted model file.

Parameters:

is - A stream to load data from.

Returns:

the loaded normalizer

Throws:

IOException