simulate_checkpoints

simulate_checkpoints(num_epochs: int = 100, schedule: str | CheckpointSchedule | type[CheckpointSchedule] | None = None, schedule_kwargs: Mapping[str, Any] | None = None, keeper: str | CheckpointKeeper | type[CheckpointKeeper] | None = None, keeper_kwargs: Mapping[str, Any] | None = None) → None[source]

Simulate a checkpoint schedule and print information about checkpointing.

Warning

You cannot easily simulate schedules which depend on training dynamics, e.g., BestCheckpointSchedule.

Parameters:

  • num_epochs (int) – the number of epochs

  • schedule (str | CheckpointSchedule | type[CheckpointSchedule] | None) – a checkpoint schedule instance or selection, cf. pykeen.checkpoints.scheduler_resolver

  • schedule_kwargs (Mapping[str, Any] | None) – additional keyword-based parameters when the schedule needs to instantiated first from a selection, cf. pykeen.checkpoints.scheduler_resolver

  • keeper (str | CheckpointKeeper | type[CheckpointKeeper] | None) – a checkpoint retention policy instance or selection, cf. pykeen.checkpoints.keeper_resolver None corresponds to keeping everything that was checkpointed.

  • keeper_kwargs (Mapping[str, Any] | None) – additional keyword-based parameters when the retention policy needs to instantiated first from a selection, cf. pykeen.checkpoints.keeper_resolver

Return type:

None