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

分布式检查点 (DCP) 支持从多个进程并行加载和保存模型。它可以处理加载时的数据重新分片，从而能够在一个集群拓扑中保存并在另一个集群拓扑中加载。

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

• 每个检查点会生成多个文件，每个进程至少一个。

• 它是原地操作的，这意味着模型应该先分配其数据，然后 DCP 使用该存储而不是重新分配。

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

torch.distributed.checkpoint.state_dict_saver.save(state_dict, *, checkpoint_id=None, storage_writer=None, planner=None, process_group=None)

以 SPMD 样式保存分布式模型。

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

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

警告

对于已保存的 state_dict，不保证跨 PyTorch 版本的向后兼容性。

警告

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

注意

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

注意

如果没有可用的进程组，则此函数假定目的是在本地进程中保存

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 的实例。如果未指定，则将使用默认规划器。（默认值：None）

• process_group (Optional[ProcessGroup]) – 用于跨rank同步的 ProcessGroup。（默认值：None）

返回值

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

返回类型

Metadata

示例

>>> 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)

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 (可选[StorageWriter]) – 用于执行“暂存”和“保存”的 StorageWriter 实例。如果未指定，DCP 将根据 checkpoint_id 自动推断写入器。如果 checkpoint_id 也为 None，则会引发异常。（默认值：None）

• planner (Optional[SavePlanner]) – SavePlanner 的实例。如果未指定，则将使用默认规划器。（默认值：None）

• process_group (Optional[ProcessGroup]) – 用于跨rank同步的 ProcessGroup。（默认值：None）

返回值

一个包含 save 返回的 Metadata 对象的 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)

此方法已弃用。请切换到“save”。

返回类型

Metadata

torch.distributed.checkpoint.state_dict_loader.load(state_dict, *, checkpoint_id=None, storage_reader=None, planner=None, process_group=None)

以 SPMD 样式加载分布式 state_dict。

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

对于每个 Stateful 对象（同时具有 state_dict 和 load_state_dict），加载将在尝试反序列化之前先调用 state_dict，然后在反序列化完成后调用 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 (可选[StorageReader]) – 用于执行读取的 StorageWriter 实例。如果未指定，DCP 将根据 checkpoint_id 自动推断读取器。如果 checkpoint_id 也为 None，则会引发异常。（默认值：None）

• planner (可选[LoadPlanner]) – LoadPlanner 的实例。如果未指定，则将使用默认规划器。（默认值：None）

• process_group (Optional[ProcessGroup]) – 用于跨rank同步的 ProcessGroup。（默认值：None）

返回值

无。

返回类型

无

示例

>>> 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 使用集合操作来协调跨进程的读取。对于基于 NCCL 的进程组，对象的内部张量表示必须在通信发生之前移动到 GPU 设备上。在这种情况下，使用的设备由 torch.cuda.current_device() 给出，用户有责任通过 torch.cuda.set_device() 确保将其设置为每个进程都有一个独立的 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)

此方法已弃用。请切换到“load”。

以下模块对于异步检查点 (torch.distributed.checkpoint.async_save) 使用的暂存机制的额外自定义也很有用

class torch.distributed.checkpoint.staging.AsyncStager(*args, **kwargs)

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

1. AsyncStager.stage_data(state_dict)

   此调用使 AsyncStager 有机会“暂存”state_dict。 在此上下文中，暂存的预期和目的是创建状态字典的“训练安全”表示形式，这意味着暂存完成后对模块数据的任何更新都不应反映在此方法返回的状态字典中。 例如，在默认情况下，会在 CPU RAM 上创建整个状态字典的副本并在此处返回，允许用户继续训练而不会冒险更改正在序列化的数据。

2. dcp.save 在并行阶段返回的 state_dict 上调用。 此调用负责

   序列化 state_dict 并将其写入存储。

3. 如果 AsyncStager.should_synchronize_after_execute 为 True，则此方法将在

   序列化线程启动后立即调用，并在从 dcp.async_save 返回之前调用。 如果设置为 False，则假设用户已为此目的定义了自定义同步点 进一步优化训练循环中的保存延迟（例如，通过将暂存与前向/后向传递重叠），并且用户有责任在适当的时间调用 AsyncStager.synchronize_staging。

property should_synchronize_after_execute: bool

是否在执行阶段后同步。

stage(state_dict)

返回 state_dict 的“暂存”副本。 对暂存副本的期望是它不受阶段调用完成后发生的任何更新的影响。

返回类型

Dict[str, Union[StatefulT, Any]]

synchronize_staging()

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

class torch.distributed.checkpoint.staging.BlockingAsyncStager(cache_staged_state_dict=False, type_check=False)

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

