Skip to content

Allow configuring the minimum interval seconds for continuous checkpointing. #1666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"""Defines policies for when a checkpoint is saved."""

import dataclasses
import datetime
import typing
from typing import Container, Protocol, Sequence

Expand All @@ -23,6 +24,7 @@
class StepInfo:
"""Relevant information about a checkpoint step."""
step: int
time: datetime.datetime


@dataclasses.dataclass(kw_only=True)
Expand Down Expand Up @@ -87,19 +89,26 @@ def should_save(
return step.step in self.steps


@dataclasses.dataclass(kw_only=True)
class ContinuousCheckpointingPolicy(SaveDecisionPolicy):
"""Checkpoint as often as possible, as long as a save is not ongoing."""

minimum_interval_secs: int | None = None

def should_save(
self,
step: StepInfo,
previous_steps: Sequence[StepInfo],
*,
context: DecisionContext
) -> bool:
del step
del previous_steps
return not context.is_saving_in_progress
if context.is_saving_in_progress:
return False
if not previous_steps or self.minimum_interval_secs is None:
return True
return step.time - previous_steps[-1].time >= datetime.timedelta(
seconds=self.minimum_interval_secs
)


class PreemptionCheckpointingPolicy(SaveDecisionPolicy):
Expand Down
6 changes: 4 additions & 2 deletions checkpoint/orbax/checkpoint/checkpoint_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -1084,10 +1084,12 @@ def should_save(self, step: int) -> bool:
is_saving_in_progress = self.is_saving_in_progress()
reached_preemption = self.reached_preemption(step)
previous_step_infos = [
save_decision_policy_lib.StepInfo(step=ckpt.step)
save_decision_policy_lib.StepInfo(step=ckpt.step, time=ckpt.time)
for ckpt in self._checkpoints
]
current_step_info = save_decision_policy_lib.StepInfo(step=step)
current_step_info = save_decision_policy_lib.StepInfo(
step=step, time=datetime.datetime.now(tz=datetime.timezone.utc),
)
context = save_decision_policy_lib.DecisionContext(
is_saving_in_progress=is_saving_in_progress,
reached_preemption=reached_preemption,
Expand Down