|TensorFlow 2 version||View source on GitHub|
Continuously yield new checkpoint files as they appear.
Compat aliases for migration
See Migration guide for more details.
tf.train.checkpoints_iterator( checkpoint_dir, min_interval_secs=0, timeout=None, timeout_fn=None )
The iterator only checks for new checkpoints when control flow has been
reverted to it. This means it can miss checkpoints if your code takes longer
to run between iterations than
min_interval_secs or the interval at which
new checkpoints are written.
timeout argument is the maximum number of seconds to block waiting for
a new checkpoint. It is used in combination with the
- If the timeout expires and no
timeout_fnwas specified, the iterator stops yielding.
- If a
timeout_fnwas specified, that function is called and if it returns a true boolean value the iterator stops yielding.
- If the function returns a false boolean value then the iterator resumes the wait for new checkpoints. At this point the timeout logic applies again.
This behavior gives control to callers on what to do if checkpoints do not
come fast enough or stop being generated. For example, if callers have a way
to detect that the training has stopped and know that no new checkpoints
will be generated, they can provide a
timeout_fn that returns
the training has stopped. If they know that the training is still going on
||The directory in which checkpoints are saved.|
||The minimum number of seconds between yielding checkpoints.|
The maximum number of seconds to wait between checkpoints. If left
||Optional function to call after a timeout. If the function returns True, then it means that no new checkpoints will be generated and the iterator will exit. The function is called with no arguments.|
String paths to latest checkpoint files as they arrive.