注意：在这种情况下，synchronize_staging 是一个空操作。

stage(state_dict)

返回 state_dict 在 CPU 上的副本。

返回类型

Dict[str, Union[StatefulT, Any]]

synchronize_staging()

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

除了上述入口点之外，如下所述的 Stateful 对象在保存/加载期间提供额外的自定义 .. automodule:: torch.distributed.checkpoint.stateful

class torch.distributed.checkpoint.stateful.Stateful(*args, **kwargs)

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

load_state_dict(state_dict)

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

参数

state_dict (Dict[str, Any]) – 要从中恢复的状态字典

state_dict()

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

警告

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

返回值

对象状态字典

返回类型

字典

此示例展示了如何使用 Pytorch 分布式检查点来保存 FSDP 模型。

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

class torch.distributed.checkpoint.StorageReader

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

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

子类应该预期 load_state_dict 会按以下顺序调用

0. （所有进程）如果用户传递了有效的 checkpoint_id，则设置 checkpoint_id。

1. （所有进程）read_metadata()

2. （所有进程）set_up_storage_reader()

3. （所有进程）prepare_local_plan()

4. （协调器）prepare_global_plan()

5. （所有进程）read_data()

abstract prepare_global_plan(plans)

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

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

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

参数

plans (列表[LoadPlan]) – LoadPlan 实例的列表，每个进程一个。

返回值

存储全局规划后转换后的 LoadPlan 列表

返回类型

列表[LoadPlan]

abstract prepare_local_plan(plan)

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

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

参数

plan (LoadPlan) – 使用中的 LoadPlan 中的本地计划。

返回值

存储本地规划后转换后的 LoadPlan

返回类型

LoadPlan

abstract read_data(plan, planner)

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

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

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

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

参数

• plan (LoadPlan) – 要在本地执行的计划

• planner (LoadPlanner) – 用于解析项目的规划器对象。

返回值

所有读取完成后，此 Future 即完成。

返回类型

Future[None]

abstract read_metadata()

读取检查点元数据。

返回值

与正在加载的检查点关联的元数据对象。

返回类型

Metadata

abstract reset(checkpoint_id=None)

调用此方法表示即将进行全新的检查点读取。如果用户为此检查点读取设置了 checkpoint_id，则可能会存在 checkpoint_id。checkpiont_id 的含义取决于存储。它可以是文件夹/文件的路径或键值存储的键。

参数

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

abstract set_up_storage_reader(metadata, is_coordinator)

初始化此实例。

参数

• metadata (Metadata) – 要使用的元数据模式。

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

abstract classmethod validate_checkpoint_id(checkpoint_id)

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

返回类型

bool

class torch.distributed.checkpoint.StorageWriter

由 save_state_dict 用于写入存储的接口。

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

子类应该预料到以下调用序列。

0. （所有进程）如果用户传递了有效的 checkpoint_id，则设置 checkpoint_id。

1. (所有进程) set_up_storage_writer()

2. （所有进程）prepare_local_plan()

3. （协调器）prepare_global_plan()

4. (所有进程) write_data()

5. (协调器) finish()

abstract finish(metadata, results)

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

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

参数

• metadata (Metadata) – 新检查点的元数据

• results (列表[列表[WriteResult]]) – 来自所有进程的 WriteResults 列表。

返回值

无

返回类型

无

abstract prepare_global_plan(plans)

执行存储的集中式规划。

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

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

参数

plans (列表[SavePlan]) – SavePlan 实例列表，每个进程一个。

返回值

存储全局规划后转换后的 SavePlan 列表

返回类型

列表[SavePlan]

abstract prepare_local_plan(plan)

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

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

参数

plan (SavePlan) – 使用中的 SavePlanner 的本地计划。

返回值

存储本地规划后转换后的 SavePlan

返回类型

SavePlan

abstract reset(checkpoint_id=None)

调用该函数表示将要进行一次全新的检查点写入。如果用户为此检查点写入设置了 checkpoint_id，则可能会存在 checkpoint_id。checkpiont_id 的含义取决于存储。它可以是文件夹/文件的路径，也可以是键值存储的键。

参数

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

abstract set_up_storage_writer(is_coordinator)

初始化此实例。

参数

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

storage_meta()

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

TODO: 提供一个例子

返回类型

可选[StorageMeta]

abstract classmethod validate_checkpoint_id(checkpoint_id)

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

返回类型

bool

abstract write_data(plan, planner)

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

子类应该在计划中的每个项目上调用 SavePlanner::resolve_data 以访问要写入的底层对象。

