Source code for

# Copyright The Lightning AI team.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.

from concurrent.futures import ThreadPoolExecutor
from typing import Any, Optional

from lightning_fabric.plugins import CheckpointIO
from import _WrappingCheckpointIO

[docs]class AsyncCheckpointIO(_WrappingCheckpointIO): """``AsyncCheckpointIO`` enables saving the checkpoints asynchronously in a thread. .. warning:: This is currently an experimental plugin/feature and API changes are to be expected. Args: checkpoint_io: A checkpoint IO plugin that is used as the basis for async checkpointing. """ def __init__(self, checkpoint_io: Optional["CheckpointIO"] = None) -> None: super().__init__(checkpoint_io) self._executor = ThreadPoolExecutor(max_workers=1) self._error: Optional[BaseException] = None
[docs] def save_checkpoint(self, *args: Any, **kwargs: Any) -> None: """Uses the ``ThreadPoolExecutor`` to save the checkpoints using the base ``checkpoint_io``.""" def _save_checkpoint(*args: Any, **kwargs: Any) -> None: try: assert self.checkpoint_io is not None self.checkpoint_io.save_checkpoint(*args, **kwargs) except BaseException as e: self._error = e self._executor.submit(_save_checkpoint, *args, **kwargs) # if an error was raised between the previous time `save_checkpoint`` was called and now, # because `executor.submit` is not blocking if self._error: raise self._error
[docs] def teardown(self) -> None: """This method is called to close the threads.""" self._executor.shutdown(wait=True) # if an error was raised anytime in any of the `executor.submit` calls if self._error: raise self._error

© Copyright Copyright (c) 2018-2023, Lightning AI et al...

Built with Sphinx using a theme provided by Read the Docs.