org.deeplearning4j.earlystopping.saver

Class LocalFileGraphSaver

java.lang.Object

org.deeplearning4j.earlystopping.saver.LocalFileGraphSaver

All Implemented Interfaces:

java.io.Serializable, EarlyStoppingModelSaver<ComputationGraph>

public class LocalFileGraphSaver
extends java.lang.Object
implements EarlyStoppingModelSaver<ComputationGraph>

Save the best (and latest/most recent) ComputationGraphs learned during early stopping training to the local file system.
Instances of this class will save 3 files for best (and optionally, latest) models:
(a) The network configuration: bestGraphConf.json
(b) The network parameters: bestGraphParams.bin
(c) The network updater: bestGraphUpdater.bin

NOTE: The model updater is an object that contains the internal state for training features such as AdaGrad, Momentum and RMSProp.
The updater is not required to use the network at test time; it is saved in case further training is required. Without saving the updater, any further training would result in the updater being recreated, without the benefit of the history/internal state. This could negatively impact training performance after loading the network.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalFileGraphSaver(java.lang.String directory) Constructor that uses default character set for configuration (json) encoding
LocalFileGraphSaver(java.lang.String directory, java.nio.charset.Charset encoding)

Method Summary

Modifier and Type	Method and Description
ComputationGraph	getBestModel() Retrieve the best model that was previously saved
ComputationGraph	getLatestModel() Retrieve the most recent model that was previously saved
void	saveBestModel(ComputationGraph net, double score) Save the best model (so far) learned during early stopping training
void	saveLatestModel(ComputationGraph net, double score) Save the latest (most recent) model learned during early stopping
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalFileGraphSaver

public LocalFileGraphSaver(java.lang.String directory)

Constructor that uses default character set for configuration (json) encoding

Parameters:

directory - Directory to save networks

LocalFileGraphSaver

public LocalFileGraphSaver(java.lang.String directory,
                           java.nio.charset.Charset encoding)

Parameters:

directory - Directory to save networks

encoding - Character encoding for configuration (json)

Method Detail

saveBestModel

public void saveBestModel(ComputationGraph net,
                          double score)
                   throws java.io.IOException

Description copied from interface: EarlyStoppingModelSaver

Save the best model (so far) learned during early stopping training

Specified by:

saveBestModel in interface EarlyStoppingModelSaver<ComputationGraph>

Throws:

java.io.IOException

saveLatestModel

public void saveLatestModel(ComputationGraph net,
                            double score)
                     throws java.io.IOException

Description copied from interface: EarlyStoppingModelSaver

Save the latest (most recent) model learned during early stopping

Specified by:

saveLatestModel in interface EarlyStoppingModelSaver<ComputationGraph>

Throws:

java.io.IOException

getBestModel

public ComputationGraph getBestModel()
                              throws java.io.IOException

Description copied from interface: EarlyStoppingModelSaver

Retrieve the best model that was previously saved

Specified by:

getBestModel in interface EarlyStoppingModelSaver<ComputationGraph>

Throws:

java.io.IOException

getLatestModel

public ComputationGraph getLatestModel()
                                throws java.io.IOException

Description copied from interface: EarlyStoppingModelSaver

Retrieve the most recent model that was previously saved

Specified by:

getLatestModel in interface EarlyStoppingModelSaver<ComputationGraph>

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object