评价此页

★ ★ ★ ★ ★

分布式检查点 - torch.distributed.checkpoint#

创建于：2022年11月16日 | 最后更新于：2025年6月16日

分布式检查点（DCP）支持跨多个 rank 并行地加载和保存模型。它处理加载时的重分片，从而支持在一个集群拓扑中保存，并在另一个集群拓扑中加载。

DCP 在几个重要方面与 torch.save 和 torch.load 不同：

它为每个检查点生成多个文件，每个 rank 至少一个。
它进行原地操作，这意味着模型应先分配其数据，DCP 使用该存储空间。

加载和保存检查点的入口点如下：

其他资源：#

class torch.distributed.checkpoint.state_dict_saver.AsyncCheckpointerType(value)[source]#: 用于异步检查点类型的枚举。

torch.distributed.checkpoint.state_dict_saver.save(state_dict, *, checkpoint_id=None, storage_writer=None, planner=None, process_group=None, no_dist=False)[source]#

以 SPMD 风格保存分布式模型。

此函数与 torch.save() 不同，因为它处理 ShardedTensor 和 DTensor，让每个 rank 只保存其本地分片。

对于每个 Stateful 对象（同时具有 state_dict 和 load_state_dict），save 会在序列化之前调用 state_dict。

警告

PyTorch 版本之间的已保存 state_dicts 不保证向后兼容。

警告

如果使用 process_group 参数，请确保只有其 ranks 调用 save_state_dict，并且 state_dict 中的所有数据都属于它。

注意

当为 FSDP 的 ShardingStrategy.HYBRID_SHARD 保存检查点时，只有一个 shard_group 应该调用 save_state_dict，并且需要传入相应的 process group。

注意

如果没有可用的进程组，此函数假定意图是保存: 本地进程中的 state_dict。

参数

state_dict (Dict[str, Any]) – 要保存的 state_dict。
checkpoint_id (Union[str, os.PathLike, None]) – 此检查点实例的 ID。checkpoint_id 的含义取决于存储。它可以是文件夹或文件的路径。如果存储是键值存储，它也可以是键。（默认：None）
storage_writer (Optional[StorageWriter]) – 用于执行写入的 StorageWriter 实例。如果未指定此项，DCP 将根据 checkpoint_id 自动推断写入器。如果 checkpoint_id 也为 None，则会引发异常。（默认：None）
planner (Optional[SavePlanner]) – SavePlanner 实例。如果未指定此项，将使用默认的 planner。（默认：None）
process_group (Optional[ProcessGroup]) – 用于跨 rank 同步的 ProcessGroup。（默认：None）
no_dist (bool) – 如果为 True，此函数将假定意图是不使用跨 rank 同步来加载检查点。（默认：False）

返回

已保存检查点的元数据对象。

返回类型

元数据

示例

>>> my_model = MyModule()

>>> state_dict = {"model": my_model}

>>> fs_storage_writer = torch.distributed.checkpoint.FileSystemWriter(
...     "/checkpoint/1"
... )
>>> torch.distributed.checkpoint.save(
>>>     state_dict=state_dict,
>>>     storage_writer=fs_storage_writer,
>>> )

注意

save_state_dict 使用集合来协调跨 rank 的写入。对于基于 NCCL 的进程组，在通信发生之前，必须将对象的内部张量表示移到 GPU 设备。在这种情况下，所使用的设备由 torch.cuda.current_device() 给出，用户有责任确保通过 torch.cuda.set_device() 设置此设备，以便每个 rank 拥有独立的 GPU。

torch.distributed.checkpoint.state_dict_saver.async_save(state_dict, *, checkpoint_id=None, storage_writer=None, planner=None, process_group=None, async_checkpointer_type=AsyncCheckpointerType.THREAD)[source]#

save 的异步版本。此代码首先将 state_dict 暂存到暂存存储（默认为 CPU 内存），然后在一个单独的线程中调用 save。

警告

此功能是实验性的，可能会发生变化。

参数

state_dict (Dict[str, Any]) – 要保存的 state_dict。
checkpoint_id (Union[str, os.PathLike, None]) – 此检查点实例的 ID。checkpoint_id 的含义取决于存储。它可以是文件夹或文件的路径。如果存储是键值存储，它也可以是键。（默认：None）
storage_writer (Optional[StorageWriter]) – 用于执行“暂存”和“保存”的 StorageWriter 实例。如果未指定此项，DCP 将根据 checkpoint_id 自动推断写入器。如果 checkpoint_id 也为 None，则会引发异常。（默认：None）
planner (Optional[SavePlanner]) – SavePlanner 实例。如果未指定此项，将使用默认的 planner。（默认：None）
process_group (Optional[ProcessGroup]) – 用于跨 rank 同步的 ProcessGroup。（默认：None）

返回

持有 save 结果元数据对象的 Future。

返回类型

Future

示例

>>> my_model = MyModule()

>>> state_dict = {"model": my_model}

>>> fs_storage_writer = torch.distributed.checkpoint.FileSystemWriter(
...     "/checkpoint/1"
... )
>>> checkpoint_future = torch.distributed.checkpoint.async_save(
>>>     state_dict=state_dict,
>>>     storage_writer=fs_storage_writer,
>>> )
>>>
>>> # ... do some work ...
>>>
>>> checkpoint_future.result()

torch.distributed.checkpoint.state_dict_saver.save_state_dict(state_dict, storage_writer, process_group=None, coordinator_rank=0, no_dist=False, planner=None)[source]#

此方法已弃用。请切换到 ‘save’。

返回类型: 元数据

torch.distributed.checkpoint.state_dict_loader.load(state_dict, *, checkpoint_id=None, storage_reader=None, planner=None, process_group=None, no_dist=False)[source]#

以 SPMD 风格将检查点加载到分布式 state_dict 中。

每个 rank 必须在其提供的 state_dict 中具有相同的键。键不匹配可能导致挂起或错误。如果不确定，可以使用 utils._assert_same_keys API 进行检查（但这可能会产生通信成本）。