子类应该延迟调用 resolve_data，因为它可能会分配内存。对于张量，请做出以下假设

• 它们可能位于任何设备上，包括与 WriteItem::tensor_data 上的设备不匹配的设备

• 它们可能是视图或不连续的。只需要保存投影。

参数

• plan (SavePlan) – 要执行的保存计划。

• planner (SavePlanner) – 用于将项目解析为数据的 Planner 对象。

返回值

一个 Future，它完成到 WriteResult 列表

返回类型

Future[列表[WriteResult]]

以下类型定义了在检查点期间使用的规划器接口

class torch.distributed.checkpoint.LoadPlanner

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

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

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

规划器子类可以在 load_state_dict 期间预期以下调用序列

1. set_up_planner - 在所有进程上调用。

   指示开始加载检查点。

2. create_local_plan - 在所有进程上调用。

   处理 state_dict 并生成将发送用于全局规划的 LoadPlan。

3. create_global_plan - 仅在协调器进程上调用。

   获取所有进程的 LoadPlan 并做出任何全局决策。

4. load_bytes - 在每个进程上多次调用

   每次在 state_dict 中出现非张量值时都会调用此方法。

5. resolve_tensor 和 commit_tensor - 在每个进程上多次调用

   它们会针对 state_dict 中的每个张量值成对调用。

建议用户扩展 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)

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

提供的张量与调用 resolve_tensor 返回的张量相同。仅当此 LoadPlanner 需要在将 tensor 复制回 state_dict 中的张量之前对其进行后处理时，才需要此方法。

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

abstract create_global_plan(global_plan)

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

注意：这仅在协调器进程上调用

返回类型

列表[LoadPlan]

abstract create_local_plan()

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

注意：这在每个进程上调用。

返回类型

LoadPlan

abstract finish_plan(central_plan)

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

返回类型

LoadPlan

abstract load_bytes(read_item, value)

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

此方法预期会修改底层 state_dict。

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

resolve_bytes(read_item)

返回 StorageReader 用于加载 read_item 的 BytesIO。

BytesIO 应与底层 state_dict 上的一个别名，因为 StorageReader 将替换其内容。

返回类型

BytesIO

abstract resolve_tensor(read_item)

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

该张量应与底层 state_dict 上的一个张量别名，因为 StorageReader 将替换其内容。如果由于某种原因无法做到这一点，规划器可以使用 commit_tensor 方法将数据复制回 state_dict 中的张量。

返回类型

张量

abstract set_up_planner(state_dict, metadata=None, is_coordinator=False)

初始化此实例以将数据加载到 state_dict 中。

注意：这在每个进程上调用。

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

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)

class torch.distributed.checkpoint.SavePlanner

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

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

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

planner 子类可以预期在 save_state_dict 期间按以下顺序调用

1. set_up_planner - 在所有进程上调用。

   标志着检查点保存的开始。

2. create_local_plan - 在所有进程上调用。

   处理 state_dict 并生成将发送用于全局规划的 SavePlan。

3. create_global_plan - 仅在协调器进程上调用。

   获取所有等级的 SavePlan 并做出任何全局决策。

4. finish_plan - 在所有等级上调用。

   这使每个等级都有机会调整全局规划决策。

5. resolve_data - 在每个等级上多次调用

   在 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)

使用全局规划步骤做出每个进程无法单独做出的集中决策。

>>> 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)

最后，一些规划器需要在检查点中保存额外的元数据，这是通过让每个进程贡献其在本地计划中的数据项，然后由全局规划器聚合它们来实现的。

>>> 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)

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

这仅在协调器进程上调用。

返回类型

元组[列表[SavePlan], 元数据]

abstract create_local_plan()

计算当前进程的保存计划。

这将被聚合并传递给 create_global_plan。特定于规划器的数据可以通过 SavePlan::planner_data 传递。

这将在所有进程上调用。

返回类型

SavePlan

abstract finish_plan(new_plan)

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

这将在所有进程上调用。

返回类型

SavePlan

abstract resolve_data(write_item)

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

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

在每个进程上多次调用，至少在最终 SavePlan 中每个 WriteItem 调用一次。

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

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

返回张量时，它们可以在任何设备或格式上，也可以是视图。弄清楚如何保存它们是存储层的责任。

返回类型

Union[Tensor, BytesIO]

abstract set_up_planner(state_dict, storage_meta=None, is_coordinator=False)

初始化此规划器以保存 state_dict。

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

这将在所有进程上调用。

class torch.distributed.checkpoint.SavePlan(items: List[torch.distributed.checkpoint.planner.WriteItem], storage_data: Any = None, planner_data: Any = None)

