org.deeplearning4j.earlystopping.saver

Class LocalFileModelSaver

java.lang.Object

org.deeplearning4j.earlystopping.saver.LocalFileModelSaver

All Implemented Interfaces:

java.io.Serializable, EarlyStoppingModelSaver<MultiLayerNetwork>

public class LocalFileModelSaver
extends java.lang.Object
implements EarlyStoppingModelSaver<MultiLayerNetwork>

Save the best (and latest/most recent) models 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: bestModelConf.json
(b) The network parameters: bestModelParams.bin
(c) The network updater: bestModelUpdater.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
LocalFileModelSaver(java.lang.String directory) Constructor that uses default character set for configuration (json) encoding
LocalFileModelSaver(java.lang.String directory, java.nio.charset.Charset encoding)

Method Summary

Modifier and Type	Method and Description
MultiLayerNetwork	getBestModel() Retrieve the best model that was previously saved
MultiLayerNetwork	getLatestModel() Retrieve the most recent model that was previously saved
void	saveBestModel(MultiLayerNetwork net, double score) Save the best model (so far) learned during early stopping training
void	saveLatestModel(MultiLayerNetwork 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

LocalFileModelSaver

public LocalFileModelSaver(java.lang.String directory)

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

Parameters:

directory - Directory to save networks

LocalFileModelSaver

public LocalFileModelSaver(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(MultiLayerNetwork 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<MultiLayerNetwork>

Throws:

java.io.IOException

saveLatestModel

public void saveLatestModel(MultiLayerNetwork 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<MultiLayerNetwork>

Throws:

java.io.IOException

getBestModel

public MultiLayerNetwork getBestModel()
                               throws java.io.IOException

Description copied from interface: EarlyStoppingModelSaver

Retrieve the best model that was previously saved

Specified by:

getBestModel in interface EarlyStoppingModelSaver<MultiLayerNetwork>

Throws:

java.io.IOException

getLatestModel

public MultiLayerNetwork 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<MultiLayerNetwork>

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object