每个 rank 将尝试读取满足请求的 state_dict 所需的最少数据量。加载 ShardedTensor 或 DTensor 实例时，每个 rank 只读取其本地分片的数据。

对于每个 Stateful 对象（同时具有 state_dict 和 load_state_dict），load 将首先调用 state_dict，然后尝试反序列化，最后在反序列化完成后调用 load_state_dict。对于每个非 Stateful 对象，load 将反序列化该对象，然后用反序列化的对象替换 state_dict 中的对象。

警告

在调用此函数 *之前*，state_dict 中的所有张量必须已分配到其目标设备。

所有非张量数据都使用 torch.load() 加载，并在 state_dict 上就地修改。

警告

用户必须在根模块上调用 load_state_dict，以确保加载后处理和非张量数据能够正确传播。

参数

state_dict (Dict[str, Any]) – 要将检查点加载到的 state_dict。
checkpoint_id (Union[str, os.PathLike, None]) – 此检查点实例的 ID。checkpoint_id 的含义取决于存储。它可以是文件夹或文件的路径。如果存储是键值存储，它也可以是键。（默认：None）
storage_reader (Optional[StorageReader]) – 用于执行读取的 StorageWriter 实例。如果未指定此项，DCP 将根据 checkpoint_id 自动推断读取器。如果 checkpoint_id 也为 None，则会引发异常。（默认：None）
planner (Optional[LoadPlanner]) – LoadPlanner 实例。如果未指定此项，将使用默认的 planner。（默认：None）
process_group (Optional[ProcessGroup]) – 用于跨 rank 同步的 ProcessGroup。（默认：None）
no_dist (bool) – 如果为 True，此函数将假定意图是不使用跨 rank 同步来加载检查点。（默认：False）

返回

无。

返回类型

无

示例

>>> my_model = MyModule()
>>> optimizer = Adagrad(my_model.parameters())
>>> model_state_dict = my_model.state_dict()
>>> fs_storage_reader = torch.distributed.checkpoint.FileSystemReader(
...     "/checkpoint/1"
... )

>>> torch.distributed.checkpoint.load_state_dict(
>>>     state_dict=model_state_dict,
>>>     storage_reader=fs_storage_reader,
>>> )

>>> # module.load_state_dict() function might have customized steps
>>> # to flush the state_dict, must call it to
>>> # ensure correct behavior.
>>> my_model.load_state_dict(model_state_dict)

注意

load_state_dict 使用集合来协调跨 rank 的读取。对于基于 NCCL 的进程组，在通信发生之前，必须将对象的内部张量表示移到 GPU 设备。在这种情况下，所使用的设备由 torch.cuda.current_device() 给出，用户有责任确保通过 torch.cuda.set_device() 设置此设备，以便每个 rank 拥有独立的 GPU。

torch.distributed.checkpoint.state_dict_loader.load_state_dict(state_dict, storage_reader, process_group=None, coordinator_rank=0, no_dist=False, planner=None)[source]#

此方法已弃用。请切换到 ‘load’。

以下模块对于异步检查点的暂存机制（torch.distributed.checkpoint.async_save）的附加自定义也很有用。

class torch.distributed.checkpoint.staging.AsyncStager(*args, **kwargs)[source]#

此协议旨在为 dcp.async_save 提供自定义和可扩展性，允许用户自定义数据在执行并行 dcp.save 路径之前的暂存方式。操作的预期顺序（在 torch.distributed.state_dict_saver.async_save 中具体定义）如下：

AsyncStager.stage_data(state_dict)
此调用为 AsyncStager 提供了“暂存”state_dict 的机会。在此上下文中的暂存的目的是创建一个“对训练安全”的 state dict 表示，意味着暂存完成后对模块数据的任何更新都不应反映在此方法返回的 state dict 中。例如，在默认情况下，会创建一个包含整个 state dict 的副本并在 CPU 内存中返回，从而允许用户继续训练而不会冒着对正在序列化的数据进行更改的风险。
dcp.save 在暂存的 state_dict 上并行调用。此调用负责
序列化 state_dict 并将其写入存储。
如果 AsyncStager.should_synchronize_after_execute 为 True，此方法将在
序列化线程启动后立即被调用，并在返回 dcp.async_save 之前。如果设置为 False，则假设用户已定义自定义同步点，以进一步优化训练循环中的保存延迟（例如，通过将暂存与前向/后向传递重叠），并且用户有责任在适当的时候调用 AsyncStager.synchronize_staging。

property should_synchronize_after_execute: bool#: 执行暂存后是否同步。

stage(state_dict)[source]#

返回 state_dict 的“暂存”副本。暂存副本的预期是，它不会受到暂存调用完成后对数据的任何更新的影响。

返回类型: dict[str, Union[~StatefulT, Any]]

synchronize_staging()[source]#

如果 stage 是异步的，应调用此方法以确保暂存完成，并且可以安全地开始修改原始 state_dict。

class torch.distributed.checkpoint.staging.BlockingAsyncStager(cache_staged_state_dict=False, type_check=False)[source]#

AsyncStager 的一个实现，它将 state_dict 暂存到 CPU RAM 并阻塞直到复制完成。此实现还提供了使用固定内存优化暂存延迟的选项。

注意：在此情况下，synchronize_staging 是一个 no-op。

stage(state_dict)[source]#

返回 CPU 上的 state_dict 副本。

返回类型: dict[str, Union[~StatefulT, Any]]

synchronize_staging()[source]#

无操作函数，因为暂存是阻塞的。

除了上述入口点之外，Stateful 对象（如下所述）还在保存/加载期间提供额外的自定义。

class torch.distributed.checkpoint.stateful.Stateful(*args, **kwargs)[source]#

可检查点和可恢复对象的 Stateful 协议。

load_state_dict(state_dict)[source]#

从提供的 state_dict 恢复对象的状态。

参数: state_dict (dict[str, Any]) – 要从中恢复的 state dict。

state_dict()[source]#

对象应将其 state_dict 表示形式作为字典返回。此函数将用于检查点，并在后续的 load_state_dict() 中恢复。

