Inheritance Diagram

Inheritance diagram of ashpy.restorers.Restorer

class ashpy.restorers.Restorer(logdir=PosixPath('/home/docs/checkouts/'), ckpts_dir='ckpts', expect_partial=True)[source]

Bases: object

Restorer provide a way to restore objects from tf.train.Checkpoint.

Can be standalone.


__init__([logdir, ckpts_dir, expect_partial]) Initialize the Restorer.
get_global_step() Return the restored global_step.
get_steps_per_epoch() Return the restored global_step.
restore_callback(callback, callback_ckpt_id) Return the restored callbacks.
restore_object(placeholder, object_ckpt_id) Restore a placeholder from a checkpoint using the specified id.


checkpoint_map Get the map of the ids in the checkpoint.
__init__(logdir=PosixPath('/home/docs/checkouts/'), ckpts_dir='ckpts', expect_partial=True)[source]

Initialize the Restorer.

  • logdir (str) – Path to the directory with the logs.
  • ckpts_dir (str) – Name of the directory with the checkpoints to restore.
  • expect_partial (bool) – Whether to expect partial restoring or not. Default to true. For more information see the docs for tf.train.Checkpoint.restore().
Return type:


static _check_model_construction(restored_model)[source]

Optimistically check that the model.weights property returns a non empty-list.

The underlying assumption is that Models created via the sub-classing API, when restored without being properly constructed AKA called on some input, will have empty lists as layers.weights.

TODO: add docs for the exception. TODO: add test case for the Sequential without input shape

Return type:bool
_restore_checkpoint(checkpoint, partial=True)[source]

Restore or initialize the persistence layer (checkpoint).


Get the map of the ids in the checkpoint.

Map is a Dict where keys are the ids in the checkpoint and the values are the
string representation of the types.
Return type:Optional[Dict[str, str]]
Returns:Dict if the map is found, else None.

Return the restored global_step.

Return type:Variable

Return the restored global_step.

Return type:Variable
restore_callback(callback, callback_ckpt_id)[source]

Return the restored callbacks.

Return type:List[Callback]
restore_object(placeholder, object_ckpt_id)[source]

Restore a placeholder from a checkpoint using the specified id.


When restoring a tf.keras.Model object from checkpoint assure that the model has been correctly built and instantiated by firstly calling it on some sample inputs. In the case of a model built with either the Sequential or Functional API an exception will be raised; for a model built with the Chainer API it will fail silently, restoration will be “successful” but no values will actually be restored since there are no valid placeholder as the model has not be built yet.

TODO: Args TODO: Example