public static class CheckpointListener.Builder extends Object
Constructor and Description |
---|
Builder(@NonNull File rootDir) |
Builder(@NonNull String rootDir) |
Modifier and Type | Method and Description |
---|---|
CheckpointListener |
build() |
CheckpointListener.Builder |
deleteExisting(boolean deleteExisting)
If the checkpoint listener is set to save to a non-empty directory, should the CheckpointListener-related
content be deleted?
This is disabled by default (and instead, an exception will be thrown if existing data is found) WARNING: Be careful when enabling this, as it deletes all saved checkpoint models in the specified directory! |
CheckpointListener.Builder |
fileNamePrefix(String fileNamePrefix) |
CheckpointListener.Builder |
keepAll()
Keep all model checkpoints - i.e., don't delete any.
|
CheckpointListener.Builder |
keepLast(int n)
Keep only the last N most recent model checkpoint files.
|
CheckpointListener.Builder |
keepLastAndEvery(int nLast,
int everyN)
Keep the last N most recent model checkpoint files, and every M checkpoint files.
For example: suppose you save every 100 iterations, for 2050 iteration, and use keepLastAndEvery(3,5). |
CheckpointListener.Builder |
logSaving(boolean logSaving)
If true (the default) log a message every time a model is saved
|
CheckpointListener.Builder |
saveEvery(long amount,
TimeUnit timeUnit)
Save a model periodically
|
CheckpointListener.Builder |
saveEvery(long amount,
TimeUnit timeUnit,
boolean sinceLast)
Save a model periodically (if sinceLast == false), or if the specified amount of time has elapsed since
the last model was saved (if sinceLast == true)
|
CheckpointListener.Builder |
saveEveryEpoch()
Save a model at the end of every epoch
|
CheckpointListener.Builder |
saveEveryNEpochs(int n)
Save a model at the end of every N epochs
|
CheckpointListener.Builder |
saveEveryNIterations(int n)
Save a model every N iterations
|
CheckpointListener.Builder |
saveEveryNIterations(int n,
boolean sinceLast)
Save a model every N iterations (if sinceLast == false), or if N iterations have passed since
the last model vas saved (if sinceLast == true)
|
CheckpointListener.Builder |
saveUpdaterState(boolean saveUpdaterState)
Whether the updater state (history/state for Adam, Nesterov momentum, etc) should be saved with each checkpoint.
Updater state is saved by default. |
public Builder(@NonNull @NonNull String rootDir)
rootDir
- Root directory to save models topublic Builder(@NonNull @NonNull File rootDir)
rootDir
- Root directory to save models topublic CheckpointListener.Builder fileNamePrefix(String fileNamePrefix)
public CheckpointListener.Builder saveEveryEpoch()
public CheckpointListener.Builder saveEveryNEpochs(int n)
public CheckpointListener.Builder saveEveryNIterations(int n)
public CheckpointListener.Builder saveEveryNIterations(int n, boolean sinceLast)
public CheckpointListener.Builder saveEvery(long amount, TimeUnit timeUnit)
amount
- Quantity of the specified time unittimeUnit
- Time unitpublic CheckpointListener.Builder saveEvery(long amount, TimeUnit timeUnit, boolean sinceLast)
amount
- Quantity of the specified time unittimeUnit
- Time unitpublic CheckpointListener.Builder keepAll()
public CheckpointListener.Builder keepLast(int n)
n
- Number of most recent checkpoints to keeppublic CheckpointListener.Builder keepLastAndEvery(int nLast, int everyN)
nLast
- Most recent checkpoints to keepeveryN
- Every N checkpoints to keep (regardless of age)public CheckpointListener.Builder logSaving(boolean logSaving)
logSaving
- Whether checkpoint saves should be logged or notpublic CheckpointListener.Builder saveUpdaterState(boolean saveUpdaterState)
saveUpdaterState
- If true: updater state will be saved with checkpoints. False: not saved.public CheckpointListener.Builder deleteExisting(boolean deleteExisting)
public CheckpointListener build()
Copyright © 2020. All rights reserved.