警告

由于恢复检查点的就地性质，此函数在 torch.distributed.checkpoint.load 期间也会被调用。

返回: 对象的状态字典
返回类型: Dict

此示例显示了如何使用 Pytorch Distributed Checkpoint 保存 FSDP 模型。

以下类型定义了检查点期间使用的 IO 接口。

class torch.distributed.checkpoint.StorageReader[source]#

load_state_dict 用于从存储读取的接口。

一个 StorageReader 实例在分布式检查点中同时充当协调器和跟随者。作为初始化的一部分，每个实例都被告知其角色。

子类应期望 load_state_dict 调用以下序列：

（所有 rank）如果用户传递了有效的 checkpoint_id，则设置 checkpoint_id。
（所有 rank）read_metadata()
（所有 rank）set_up_storage_reader()
（所有 rank）prepare_local_plan()
（协调器）prepare_global_plan()
（所有 rank）read_data()

abstract prepare_global_plan(plans)[source]#

执行存储加载的集中规划。

此方法仅在协调器实例上调用。

虽然此方法可以产生完全不同的计划，但首选方法是将特定于存储的数据存储在 LoadPlan::storage_data 中。

参数: plans (list[torch.distributed.checkpoint.planner.LoadPlan]) – 一个 LoadPlan 实例列表，每个 rank 一个。
返回: 一个 LoadPlan 列表，在存储全局规划后进行转换。
返回类型: list[torch.distributed.checkpoint.planner.LoadPlan]

abstract prepare_local_plan(plan)[source]#

执行特定于存储的本地规划。

虽然此方法可以产生完全不同的计划，但推荐的方法是将特定于存储的数据存储在 LoadPlan::storage_data 中。

参数: plan (LoadPlan) – 来自当前使用的 LoadPlan 的本地计划。
返回: 一个 LoadPlan，在存储本地规划后进行转换。
返回类型: LoadPlan

abstract read_data(plan, planner)[source]#

使用 planner 解析数据，读取 plan 中的所有项。

子类应调用 LoadPlanner::load_bytes 将 BytesIO 对象反序列化到正确的位置。

子类应调用 LoadPlanner::resolve_tensor 来访问它们应该加载数据的张量。

存储层负责正确调度所需的任何跨设备复制。

参数

plan (LoadPlan) – 要在其上执行的本地计划。
planner (LoadPlanner) – 用于解析项的 planner 对象。

返回

一个 Future，一旦所有读取完成，它将完成。

返回类型

Future[None]

abstract read_metadata()[source]#

读取检查点元数据。

返回: 与正在加载的检查点关联的元数据对象。
返回类型: 元数据

abstract reset(checkpoint_id=None)[source]#

调用以指示将要发生一个新的检查点读取。如果用户为此检查点读取设置了 checkpoint_id，则 checkpoint_id 可能存在。checkpoint_id 的含义取决于存储。它可以是文件夹/文件的路径，或者对于键值存储是键。

参数: checkpoint_id (Union[str, os.PathLike, None]) – 此检查点实例的 ID。checkpoint_id 的含义取决于存储。它可以是文件夹或文件的路径。如果存储更像键值存储，它也可以是键。（默认：None）

abstract set_up_storage_reader(metadata, is_coordinator)[source]#

初始化此实例。

参数

metadata (Metadata) – 要使用的元数据模式。
is_coordinator (bool) – 此实例是否负责协调检查点。

abstract classmethod validate_checkpoint_id(checkpoint_id)[source]#

检查给定的 checkpoint_id 是否被存储支持。这允许我们启用自动存储选择。

返回类型: 布尔值

class torch.distributed.checkpoint.StorageWriter[source]#

save_state_dict 用于写入存储的接口。

一个 StorageWriter 实例在分布式检查点中同时充当协调器和跟随者。作为初始化的一部分，每个实例都被告知其角色。

子类应期望以下调用序列。

（所有 rank）如果用户传递了有效的 checkpoint_id，则设置 checkpoint_id。
（所有 rank）set_up_storage_writer()
（所有 rank）prepare_local_plan()
（协调器）prepare_global_plan()
（所有 rank）write_data()
（协调器）finish()

abstract finish(metadata, results)[source]#

写入元数据并标记当前检查点成功。

序列化 metadata 的实际格式/模式是实现细节。唯一的要求是它能够恢复到相同的对象图。

参数

metadata (Metadata) – 新检查点的元数据。
results (list[list[torch.distributed.checkpoint.storage.WriteResult]]) – 来自所有 rank 的 WriteResults 列表。

返回

无

返回类型

无

abstract prepare_global_plan(plans)[source]#

执行存储的集中规划。

此方法仅在协调器实例上调用。

虽然此方法可以产生完全不同的计划，但首选方法是将特定于存储的数据存储在 SavePlan::storage_data 中。

参数: plans (list[torch.distributed.checkpoint.planner.SavePlan]) – 一个 SavePlan 实例列表，每个 rank 一个。
返回: 一个 SavePlan 列表，在存储全局规划后进行转换。
返回类型: list[torch.distributed.checkpoint.planner.SavePlan]

abstract prepare_local_plan(plan)[source]#

执行特定于存储的本地规划。

虽然此方法可以产生完全不同的计划，但推荐的方法是将特定于存储的数据存储在 SavePlan::storage_data 中。

参数: plan (SavePlan) – 来自正在使用的 SavePlanner 的本地计划。
返回: 一个 SavePlan，在存储本地规划后进行转换。
返回类型: SavePlan

abstract reset(checkpoint_id=None)[source]#

调用以指示将要发生一个新的检查点写入。如果用户为此检查点写入设置了 checkpoint_id，则 checkpoint_id 可能存在。checkpoint_id 的含义取决于存储。它可以是文件夹/文件的路径，或者对于键值存储是键。

参数: checkpoint_id (Union[str, os.PathLike, None]) – 此检查点实例的 ID。checkpoint_id 的含义取决于存储。它可以是文件夹或文件的路径。如果存储是键值存储，它也可以是键。（默认：None）

