CheckpointConfig

class CheckpointConfig(checkpoint_dir=None, checkpoint_interval=None)[source]

Bases: object

Configuration for checkpointing during optimization.

Variables:
  • checkpoint_dir – Directory path for saving checkpoints. - If None: No checkpointing. - If Path: Uses that directory.

  • checkpoint_interval – Save checkpoint every N iterations. If None, saves every iteration (if checkpoint_dir is set).

Attributes Summary

Methods Summary

with_timestamped_dir([checkpoint_interval])

Create CheckpointConfig with auto-generated directory name.

Attributes Documentation

checkpoint_dir: Path | None = None
checkpoint_interval: int | None = None

Methods Documentation

classmethod with_timestamped_dir(checkpoint_interval=None)[source]

Create CheckpointConfig with auto-generated directory name.

Parameters:

checkpoint_interval (int | None) – Save checkpoint every N iterations. If None, saves every iteration (default).

Returns:

A new CheckpointConfig with auto-generated directory.

Return type:

CheckpointConfig