CheckpointRunner
- class negmas.checkpoints.CheckpointRunner(folder, id=None, callback=None, watch=False, object_type=<class 'negmas.types.named.NamedObject'>)[source]
Bases:
object
Runs an object based on its checkpoints saved in an earlier run
Attributes Summary
Gets the current step number
Get the first stored step number (None if it does not exist)
Get the last stored step number (None if it does not exist)
The object stored in the current checkpoint
Get the next stored step number (None if it does not exist)
Get the previous stored step number (None if it does not exist)
A list of all stored steps
Methods Summary
fork
([copy_past_checkpoints, every, folder, ...])Creates a copy of the internal object that can be run safely.
goto
(step[, exact])Goes to the nearest step for the given one returning the exact step number.
register_callback
(callback)Registers a callback to be called whenever a new step is loaded
reset
()Goes before the first step
run
()Run all steps.
step
()Go one step forward in the stored steps.
Attributes Documentation
- previous_step
Get the previous stored step number (None if it does not exist)
Methods Documentation
- fork(copy_past_checkpoints=False, every=1, folder=None, filename=None, info=None, exist_ok=True, single=True)[source]
Creates a copy of the internal object that can be run safely.
- Parameters
copy_past_checkpoints (
bool
) – If true, all checkpoints upto and including current_step will be copied to the given folderevery (
int
) – Number of steps per checkpoint. If < 1 no checkpoints will be savedfolder (
Union
[str
,Path
,None
]) – The directory to store checkpoints underfilename (
Optional
[str
]) – Name of the file to save the checkpoint under. If None, a unique name will be chosen. Ifsingle_checkpoint
was False, then multiple files will be used prefixed with the step numberinfo (
Optional
[Dict
[str
,Any
]]) – Any extra information to save in the json file associated with each checkpointexist_ok (
bool
) – Override existing files if anysingle (
bool
) – If True, only the most recent checkpoint will be kept
Returns:
- Return type
Optional
[NamedObject
]
- goto(step, exact=False)[source]
Goes to the nearest step for the given one returning the exact step number.
- Parameters
step (int) – The step we want to goto
exact – If True, must go to the exact step number, otherwise go to the nearest step stored in a checkpoint
- Return type
Optional[step]
- Returns
None if the current step is the nearest to the given step. Otherwise the exact step we moved to
- register_callback(callback)[source]
Registers a callback to be called whenever a new step is loaded
- run()[source]
Run all steps. Notice that if
register_callback
was used to register some callback functions, they will be called for every stored stepped during the run.