abstract set_up_storage_writer(is_coordinator)[source]#

初始化此实例。

参数: is_coordinator (bool) – 此实例是否负责协调检查点。

storage_meta()[source]#

返回特定于存储的元数据。这用于将额外的、可能有助于提供请求级别可观察性的信息存储在检查点中。StorageMeta 在保存调用期间传递给 SavePlanner。默认返回 None。

待办事项：提供示例

返回类型: Optional[StorageMeta]

abstract classmethod validate_checkpoint_id(checkpoint_id)[source]#

检查给定的 checkpoint_id 是否被存储支持。这允许我们启用自动存储选择。

返回类型: 布尔值

abstract write_data(plan, planner)[source]#

使用 planner 解析数据，将 plan 中的所有项写入。

子类应调用 SavePlanner::resolve_data 来获取要写入的底层对象。

子类应惰性调用 resolve_data，因为它可能会分配内存。对于张量，请进行以下假设：

它们可能位于任何设备上，包括不匹配 WriteItem::tensor_data 的设备。
它们可能是视图，也可能不是连续的。只需要保存投影。

参数

plan (SavePlan) – 要执行的保存计划。
planner (SavePlanner) – 用于解析项到数据的 planner 对象。

返回

一个 Future，它将完成为 WriteResult 列表。

返回类型

Future[list[torch.distributed.checkpoint.storage.WriteResult]]

以下类型定义了检查点期间使用的 planner 接口。

class torch.distributed.checkpoint.LoadPlanner[source]#

定义 load_state_dict 用于规划加载过程的协议的抽象类。

LoadPlanner 是有状态的对象，可用于自定义整个加载过程。

LoadPlanner 作为 state_dict 的访问代理，因此对其进行的任何转换都将对整个过程可见。

planner 子类可以在 load_state_dict 期间预期以下调用序列：

set_up_planner - 在所有 rank 上调用。
信号加载检查点的开始。
create_local_plan - 在所有 rank 上调用。
处理 state_dict 并生成一个将用于全局规划的 LoadPlan。
create_global_plan - 仅在协调器 rank 上调用。
获取所有 rank 的 LoadPlan 并进行任何全局决策。
load_bytes - 在每个 rank 上多次调用。
每次为 state_dict 中的非张量值调用一次。
resolve_tensor 和 commit_tensor - 在每个 rank 上多次调用。
它们成对调用，用于 state_dict 中的每个 Tensor 值。

建议用户直接扩展 DefaultLoadPlanner 而不是此接口，因为大多数更改都可以通过更改单个方法来表达。

通常有两种扩展模式：

重写 state_dict。这是扩展加载过程的最简单方法，因为它不需要理解 LoadPlan 的复杂性。我们需要保留对原始 state_dict 的引用，因为加载是就地进行的，所以我们需要能够就地执行它。

>>> class RenamePlanner(DefaultLoadPlanner):
>>>     def set_up_planner(
>>>         self,
>>>         state_dict: STATE_DICT_TYPE,
>>>         metadata: Metadata,
>>>         is_coordinator: bool,
>>>     ) -> None:
>>>         self.original_state_dict = state_dict
>>>         state_dict = {"foo_" + k: v for k, v in state_dict.items()}
>>>
>>>         if self.flatten_sharded_tensors:
>>>             state_dict = _flatten_sharded_tensors(state_dict)
>>>
>>>         if self.flatten_state_dict:
>>>             state_dict, self.mappings = flatten_state_dict(state_dict)
>>>
>>>         self.state_dict = state_dict
>>>         self.metadata = metadata
>>>         self.is_coordinator = is_coordinator
>>>
>>>     def load_bytes(self, read_item, value):
>>> # Remove the "foo_" prefix
>>>         self.original_state_dict[read_item.dest_index.fqn[4:]] = torch.load(value, weights_only=False)

修改 resolve_tensor 和 commit_tensor 以处理加载时转换。

>>> class MetaModelMaterialize(DefaultSavePlanner):
>>>     def resolve_tensor(self, read_item):
>>>         tensor = super().resolve_tensor(read_item)
>>>         return torch.empty_like(tensor, device="cpu")
>>>
>>>     def commit_tensor(self, read_item, tensor):
>>>         self.state_dict[read_item.dest_index.fqn] = tensor

abstract commit_tensor(read_item, tensor)[source]#

在 StorageReader 完成将数据加载到 tensor 中后调用一次。

提供的张量是调用 resolve_tensor 返回的同一个张量。只有当此 LoadPlanner 需要在将张量复制回 state_dict 中的张量之前进行后处理时，才需要此方法。

张量的内容将遵循其设备同步模型。

abstract create_global_plan(global_plan)[source]#

计算全局加载计划并返回每个 rank 的计划。

N.B. 此项仅在协调器 rank 上调用。

返回类型: list[torch.distributed.checkpoint.planner.LoadPlan]

abstract create_local_plan()[source]#

根据 set_up_planner 提供的 state_dict 和元数据创建 LoadPlan。

N.B. 此项在所有 rank 上调用。

返回类型: LoadPlan

abstract finish_plan(central_plan)[source]#

接受来自协调器的计划并返回最终的 LoadPlan。

返回类型: LoadPlan

abstract load_bytes(read_item, value)[source]#

加载由 read_item``和 ``value 描述的项。

此方法预计会就地修改 state_dict 的底层。

value 的内容由用于生成正在加载的检查点的 SavePlanner 定义。

resolve_bytes(read_item)[source]#

返回 StorageReader 用于加载 read_item 的 BytesIO。

BytesIO 应与 state_dict 的底层字节流别名，因为 StorageReader 将替换其内容。

返回类型: BytesIO

abstract resolve_tensor(read_item)[source]#

返回由 read_item 描述的张量，供 StorageReader 用于加载 read_item。

张量应与 state_dict 的底层张量别名，因为 StorageReader 将替换其内容。如果由于任何原因这不可行，planner 可以使用 commit_tensor 方法将数据复制回 state_dict 中的张量。

返回类型: 张量

