mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-21 05:34:18 +08:00
00ffeca1b1
See #145101 for details. Pull Request resolved: https://github.com/pytorch/pytorch/pull/145164 Approved by: https://github.com/bobrenjc93
38 lines
1.3 KiB
Python
38 lines
1.3 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates
|
|
from typing import Protocol, runtime_checkable
|
|
|
|
import torch
|
|
|
|
|
|
@runtime_checkable
|
|
class _Checkpointable(Protocol): # noqa: PYI046
|
|
"""
|
|
Interface for checkpointable objects.
|
|
Implemented as a protocol, implicit subtyping is supported so subclasses do not need to inherit this explicitly.
|
|
This is to allow arbitrary objects/tensor subclasses to hook into DCP seamlessly through implementing the interface.
|
|
"""
|
|
|
|
def __create_write_items__(self, fqn: str, object: object) -> list[object]:
|
|
"""
|
|
Return a list of WriteItems based on object's contents.
|
|
"""
|
|
raise NotImplementedError(
|
|
"_Checkpointable._create_write_items is not implemented"
|
|
)
|
|
|
|
def __create_chunk_list__(self) -> list[object]:
|
|
"""
|
|
Return a list of `ChunkStorageMetadata` based on object's contents.
|
|
"""
|
|
raise NotImplementedError(
|
|
"_Checkpointable._create_chunk_list is not implemented"
|
|
)
|
|
|
|
def __get_tensor_shard__(self, index: int) -> torch.Tensor:
|
|
"""
|
|
Return a 'torch.Tensor' shard based on 'MetadataIndex'.
|
|
"""
|
|
raise NotImplementedError(
|
|
"_Checkpointable._get_tensor_shard is not implemented"
|
|
)
|