class torch.distributed.checkpoint.planner.WriteItem(index, type, tensor_data=None)

数据类，包含需要写入存储的信息。

tensor_storage_size()

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

返回值

Optional[int] 存储大小，以字节为单位，如果存在底层张量。

返回类型

Optional[int]

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

类 torch.distributed.checkpoint.FileSystemReader(path)

属性 checkpoint_id: Union[str, PathLike]

返回将用于加载检查点的 checkpoint_id。

类 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)

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

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

• 检查点路径是一个空目录或不存在的目录。

• 文件创建是原子的

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

stage(state_dict)

AsyncStager.stage 的重写

返回类型

Dict[str, Union[StatefulT, Any]]

我们提供了 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)

lookup_object(index)

从规划器接口扩展，以便轻松扩展默认规划器。

返回类型

任何

transform_object(write_item, object)

从规划器接口扩展，以便轻松扩展默认规划器。

class torch.distributed.checkpoint.DefaultLoadPlanner(flatten_state_dict=True, flatten_sharded_tensors=True, allow_partial_load=False)

在 LoadPlanner 之上添加多个功能的 DefaultLoadPlanner。

特别地，它添加了以下内容

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

lookup_tensor(index)

从规划器接口扩展，以便轻松扩展默认规划器。

返回类型

张量

transform_tensor(read_item, tensor)

从规划器接口扩展，以便轻松扩展默认规划器。

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

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

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

请注意，此功能是实验性的，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。 2.) 隐藏特定于并行性的 state_dict API。用户不必调用这些 API。 3.) 对结果 state_dict 进行完整性检查。

结果状态字典的键是规范的 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 的优化器。

• 子模块 (已弃用) – 可选[Set[nn.Module]]：仅返回属于子模块的模型参数。

• 选项 (StateDictOptions) – 控制如何返回模型 state_dict 和优化器 state_dict 的选项。有关详细信息，请参阅 StateDictOptions。

返回值

元组，包含模型 state_dict 和优化器 state_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。

• 子模块 (已弃用) – 可选[Set[nn.Module]]：仅返回属于子模块的模型参数。

• 选项 (StateDictOptions) – 控制如何返回模型 state_dict 和优化器 state_dict 的选项。有关详细信息，请参阅 StateDictOptions。

返回值

model 的 state_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 的优化器。

• 子模块 (已弃用) – 可选[Set[nn.Module]]：仅返回属于子模块的模型参数。

• 选项 (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。

参数

• 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 是一个 str 列表，包含模型 state_dict 中缺少的键。

• unexpected_keys 是一个 str 列表，包含模型 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 是一个 str 列表，包含缺少的键

• unexpected_keys 是一个 str 列表，包含意外的键

返回类型

带有 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。

参数

• 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)

此数据类指定 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 保存文件。

参数

• dcp_checkpoint_dir (Union[str, PathLike]) – 包含 DCP 检查点的目录。

• torch_save_path (Union[str, PathLike]) – 存储转换后的 Torch 保存文件的文件名。

警告

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

torch.distributed.checkpoint.format_utils.torch_save_to_dcp(torch_save_path, dcp_checkpoint_dir)

给定 torch 保存文件的位置，将其转换为 DCP 检查点。

参数

• torch_save_path (Union[str, PathLike]) – Torch 保存文件的文件名。

• 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。此读取器将在协调器进程上读取整个检查点，然后将每个张量广播并分片到所有进程。

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

警告

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

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

prepare_global_plan(global_plan)

StorageReader 方法的实现

返回类型

列表[LoadPlan]

prepare_local_plan(plan)

StorageReader 方法的实现

返回类型

LoadPlan

read_data(plan, planner)

在协调器进程上读取 torch save 数据，然后广播，这会产生通信成本，但避免了在每个进程上加载整个检查点，希望可以防止 OOM 问题

返回类型

Future[None]

read_metadata()

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

返回类型

Metadata

reset(checkpoint_id=None)

StorageReader 方法的实现

set_up_storage_reader(metadata, is_coordinator)

StorageReader 方法的实现

classmethod validate_checkpoint_id(checkpoint_id)

StorageReader 方法的实现

返回类型

bool

class torch.distributed.checkpoint.format_utils.DynamicMetaLoadPlanner(flatten_state_dict=True, flatten_sharded_tensors=True, allow_partial_load=False)

DefaultLoadPlanner 的扩展，它根据传入的状态字典创建一个新的元数据对象，避免了从磁盘读取元数据的需要。这在读取没有元数据文件的格式（如 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)

设置规划器，通过从状态字典创建元数据对象来扩展默认行为

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