abstract set_up_planner(state_dict, metadata=None, is_coordinator=False)[source]#

初始化此 planner 以加载数据到 state_dict。

N.B. 此项在所有 rank 上调用。

class torch.distributed.checkpoint.LoadPlan(items: list[torch.distributed.checkpoint.planner.ReadItem], storage_data: Any = None, planner_data: Any = None)[source]#

class torch.distributed.checkpoint.ReadItem(type: torch.distributed.checkpoint.planner.LoadItemType, dest_index: torch.distributed.checkpoint.metadata.MetadataIndex, dest_offsets: torch.Size, storage_index: torch.distributed.checkpoint.metadata.MetadataIndex, storage_offsets: torch.Size, lengths: torch.Size)[source]#

class torch.distributed.checkpoint.SavePlanner[source]#

定义 save_state_dict 用于规划保存过程的协议的抽象类。

SavePlanners 是有状态的对象，可用于自定义整个保存过程。

SavePlanner 作为 state_dict 的访问代理，因此对其进行的任何转换都将对整个过程可见。

planner 子类可以在 save_state_dict 期间预期以下调用序列：

set_up_planner - 在所有 rank 上调用。
信号检查点保存的开始。
create_local_plan - 在所有 rank 上调用。
处理 state_dict 并生成将用于全局规划的 SavePlan。
create_global_plan - 仅在协调器 rank 上调用。
获取所有 rank 的 SavePlan 并进行任何全局决策。
finish_plan - 在所有 rank 上调用。
这使得每个 rank 都有机会适应全局规划决策。
resolve_data - 在每个 rank 上多次调用。
查找 state_dict 中的对象，供存储层写入。

建议用户直接扩展 DefaultSavePlanner 而不是此接口，因为大多数更改都可以通过更改单个方法来表达。

通常有 3 种扩展模式：

重写 state_dict。这是扩展保存过程的最简单方法，因为它不需要理解 SavePlan 的复杂性。

>>> class RenamePlanner(DefaultSavePlanner):
>>>     def set_up_planner(
>>>         self,
>>>         state_dict: STATE_DICT_TYPE,
>>>         storage_meta: Optional[StorageMeta],
>>>         is_coordinator: bool,
>>>     ) -> None:
>>> # prefix all keys with `foo_``
>>>         super().set_up_planner({"foo_" + k: v for k, v in state_dict.items()}, storage_meta, is_coordinator)

修改本地计划并同步查找。这对于精细控制数据持久化方式很有用。

>>> class FP16Planner(DefaultSavePlanner):
>>>     def create_local_plan(self):
>>>         plan = super().create_local_plan()
>>>         for p in plan:
>>>             if p.tensor_data is not None:
>>>                 p.tensor_data.properties.dtype = torch.float16
>>>         return plan
>>>
>>>     def resolve_data(self, write_item):
>>>         item = super().resolve_data(write_item)
>>>         return item if write_item.type == WriteItemType.BYTE_IO else item.to(torch.float16)

使用全局规划步骤来做出单个 rank 无法做出的中心决策。

>>> from itertools import zip_longest
>>> from dataclasses import replace
>>> class DDPLoadBalancingPlanner(DefaultSavePlanner):
>>> # This uses the default local plan behavior of having all non-sharded writes in rank 0
>>> # This sample doesn't handle ShardedTensors
>>>     def create_global_plan(self, all_plans):
>>>         iters = [iter(all_plans[0].items)] * len(all_plans)
>>>         items_per_rank = [
>>>             [item for item in items if item is not None]
>>>             for items in zip(*zip_longest(*iters), strict=True)
>>>         ]
>>>         all_plans = [
>>>             replace(plan, items=items)
>>>             for plan, items in zip(all_plans, items_per_rank, strict=True)
>>>         ]
>>>         return super().create_global_plan(all_plans)

最后，一些 planner 需要将额外的元数据保存在检查点中，这可以通过让每个 rank 在本地计划中贡献其数据项，然后由全局 planner 进行聚合来实现。

>>> class SaveExtraDataPlanner(DefaultSavePlanner):
>>>     def create_local_plan(self) -> SavePlan:
>>>         plan = super().create_local_plan()
>>>         return replace(plan, planner_data="per-rank-data")
>>>
>>>     def create_global_plan(self, all_plans: List[SavePlan]) -> Tuple[List[SavePlan], Metadata]:
>>>         global_plan, metadata = super().create_global_plan(all_plans)
>>>         merged_data = [p.planner_data for p in global_plan]
>>>         metadata = replace(metadata, planner_data=merged_data)
>>>         return global_plan, metadata

abstract create_global_plan(all_plans)[source]#

计算全局检查点计划并返回每个 rank 的本地计划。

此项仅在协调器 rank 上调用。

返回类型: tuple[list[torch.distributed.checkpoint.planner.SavePlan], torch.distributed.checkpoint.metadata.Metadata]

abstract create_local_plan()[source]#

计算当前 rank 的保存计划。

这将被聚合并传递给 create_global_plan。计划程序特定数据可以通过 SavePlan::planner_data 传递。

此项在所有 rank 上调用。

返回类型: SavePlan

abstract finish_plan(new_plan)[source]#

合并由 create_local_plan 创建的计划和 create_global_plan 的结果。

此项在所有 rank 上调用。

返回类型: SavePlan

abstract resolve_data(write_item)[source]#

转换并准备 state_dict 中的 write_item 以便存储，确保幂等性和线程安全性。

在 state_dict 中查找与 write_item 关联的对象，并在存储层使用它之前应用任何转换（例如序列化）。

在每个 rank 上多次调用，至少为最终 SavePlan 中的每个 WriteItem 调用一次。

此方法应该是幂等的且线程安全的。StorageWriter 实现可以根据需要频繁调用它。

任何分配内存的转换都应在调用此方法时惰性执行，以减少检查点所需的峰值内存。

返回张量时，它们可以位于任何设备或格式上，也可以是视图。由存储层负责确定如何保存它们。

返回类型: Union[Tensor, BytesIO]

abstract set_up_planner(state_dict, storage_meta=None, is_coordinator=False)[source]#

初始化此 planner 以保存 state_dict。

实现应保存这些值，因为它们在保存过程中稍后不会提供。

此项在所有 rank 上调用。

class torch.distributed.checkpoint.SavePlan(items: list[torch.distributed.checkpoint.planner.WriteItem], storage_data: Any = None, planner_data: Any = None, usable: bool = True)[source]#

class torch.distributed.checkpoint.planner.WriteItem(index, type, bytes_io_data=None, tensor_data=None)[source]#

包含有关要写入存储的信息的数据类。

tensor_storage_size()[source]#

计算底层张量的存储大小，如果不是张量写入，则为 None。

返回: Optional[int] 存储大小，以字节为单位，如果存在张量。
返回类型: Optional[int]

class torch.distributed.checkpoint.planner.BytesIOWriteData(nbytes: int)[source]#

我们提供了一个基于文件系统的存储层。

class torch.distributed.checkpoint.FileSystemReader(path, _extension_registry=None)[source]#

property checkpoint_id: Union[str, PathLike]#: 返回将用于加载检查点的 checkpoint_id。

class torch.distributed.checkpoint.FileSystemWriter(path, single_file_per_rank=True, sync_files=True, thread_count=1, per_thread_copy_ahead=10000000, cache_staged_state_dict=False, overwrite=True, _extensions=None, serialization_format=SerializationFormat.TORCH_SAVE)[source]#

使用文件 IO 的 StorageWriter 基本实现。

此实现做出了以下假设和简化：

检查点路径是一个空目录或不存在的目录。
文件创建是原子的。

检查点由每个写入请求一个文件以及一个序列化的元数据文件 .metadata 组成。

stage(state_dict)[source]#

AsyncStager.stage 的覆盖。

返回类型: dict[str, Union[~StatefulT, Any]]

我们还提供了其他存储层，包括与 HuggingFace safetensors 交互的存储层。

.. autoclass:: torch.distributed.checkpoint.HuggingFaceStorageReader :members

.. autoclass:: torch.distributed.checkpoint.HuggingFaceStorageWriter :members

我们提供了 LoadPlanner 和 SavePlanner 的默认实现，它们可以处理 torch.distributed 的所有构造，例如 FSDP、DDP、ShardedTensor 和 DistributedTensor。

class torch.distributed.checkpoint.DefaultSavePlanner(flatten_state_dict=True, flatten_sharded_tensors=True, dedup_replicated_tensors=None, dedup_save_to_lowest_rank=False, enable_plan_caching=False)[source]#

lookup_object(index)[source]#

从 planner 接口扩展，以便于扩展默认 planner。

返回类型: 任何

transform_object(write_item, object)[source]#

从 planner 接口扩展，以便于扩展默认 planner。

class torch.distributed.checkpoint.DefaultLoadPlanner(flatten_state_dict=True, flatten_sharded_tensors=True, allow_partial_load=False)[source]#

DefaultLoadPlanner，它在 LoadPlanner 之上添加了多个功能。

特别是，它添加了以下功能：

flatten_state_dict：处理具有嵌套字典的 state_dict。flatten_sharded_tensors：对于 2D 并行模式下的 FSDP。allow_partial_load：如果为 False，则如果 state_dict 中存在但检查点中不存在的键，将引发运行时错误。

lookup_tensor(index)[source]#

从 planner 接口扩展，以便于扩展默认 planner。

返回类型: 张量

transform_tensor(read_item, tensor)[source]#

从 planner 接口扩展，以便于扩展默认 planner。

由于遗留设计决策，FSDP 和 DDP 的 state dictionaries 可能具有不同的键或完全限定名称（例如，layer1.weight），即使原始的非并行化模型相同。此外，FSDP 提供各种模型状态字典，例如完整状态字典和分片状态字典。此外，优化器状态字典使用参数 ID 而不是完全限定名称来标识参数，这在使用并行性（例如管道并行性）时可能导致问题。

为了解决这些挑战，我们提供了一系列 API，供用户轻松管理 state_dicts。get_model_state_dict() 返回的模型状态字典的键与非并行化模型状态字典返回的键一致。类似地，get_optimizer_state_dict() 提供在所有应用的并行性之间键一致的优化器状态字典。为了实现这种一致性，get_optimizer_state_dict() 将参数 ID 转换为与非并行化模型状态字典中找到的参数 ID 相同的完全限定名称。

请注意，这些 API 返回的结果可以直接用于 torch.distributed.checkpoint.save() 和 torch.distributed.checkpoint.load() 方法，而无需任何额外的转换。

set_model_state_dict() 和 set_optimizer_state_dict() 用于加载其相应 getter API 生成的模型和优化器 state_dict。

请注意，set_optimizer_state_dict() 只能在 backward() 之前或在优化器的 step() 之后调用。

请注意，此功能是实验性的，API 签名在未来可能会发生变化。

torch.distributed.checkpoint.state_dict.get_state_dict(model, optimizers, *, submodules=None, options=None)[源代码]#

返回模型 state_dict 和优化器 state_dict。

get_state_dict 可以处理由 PyTorch FSDP/fully_shard、DDP/replicate、tensor_parallel/parallelize_module 以及这些并行性的任何组合并行化的任何模块。 get_state_dict 的主要功能是：1.) 返回一个模型和优化器 state_dict，该 state_dict 可以使用不同数量的训练器和/或不同的并行性进行重分片。 2.) 隐藏特定于并行性的 state_dict API。用户不必调用这些 API。 3.) 对结果 state_dict 进行健全性检查。

结果 state dictionary 的键是规范的 FQN（完全限定名）。规范 FQN 指的是基于参数在 nn.Module 层次结构中的位置的 FQN。更具体地说，到参数的规范 FQN 是当模块未被任何并行性分布式时，module.named_parameters() 或 module.named_buffers() 返回的 FQN。由于优化器内部使用参数 ID 来表示参数，因此在调用此 API 时，会进行从参数 ID 到规范 FQN 的转换。

get_state_dict 还可以处理未并行化的模块。在这种情况下，get_state_dict 只执行一项功能——将优化器参数 ID 转换为规范 FQN。

示例

>>> import torch
>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> from torch.nn.parallel import DistributedDataParallel as DDP
>>> from torch.distributed.checkpoint.state_dict import get_state_dict

>>> fsdp_model = FSDP(copy.deepcopy(model))
>>> fsdp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)
>>> ddp_model = DDP(copy.deepcopy(model))
>>> ddp_optim = torch.optim.Adam(model.parameters(), lr=1e-3)

>>> ddp_state_dict, ddp_optim_state_dict = get_state_dict(ddp_model, ddp_optim)
>>> fsdp_state_dict, fsdp_optim_state_dict = get_state_dict(
...     fsdp_model, fsdp_optim
... )

>>> # if we simply call ddp_model.state_dict() and fsdp_model.state_dict(),
>>> # the asserts will fail.
>>> assert ddp_state_dict == fsdp_state_dict
>>> assert ddp_optim_state == fsdp_optim_state_dict

参数

model (nn.Module) – 模型的 nn.Module。
optimizers (Union[None, Optimizer, Iterable[Optimizer]]) – 用于优化 model 的优化器。
submodules (已弃用) – Optional[set[nn.Module]]: 仅返回属于子模块的模型参数。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何返回的选项。有关详细信息，请参阅 StateDictOptions。

返回

Tuple，包含模型 state_dict 和优化器 state_dict。

返回类型

Tuple[Dict[str, ValueType], OptimizerStateType]

torch.distributed.checkpoint.state_dict.get_model_state_dict(model, *, submodules=None, options=None)[源代码]#

返回 model 的模型 state_dict。

有关详细用法，请参阅 get_state_dict。

参数

model (nn.Module) – 模型的 nn.Module。
submodules (已弃用) – Optional[set[nn.Module]]: 仅返回属于子模块的模型参数。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何返回的选项。有关详细信息，请参阅 StateDictOptions。

返回

model 的 state_dict。

返回类型

Dict[str, ValueType]

torch.distributed.checkpoint.state_dict.get_optimizer_state_dict(model, optimizers, *, submodules=None, options=None)[源代码]#

返回优化器的组合 state_dict。

有关详细用法，请参阅 get_state_dict。

参数

model (nn.Module) – 模型的 nn.Module。
optimizers (Union[None, Optimizer, Iterable[Optimizer]]) – 用于优化 model 的优化器。
submodules (已弃用) – Optional[set[nn.Module]]: 仅返回属于子模块的模型参数。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何返回的选项。有关详细信息，请参阅 StateDictOptions。

返回

optimizers 的 state_dict。

返回类型

OptimizerStateType

torch.distributed.checkpoint.state_dict.set_state_dict(model, optimizers, *, model_state_dict, optim_state_dict, options=None)[源代码]#

加载模型 state_dict 和优化器 state_dict。

get_state_dict 的对应函数，用于将 state_dict 设置到模型和优化器。提供的 model_state_dict 和 optim_state_dict 不必由 get_state_dict 返回，但必须满足以下要求：1) 所有 FQN 均为 get_state_dict 中定义的规范 FQN；2) 如果张量被分片，它必须是 ShardedTensor 或 DTensor；3) 优化器 state_dict 不能包含参数 ID；键应为规范 FQN。

警告：set_state_dict 只能在 backward() 之前或 step() 之后调用。: 否则，优化器状态将无法正确初始化。

参数

model (nn.Module) – 模型的 nn.Module。
optimizers (Union[Optimizer, Iterable[Optimizer]]) – 用于优化 model 的优化器。
model_state_dict (Dict[str, ValueType]) – (Union[Dict[nn.Module, Dict[str, ValueType]], Dict[str, ValueType]]): 要加载的模型 state_dict。如果 model_state_dict 的键是 nn.Module，则该键是 model 的一个子模块，值应该是该子模块的 state_dict。加载 state_dict 时，子模块的前缀将附加到 state_dict 中。
optim_state_dict (OptimizerStateType) – OptimizerStateType：要加载的优化器 state_dict。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何加载的选项。有关详细信息，请参阅 StateDictOptions。

返回

missing_keys 是一个包含模型 state_dict 缺失键的字符串列表。
unexpected_keys 是一个包含模型 state_dict 意外键的字符串列表。

返回类型

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple。

torch.distributed.checkpoint.state_dict.set_model_state_dict(model, model_state_dict, *, options=None)[源代码]#

加载模型 state_dict。

get_model_state_dict 的对应函数，用于将 state_dict 设置到模型。有关详细用法，请参阅 set_state_dict。

参数

model (nn.Module) – 模型的 nn.Module。
model_state_dict (Dict[str, ValueType]) – (Dict[str, ValueType]): 要加载的模型 state_dict。如果 model_state_dict 的键是 nn.Module，则该键是 model 的一个子模块，值应该是该子模块的 state_dict。加载 state_dict 时，子模块的前缀将附加到 state_dict 中。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何加载的选项。有关详细信息，请参阅 StateDictOptions。

返回

missing_keys 是包含缺失键的字符串列表。
unexpected_keys 是包含意外键的字符串列表。

返回类型

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple。

torch.distributed.checkpoint.state_dict.set_optimizer_state_dict(model, optimizers, optim_state_dict, *, options=None)[源代码]#

加载优化器 state_dict。

get_optimizer_state_dict 的对应函数，用于将 state_dict 设置到优化器。有关详细用法，请参阅 set_state_dict。

警告：set_optimizer_state_dict 只能在 backward() 之前或: step() 之后调用优化器。否则，优化器状态将无法正确初始化。

参数

model (nn.Module) – 模型的 nn.Module。
optimizers (Union[Optimizer, Iterable[Optimizer]]) – 用于优化 model 的优化器。
optim_state_dict (OptimizerStateType) – OptimizerStateType：要加载的优化器 state_dict。
options (StateDictOptions) – 控制模型 state_dict 和优化器 state_dict 如何加载的选项。有关详细信息，请参阅 StateDictOptions。

返回

无

返回类型

无

class torch.distributed.checkpoint.state_dict.StateDictOptions(full_state_dict=False, cpu_offload=False, ignore_frozen_params=False, keep_submodule_prefixes=True, strict=True, broadcast_from_rank0=False, flatten_optimizer_state_dict=False, dsd_fqn_modifiers='_fqn_modifiers')[源代码]#

这个数据类指定了 get_state_dict/set_state_dict 的工作方式。

full_state_dict：如果设置为 True，则会收集返回 state_dict 中的所有张量。返回的 state_dict 中不会包含 ShardedTensor 和 DTensor。
cpu_offload：将所有张量卸载到 CPU。为防止 CPU OOM，如果 full_state_dict 也为 True，则只有 rank0 会获得 state_dict，而所有其他 rank 将获得空的 state_dict。
ignore_frozen_params：如果值为 True，则返回的 state_dict 不会包含任何冻结的参数（即 requires_grad 为 False）。默认值为 False。
keep_submodule_prefixes (已弃用)：当 submodules 不为 None 时，此选项指示是否保留 state_dict 键中的子模块前缀。例如，如果子模块是 module.pretrain，并且参数的完整 FQN 是 pretrain.layer1.weight。当此选项为 True 时，返回 state_dict 中参数的键将是 pretrain.layer1.weight。如果选项为 False，则键将是 layer1.weight。请注意，如果 keep_submodule_prefixes 为 False，则可能会出现 FQN 冲突，因此 submodules 中应该只有一个子模块。
strict：set_state_dict 调用 model.load_state_dict() 时的 strict 选项。
broadcast_from_rank0：当选项为 True 时，rank0 应接收一个
完整的 state_dict，并将 state_dict/optim_state_dict 中的张量逐一广播到其他 rank。其他 rank 将接收张量并根据模型和优化器中的本地分片进行分片。使用此选项时，**必须**将 full_state_dict 设置为 True。此选项目前仅支持 DTensor，不支持旧版 ShardedTensor。

对于习惯于使用和共享 torch.save 格式的模型的用户，提供了以下方法，这些方法为在格式之间进行转换提供了离线实用程序。

torch.distributed.checkpoint.format_utils.dcp_to_torch_save(dcp_checkpoint_dir, torch_save_path)[源代码]#

给定一个包含 DCP 检查点的目录，此函数将将其转换为 Torch save 文件。

参数

dcp_checkpoint_dir (Union[str, PathLike]) – 包含 DCP 检查点的目录。
torch_save_path (Union[str, PathLike]) – 要存储转换后的 Torch save 文件的文件名。

警告

为避免 OOM，建议仅在一个 rank 上运行此函数。

torch.distributed.checkpoint.format_utils.torch_save_to_dcp(torch_save_path, dcp_checkpoint_dir)[源代码]#

给定一个 Torch save 文件的位置，将其转换为 DCP 检查点。

参数

torch_save_path (Union[str, PathLike]) – Torch save 文件的文件名。
dcp_checkpoint_dir (Union[str, PathLike]) – 用于存储 DCP 检查点的目录。

警告

为避免 OOM，建议仅在一个 rank 上运行此函数。

以下类也可用于从 torch.save 格式进行在线加载和重分片。

class torch.distributed.checkpoint.format_utils.BroadcastingTorchSaveReader(checkpoint_id=None, coordinator_rank=0)[源代码]#

用于读取 Torch Save 文件的 StorageReader。此读取器将在协调器 rank 上读取整个检查点，然后将每个张量广播并分片到所有 rank。

注意：旨在与 DynamicMetaLoadPlanner 一起使用。

警告

当前实现仅支持加载张量。

>>> sd = {"mode": model}
>>> dcp.load(
>>>    sd,
>>>    storage_reader=BroadcastingTorchSaveReader(),
>>>    planner=DynamicMetaLoadPlanner(),
>>>    checkpoint_id="path_to_model.pt"
>>> )

prepare_global_plan(global_plan)[源代码]#

StorageReader 方法的实现。

返回类型: list[torch.distributed.checkpoint.planner.LoadPlan]

prepare_local_plan(plan)[源代码]#

StorageReader 方法的实现。

返回类型: LoadPlan

read_data(plan, planner)[源代码]#

在协调器 rank 上读取 Torch save 数据，然后进行广播。这会产生通信成本，但避免了在每个 rank 上加载整个检查点，从而有望防止 OOM 问题。

返回类型: Future[None]

read_metadata()[源代码]#

扩展了默认的 StorageReader，以支持构建元数据文件。

返回类型: 元数据

reset(checkpoint_id=None)[源代码]#

StorageReader 方法的实现。

set_up_storage_reader(metadata, is_coordinator=False)[源代码]#

StorageReader 方法的实现。

classmethod validate_checkpoint_id(checkpoint_id)[源代码]#

StorageReader 方法的实现。

返回类型: 布尔值

class torch.distributed.checkpoint.format_utils.DynamicMetaLoadPlanner(flatten_state_dict=True, flatten_sharded_tensors=True, allow_partial_load=False)[源代码]#

DefaultLoadPlanner 的扩展，它基于传入的 state dict 创建一个新的 Metadata 对象，避免了从磁盘读取元数据的需要。这在使用没有元数据文件的格式（如 Torch Save 文件）时非常有用。

注意：旨在与 BroadcastingTorchSaveReader 一起使用。

警告

当前实现仅支持加载张量。

>>> sd = {"mode": model}
>>> dcp.load(
>>>    sd,
>>>    storage_reader=BroadcastingTorchSaveReader(),
>>>    planner=DynamicMetaLoadPlanner(),
>>>    checkpoint_id="path_to_model.pt"
>>> )

set_up_planner(state_dict, metadata=None, is_coordinator=False)[源代码]#

设置规划器，通过从 state dict 创建 Metadata 对象来扩展默认行为。

为提高生产环境的可观察性，提供了以下实验性接口。

分布式检查点 - torch.distributed.checkpoint#

其他资源：#

文档

教程

资源