FullyShardedDataParallel

创建于: 2022年02月02日 | 最后更新于: 2025年06月11日

class torch.distributed.fsdp.FullyShardedDataParallel(module, process_group=None, sharding_strategy=None, cpu_offload=None, auto_wrap_policy=None, backward_prefetch=BackwardPrefetch.BACKWARD_PRE, mixed_precision=None, ignored_modules=None, param_init_fn=None, device_id=None, sync_module_states=False, forward_prefetch=False, limit_all_gathers=True, use_orig_params=False, ignored_states=None, device_mesh=None)

一个用于在数据并行工作进程之间分片模块参数的包装器。

这受到 Xu et al. 以及 DeepSpeed 的 ZeRO Stage 3 的启发。FullyShardedDataParallel 通常缩写为 FSDP。

示例

>>> import torch
>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> torch.cuda.set_device(device_id)
>>> sharded_module = FSDP(my_module)
>>> optim = torch.optim.Adam(sharded_module.parameters(), lr=0.0001)
>>> x = sharded_module(x, y=3, z=torch.Tensor([1]))
>>> loss = x.sum()
>>> loss.backward()
>>> optim.step()

使用 FSDP 涉及包装你的模块，然后在之后初始化你的优化器。这是必需的，因为 FSDP 会更改参数变量。

在设置 FSDP 时，你需要考虑目标 CUDA 设备。如果设备有 ID (dev_id)，你有三种选择：

• 将模块放置在该设备上

• 使用 torch.cuda.set_device(dev_id) 设置设备

• 将 dev_id 传递给 device_id 构造函数参数。

这确保了 FSDP 实例的计算设备是目标设备。对于选项 1 和 3，FSDP 初始化始终在 GPU 上进行。对于选项 2，FSDP 初始化发生在模块的当前设备上，该设备可能是 CPU。

如果你正在使用 sync_module_states=True 标志，你需要确保模块在 GPU 上，或者使用 device_id 参数指定一个 FSDP 将在 FSDP 构造函数中移动模块到的 CUDA 设备。这是必需的，因为 sync_module_states=True 需要 GPU 通信。

FSDP 还会负责将输入张量移动到前向方法中，以便进行 GPU 计算，因此你无需手动将它们从 CPU 移动。

对于 use_orig_params=True，ShardingStrategy.SHARD_GRAD_OP 会暴露未分片的参数，而不是前向计算后的分片参数，这与 ShardingStrategy.FULL_SHARD 不同。如果你想检查梯度，可以使用带有 with_grads=True 的 summon_full_params 方法。

当 limit_all_gathers=True 时，你可能会在 FSDP 前向计算之前看到 CPU 线程没有发出任何内核的间隙。这是故意的，它显示了速率限制器的作用。以这种方式同步 CPU 线程可以防止为后续的 all-gather 过度分配内存，并且实际上不会延迟 GPU 内核的执行。

出于与 autograd 相关的原因，FSDP 会在前向和后向计算期间将受管理模块的参数替换为 torch.Tensor 视图。如果你的模块的前向计算依赖于保存的参数引用而不是在每次迭代时重新获取引用，那么它将看不到 FSDP 新创建的视图，autograd 也将无法正常工作。

最后，当使用 sharding_strategy=ShardingStrategy.HYBRID_SHARD 并将分片进程组设置为节点内（intra-node），将复制进程组设置为节点间（inter-node）时，设置 NCCL_CROSS_NIC=1 可以帮助提高某些集群设置中复制进程组上的 all-reduce 时间。

限制

在使用 FSDP 时，有几点限制需要注意：

• 在使用 CPU 卸载时，FSDP 目前不支持 no_sync() 之外的梯度累积。这是因为 FSDP 使用新近减少的梯度，而不是与任何现有梯度累积，这可能导致不正确的结果。

• FSDP 不支持运行位于 FSDP 实例内的子模块的前向传递。这是因为子模块的参数将被分片，但子模块本身不是 FSDP 实例，因此其前向传递不会适当地 all-gather 完整的参数。

• FSDP 由于其后向钩注册方式，无法与双反向传播（double backwards）一起工作。

• FSDP 在冻结参数方面存在一些约束。对于 use_orig_params=False，每个 FSDP 实例必须管理全部冻结或全部非冻结的参数。对于 use_orig_params=True，FSDP 支持混合冻结和非冻结参数，但建议避免这样做，以防止高于预期的梯度内存使用。

• 从 PyTorch 1.12 开始，FSDP 对共享参数的支持有限。如果你的用例需要增强的共享参数支持，请在该 issue 中发帖。

• 你应该避免在不使用 summon_full_params 上下文的情况下修改前向和后向之间的参数，因为修改可能不会持久。

参数

• module (nn.Module) – 这是需要用 FSDP 包装的模块。

• process_group (Optional[Union[ProcessGroup, Tuple[ProcessGroup, ProcessGroup]]]) – 这是模型分片的进程组，因此也是 FSDP 的 all-gather 和 reduce-scatter 集合通信所使用的进程组。如果为 None，则 FSDP 使用默认进程组。对于混合分片策略，例如 ShardingStrategy.HYBRID_SHARD，用户可以传入一个进程组元组，分别代表分片和复制的组。如果为 None，则 FSDP 会为用户构建进程组，用于节点内分片和节点间复制。（默认：None）

• sharding_strategy (Optional[ShardingStrategy]) – 这配置了分片策略，可能在内存节省和通信开销之间进行权衡。有关详细信息，请参阅 ShardingStrategy。（默认：FULL_SHARD）

• cpu_offload (Optional[CPUOffload]) – 这配置了 CPU 卸载。如果设置为 None，则不发生 CPU 卸载。有关详细信息，请参阅 CPUOffload。（默认：None）

• auto_wrap_policy (Optional[Union[Callable[[nn.Module, bool, int], bool], ModuleWrapPolicy, CustomPolicy]]) –

  这指定了一个策略，用于将 FSDP 应用于 module 的子模块，这对于通信和计算重叠是必需的，因此会影响性能。如果为 None，则 FSDP 只应用于 module，用户应手动将 FSDP 应用于父模块（自底向上进行）。为了方便起见，此参数直接接受 ModuleWrapPolicy，它允许用户指定要包装的模块类（例如，Transformer 块）。否则，它应该是一个可调用对象，接受三个参数 module: nn.Module, recurse: bool, 和 nonwrapped_numel: int，并返回一个 bool，指定是否应将 FSDP 应用于传入的 module（如果 recurse=False），或者如果遍历应该继续到模块的子树（如果 recurse=True）。用户可以为可调用对象添加其他参数。torch.distributed.fsdp.wrap.py 中的 size_based_auto_wrap_policy 是一个示例可调用对象，当其子树中的参数超过 1 亿个 numel 时，它会将 FSDP 应用于模块。我们建议在应用 FSDP 后打印模型并根据需要进行调整。

  示例

  >>> def custom_auto_wrap_policy(
  >>>     module: nn.Module,
  >>>     recurse: bool,
  >>>     nonwrapped_numel: int,
  >>>     # Additional custom arguments
  >>>     min_num_params: int = int(1e8),
  >>> ) -> bool:
  >>>     return nonwrapped_numel >= min_num_params
  >>> # Configure a custom `min_num_params`
  >>> my_auto_wrap_policy = functools.partial(custom_auto_wrap_policy, min_num_params=int(1e5))
  

• backward_prefetch (Optional[BackwardPrefetch]) – 这配置了显式的后向 all-gather 预取。如果为 None，则 FSDP 不进行后向预取，并且在后向传递中没有通信和计算重叠。有关详细信息，请参阅 BackwardPrefetch。（默认：BACKWARD_PRE）

• mixed_precision (Optional[MixedPrecision]) – 这配置了 FSDP 的原生混合精度。如果设置为 None，则不使用混合精度。否则，可以设置参数、缓冲区和梯度减少的 dtype。有关详细信息，请参阅 MixedPrecision。（默认：None）

• ignored_modules (Optional[Iterable[torch.nn.Module]]) – 模块本身及其子模块的参数和缓冲区将被此实例忽略。直接位于 ignored_modules 中的任何模块都不应是 FullyShardedDataParallel 实例，并且任何已经是已构造的 FullyShardedDataParallel 实例的子模块都不会被忽略（如果它们嵌套在此实例下）。此参数可用于避免在为模块粒度使用 auto_wrap_policy 或当参数的分片不由 FSDP 管理时，忽略特定参数。（默认：None）

• param_init_fn (Optional[Callable[[nn.Module], None]]) –

  一个 Callable[torch.nn.Module] -> None，指定如何将当前位于 meta 设备上的模块初始化到实际设备。从 v1.12 开始，FSDP 通过 is_meta 检测具有 meta 设备上的参数或缓冲区的模块，并根据是否指定了 param_init_fn 来应用它，或者调用 nn.Module.reset_parameters()。在这两种情况下，实现都应该*只*初始化模块的参数/缓冲区，而不是其子模块的。这是为了避免重新初始化。此外，FSDP 还支持通过 torchdistX（pytorch/torchdistX）的 deferred_init() API 进行延迟初始化，其中延迟模块通过调用 param_init_fn（如果指定）或 torchdistX 的默认 materialize_module() 来初始化。如果指定了 param_init_fn，则它将应用于所有 meta 设备上的模块，这意味着它可能需要根据模块类型进行条件判断。FSDP 在参数展平（flattening）和分片（sharding）之前调用初始化函数。

  示例

  >>> module = MyModule(device="meta")
  >>> def my_init_fn(module: nn.Module):
  >>>     # E.g. initialize depending on the module type
  >>>     ...
  >>> fsdp_model = FSDP(module, param_init_fn=my_init_fn, auto_wrap_policy=size_based_auto_wrap_policy)
  >>> print(next(fsdp_model.parameters()).device) # current CUDA device
  >>> # With torchdistX
  >>> module = deferred_init.deferred_init(MyModule, device="cuda")
  >>> # Will initialize via deferred_init.materialize_module().
  >>> fsdp_model = FSDP(module, auto_wrap_policy=size_based_auto_wrap_policy)
  

• device_id (Optional[Union[int, torch.device]]) – 一个 int 或 torch.device，指定 FSDP 初始化发生的 CUDA 设备，包括必要的模块初始化和参数分片。如果 module 在 CPU 上，应指定此参数以提高初始化速度。如果设置了默认 CUDA 设备（例如，通过 torch.cuda.set_device），则用户可以将其传递给此参数。（默认：None）

• sync_module_states (bool) – 如果为 True，则每个 FSDP 模块将从 rank 0 广播模块参数和缓冲区，以确保它们在 ranks 之间复制（增加了构造函数的通信开销）。这有助于以内存高效的方式加载 state_dict 检查点，例如通过 load_state_dict。有关示例，请参阅 FullStateDictConfig。（默认：False）

• forward_prefetch (bool) – 如果为 True，则 FSDP 会在当前前向计算之前*显式*预取下一个前向 all-gather。这仅对 CPU 密集型工作负载有用，在这种情况下，更早地发出下一个 all-gather 可以改善重叠。这应该只用于静态图模型，因为预取遵循第一次迭代的执行顺序。（默认：False）

• limit_all_gathers (bool) – 如果为 True，则 FSDP 会显式同步 CPU 线程，以确保 GPU 内存使用仅限于*两个*连续的 FSDP 实例（当前正在执行计算的实例和正在预取的下一个实例的 all-gather）。如果为 False，则 FSDP 允许 CPU 线程在没有任何额外同步的情况下发出 all-gathers。（默认：True）我们经常称此功能为“速率限制器”。此标志应仅在特定 CPU 密集型工作负载且内存压力较低时设置为 False，此时 CPU 线程可以积极发出所有内核，而不必担心 GPU 内存使用。

• use_orig_params (bool) – 将此设置为 True 会使 FSDP 使用 module 的原始参数。FSDP 通过 nn.Module.named_parameters() 向用户公开这些原始参数，而不是 FSDP 内部的 FlatParameter。这意味着优化器步进在原始参数上运行，从而实现每个原始参数的超参数。FSDP 保留原始参数变量，并在未分片和分片形式之间操纵它们的数据，其中它们始终是底层未分片或分片的 FlatParameter 的视图。使用当前算法，分片形式始终是 1D 的，丢失了原始张量结构。一个原始参数在给定 rank 上可能具有全部、部分或无数据。在无数据的情况下，其数据将类似于大小为 0 的空张量。用户不应编写依赖于给定原始参数在分片形式中存在数据的程序。True 是使用 torch.compile() 所必需的。将此设置为 False 会通过 nn.Module.named_parameters() 向用户公开 FSDP 的内部 FlatParameter。（默认：False）

• ignored_states (Optional[Iterable[torch.nn.Parameter], Optional[Iterable[torch.nn.Module]]) – 被此 FSDP 实例忽略的参数或模块，这意味着参数不会被分片，其梯度也不会在 ranks 之间减少。此参数与现有的 ignored_modules 参数统一，我们可能会很快弃用 ignored_modules。为了向后兼容，我们同时保留 ignored_states 和 ignored_modules`，但 FSDP 只允许其中一个被指定为非 None。

• device_mesh (Optional[DeviceMesh]) – DeviceMesh 可以作为 process_group 的替代品。当传入 device_mesh 时，FSDP 将使用底层进程组进行 all-gather 和 reduce-scatter 集合通信。因此，这两个参数需要互斥。对于混合分片策略，例如 ShardingStrategy.HYBRID_SHARD，用户可以传入一个 2D DeviceMesh 而不是一个进程组元组。对于 2D FSDP + TP，用户需要传入 device_mesh 而不是 process_group。有关更多 DeviceMesh 信息，请访问：https://pytorch.ac.cn/tutorials/recipes/distributed_device_mesh.html

apply(fn)

将 fn 递归应用于每个子模块（由 .children() 返回）以及自身。

典型用法包括初始化模型的参数（另请参阅 torch.nn.init）。

与 torch.nn.Module.apply 相比，此版本在应用 fn 之前额外收集了完整参数。不应在另一个 summon_full_params 上下文内调用它。

参数

fn (Module -> None) – 要应用于每个子模块的函数

返回

self

返回类型

模块

check_is_root()

检查此实例是否为根 FSDP 模块。

返回类型

布尔值

clip_grad_norm_(max_norm, norm_type=2.0)

裁剪所有参数的梯度范数。

范数在所有参数的梯度上计算，这些梯度被视为一个单一向量，并且梯度会就地修改。

参数

• max_norm (float or int) – 梯度的最大范数

• norm_type (float or int) – 使用的 p-范数的类型。可以是 'inf' 表示无穷范数。

返回

参数的总范数（视为一个单一向量）。

返回类型

张量

如果每个 FSDP 实例使用 NO_SHARD，即没有梯度在 ranks 之间分片，那么你可以直接使用 torch.nn.utils.clip_grad_norm_()。

如果至少有一个 FSDP 实例使用分片策略（即非 NO_SHARD），那么你应该使用此方法而不是 torch.nn.utils.clip_grad_norm_()，因为此方法处理了梯度在 ranks 之间分片的事实。

返回的总范数将具有所有参数/梯度中“最大”的 dtype，根据 PyTorch 的类型提升语义定义。例如，如果*所有*参数/梯度都使用低精度 dtype，则返回的范数的 dtype 将是该低精度 dtype，但如果至少存在一个参数/梯度使用 FP32，则返回的范数的 dtype 将是 FP32。

警告

这需要在所有 ranks 上调用，因为它使用了集合通信。

static flatten_sharded_optim_state_dict(sharded_optim_state_dict, model, optim)

展平（Flatten）分片的优化器状态字典。

该 API 与 shard_full_optim_state_dict() 类似。唯一的区别是输入的 sharded_optim_state_dict 应该由 sharded_optim_state_dict() 返回。因此，将会有 all-gather 调用，在每个 rank 上收集 ShardedTensor。

参数

• sharded_optim_state_dict (Dict[str, Any]) – 对应于未展平参数的优化器状态字典，并包含分片的优化器状态。

• model (torch.nn.Module) – 参见 shard_full_optim_state_dict()。

• optim (torch.optim.Optimizer) – model 参数的优化器。

返回

参见 shard_full_optim_state_dict()。

返回类型

dict[str, Any]

forward(*args, **kwargs)

运行包装模块的前向传递，插入 FSDP 特定的前向和后向分片逻辑。

返回类型

任何

static fsdp_modules(module, root_only=False)

返回所有嵌套的 FSDP 实例。

这可能包括 module 本身，并且只有在 root_only=True 时才包括 FSDP 根模块。

参数

• module (torch.nn.Module) – 根模块，它可能是一个 FSDP 模块，也可能不是。

• root_only (bool) – 是否只返回 FSDP 根模块。（默认：False）

返回

嵌套在输入 module 中的 FSDP 模块。

返回类型

List[FullyShardedDataParallel]

static full_optim_state_dict(model, optim, optim_input=None, rank0_only=True, group=None)

返回完整的优化器状态字典。

在 rank 0 上合并完整的优化器状态，并将其作为 dict 返回，遵循 torch.optim.Optimizer.state_dict() 的约定，即带有键 "state" 和 "param_groups"。包含在 model 中的 FSDP 模块中的展平参数被映射回其未展平的参数。

这需要在所有 ranks 上调用，因为它使用了集合通信。但是，如果 rank0_only=True，则状态字典仅在 rank 0 上填充，而所有其他 ranks 返回一个空的 dict。

与 torch.optim.Optimizer.state_dict() 不同，此方法使用完整的参数名称作为键，而不是参数 ID。

与 torch.optim.Optimizer.state_dict() 一样，优化器状态字典中包含的张量不会被克隆，因此可能会出现别名陷阱。为了最佳实践，请考虑立即保存返回的优化器状态字典，例如使用 torch.save()。

参数

• model (torch.nn.Module) – 根模块（可能是一个 FullyShardedDataParallel 实例，也可能不是），其参数已传入优化器 optim。

• optim (torch.optim.Optimizer) – model 参数的优化器。

• optim_input (Optional[Union[List[Dict[str, Any]], Iterable[torch.nn.Parameter]]]) – 传入优化器的参数，表示参数组列表或参数的可迭代对象；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传递它。（默认：None）

• rank0_only (bool) – 如果为 True，则仅在 rank 0 上保存填充的 dict；如果为 False，则在所有 ranks 上保存。（默认：True）

• group (dist.ProcessGroup) – 模型的进程组或 None，如果使用默认进程组。（默认：None）

返回

一个 dict，包含 model 的优化器状态。优化器状态的分片基于 state_dict_type。

返回类型

Dict[str, Any]

static get_state_dict_type(module)

获取 module 的 FSDP 模块后代的所有 state_dict_type 以及相应的配置。

目标模块不必是 FSDP 模块。

返回

一个 StateDictSettings，包含当前设置的 state_dict_type 和 state_dict / optim_state_dict 配置。

引发

• AssertionError` if the StateDictSettings for differen –

• FSDP submodules differ. –

返回类型

StateDictSettings

property module: Module

返回包装的模块。

named_buffers(*args, **kwargs)

返回模块缓冲区的迭代器，生成缓冲区的名称和缓冲区本身。

在 summon_full_params() 上下文管理器内部，会拦截缓冲区名称并移除 FSDP 特定的展平缓冲区前缀的所有出现。

返回类型

Iterator[tuple[str, torch.Tensor]]

named_parameters(*args, **kwargs)

返回模块参数的迭代器，生成参数的名称和参数本身。

拦截参数名称，并在 summon_full_params() 上下文管理器内部，移除 FSDP 特定的展平参数前缀的所有出现。

返回类型

Iterator[tuple[str, torch.nn.parameter.Parameter]]

no_sync()

禁用 FSDP 实例之间的梯度同步。

在此上下文内，梯度将累积在模块变量中，稍后将在退出上下文后的第一个前向-后向传递中进行同步。这应该只在根 FSDP 实例上使用，并将递归应用于所有子 FSDP 实例。

注意

这可能会导致更高的内存使用，因为 FSDP 将累积完整的模型梯度（而不是梯度分片），直到最终同步。

注意

当与 CPU 卸载一起使用时，梯度在上下文管理器内部不会卸载到 CPU。相反，它们只会在最终同步后立即卸载。

返回类型

生成器

static optim_state_dict(model, optim, optim_state_dict=None, group=None)

转换分片模型的优化器状态字典。

给定的状态字典可以转换为三种类型之一：1）完整的优化器状态字典，2）分片优化器状态字典，3）本地优化器状态字典。

对于完整的优化器状态字典，所有状态都未展平且未分片。可以通过 state_dict_type() 指定仅 rank0 和仅 CPU 来避免 OOM。

对于分片优化器状态字典，所有状态都未展平但已分片。可以通过 state_dict_type() 指定仅 CPU 来进一步节省内存。

对于本地状态字典，不进行转换。但是，状态将从 nn.Tensor 转换为 ShardedTensor 以表示其分片性质（这尚未支持）。

示例

>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> from torch.distributed.fsdp import StateDictType
>>> from torch.distributed.fsdp import FullStateDictConfig
>>> from torch.distributed.fsdp import FullOptimStateDictConfig
>>> # Save a checkpoint
>>> model, optim = ...
>>> FSDP.set_state_dict_type(
>>>     model,
>>>     StateDictType.FULL_STATE_DICT,
>>>     FullStateDictConfig(rank0_only=False),
>>>     FullOptimStateDictConfig(rank0_only=False),
>>> )
>>> state_dict = model.state_dict()
>>> optim_state_dict = FSDP.optim_state_dict(model, optim)
>>> save_a_checkpoint(state_dict, optim_state_dict)
>>> # Load a checkpoint
>>> model, optim = ...
>>> state_dict, optim_state_dict = load_a_checkpoint()
>>> FSDP.set_state_dict_type(
>>>     model,
>>>     StateDictType.FULL_STATE_DICT,
>>>     FullStateDictConfig(rank0_only=False),
>>>     FullOptimStateDictConfig(rank0_only=False),
>>> )
>>> model.load_state_dict(state_dict)
>>> optim_state_dict = FSDP.optim_state_dict_to_load(
>>>     model, optim, optim_state_dict
>>> )
>>> optim.load_state_dict(optim_state_dict)

参数

• model (torch.nn.Module) – 根模块（可能是一个 FullyShardedDataParallel 实例，也可能不是），其参数已传入优化器 optim。

• optim (torch.optim.Optimizer) – model 参数的优化器。

• optim_state_dict (Dict[str, Any]) – 要转换的目标优化器状态字典。如果值为 None，则使用 optim.state_dict()。（默认：None）

• group (dist.ProcessGroup) – 模型跨其参数分片的进程组，或者在使用默认进程组时为 None。（默认：None）

返回

一个 dict，包含 model 的优化器状态。优化器状态的分片基于 state_dict_type。

返回类型

Dict[str, Any]

static optim_state_dict_to_load(model, optim, optim_state_dict, is_named_optimizer=False, load_directly=False, group=None)

将优化器状态字典转换为可以加载到与 FSDP 模型关联的优化器中的格式。

给定一个通过 optim_state_dict() 转换的 optim_state_dict，它被转换为展平的优化器状态字典，可以加载到 optim 中，而 optim 是 model 的优化器。model 必须由 FullyShardedDataParallel 分片。

>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> from torch.distributed.fsdp import StateDictType
>>> from torch.distributed.fsdp import FullStateDictConfig
>>> from torch.distributed.fsdp import FullOptimStateDictConfig
>>> # Save a checkpoint
>>> model, optim = ...
>>> FSDP.set_state_dict_type(
>>>     model,
>>>     StateDictType.FULL_STATE_DICT,
>>>     FullStateDictConfig(rank0_only=False),
>>>     FullOptimStateDictConfig(rank0_only=False),
>>> )
>>> state_dict = model.state_dict()
>>> original_osd = optim.state_dict()
>>> optim_state_dict = FSDP.optim_state_dict(
>>>     model,
>>>     optim,
>>>     optim_state_dict=original_osd
>>> )
>>> save_a_checkpoint(state_dict, optim_state_dict)
>>> # Load a checkpoint
>>> model, optim = ...
>>> state_dict, optim_state_dict = load_a_checkpoint()
>>> FSDP.set_state_dict_type(
>>>     model,
>>>     StateDictType.FULL_STATE_DICT,
>>>     FullStateDictConfig(rank0_only=False),
>>>     FullOptimStateDictConfig(rank0_only=False),
>>> )
>>> model.load_state_dict(state_dict)
>>> optim_state_dict = FSDP.optim_state_dict_to_load(
>>>     model, optim, optim_state_dict
>>> )
>>> optim.load_state_dict(optim_state_dict)

参数

• model (torch.nn.Module) – 根模块（可能是一个 FullyShardedDataParallel 实例，也可能不是），其参数已传入优化器 optim。

• optim (torch.optim.Optimizer) – model 参数的优化器。

• optim_state_dict (Dict[str, Any]) – 要加载的优化器状态。

• is_named_optimizer (bool) – 这个优化器是 NamedOptimizer 还是 KeyedOptimizer。仅当 optim 是 TorchRec 的 KeyedOptimizer 或 torch.distributed 的 NamedOptimizer 时才设置为 True。

• load_directly (bool) – 如果设置为 True，此 API 还将在返回结果之前调用 optim.load_state_dict(result)。否则，用户负责调用 optim.load_state_dict()。（默认：False）

• group (dist.ProcessGroup) – 模型跨其参数分片的进程组，或者在使用默认进程组时为 None。（默认：None）

返回类型

dict[str, Any]

register_comm_hook(state, hook)

注册一个通信钩子。

这是一个增强功能，为用户提供了一个灵活的钩子，他们可以在其中指定 FSDP 如何聚合多个工作进程的梯度。此钩子可用于实现几种算法，例如 GossipGrad 和梯度压缩，这些算法在与 FullyShardedDataParallel 训练时涉及不同的参数同步通信策略。

警告

FSDP 通信钩子应在运行初始前向传递之前注册，并且只注册一次。

参数

• state (object) –

  传递给钩子，用于在训练过程中维护任何状态信息。例如，包括梯度压缩中的错误反馈，GossipGrad 中下一个要通信的对等方等。它在每个工作进程上本地存储，并由工作进程上的所有梯度张量共享。

• hook (Callable) – 可调用对象，其签名如下：1）hook: Callable[torch.Tensor] -> None：此函数接受一个 Python 张量，它代表与此 FSDP 单元包装的模型（未被其他 FSDP 子单元包装的）对应的所有变量的完整、展平、未分片梯度。然后执行所有必要的处理并返回 None；2）hook: Callable[torch.Tensor, torch.Tensor] -> None：此函数接受两个 Python 张量，第一个代表与此 FSDP 单元包装的模型（未被其他 FSDP 子单元包装的）对应的所有变量的完整、展平、未分片梯度。第二个代表一个预先调整大小的张量，用于存储减少后的分片梯度的块。在这两种情况下，可调用对象都会执行所有必要的处理并返回 None。签名 1 的可调用对象预计会处理 NO_SHARD 情况下的梯度通信。签名 2 的可调用对象预计会处理分片情况下的梯度通信。

static rekey_optim_state_dict(optim_state_dict, optim_state_key_type, model, optim_input=None, optim=None)

将优化器状态字典 optim_state_dict 重新键入以使用 optim_state_key_type。

这可用于实现具有 FSDP 实例的模型和不具有 FSDP 实例的模型之间优化器状态字典的兼容性。

要将 FSDP 完整优化器状态字典（即来自 full_optim_state_dict()）重新键入为使用参数 ID 并使其可加载到非包装模型中

>>> wrapped_model, wrapped_optim = ...
>>> full_osd = FSDP.full_optim_state_dict(wrapped_model, wrapped_optim)
>>> nonwrapped_model, nonwrapped_optim = ...
>>> rekeyed_osd = FSDP.rekey_optim_state_dict(full_osd, OptimStateKeyType.PARAM_ID, nonwrapped_model)
>>> nonwrapped_optim.load_state_dict(rekeyed_osd)

要将来自非包装模型的普通优化器状态字典重新键入为可加载到包装模型中

>>> nonwrapped_model, nonwrapped_optim = ...
>>> osd = nonwrapped_optim.state_dict()
>>> rekeyed_osd = FSDP.rekey_optim_state_dict(osd, OptimStateKeyType.PARAM_NAME, nonwrapped_model)
>>> wrapped_model, wrapped_optim = ...
>>> sharded_osd = FSDP.shard_full_optim_state_dict(rekeyed_osd, wrapped_model)
>>> wrapped_optim.load_state_dict(sharded_osd)

返回

使用 optim_state_key_type 指定的参数键重新键入的优化器状态字典。

返回类型

Dict[str, Any]

static scatter_full_optim_state_dict(full_optim_state_dict, model, optim_input=None, optim=None, group=None)

将完整的优化器状态字典从 rank 0 散布（scatter）到所有其他 ranks。

在每个 rank 上返回分片优化器状态字典。返回值与 shard_full_optim_state_dict() 相同，并且在 rank 0 上，第一个参数应该是 full_optim_state_dict() 的返回值。

示例

>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> model, optim = ...
>>> full_osd = FSDP.full_optim_state_dict(model, optim)  # only non-empty on rank 0
>>> # Define new model with possibly different world size
>>> new_model, new_optim, new_group = ...
>>> sharded_osd = FSDP.scatter_full_optim_state_dict(full_osd, new_model, group=new_group)
>>> new_optim.load_state_dict(sharded_osd)

注意

可以使用 shard_full_optim_state_dict() 和 scatter_full_optim_state_dict() 来获取要加载的分片优化器状态字典。假设完整的优化器状态字典存在于 CPU 内存中，前者要求每个 rank 在 CPU 内存中都有完整的字典，每个 rank 单独对字典进行分片而无需任何通信；而后者仅要求 rank 0 在 CPU 内存中拥有完整的字典，rank 0 将每个分片移动到 GPU 内存（用于 NCCL）并将其适当地通信给 ranks。因此，前者具有更高的聚合 CPU 内存成本，而后者具有更高的通信成本。

参数

• full_optim_state_dict (Optional[Dict[str, Any]]) – 对应于未展平参数的优化器状态字典，并在 rank 0 上包含完整的非分片优化器状态；参数在非零 ranks 上被忽略。

• model (torch.nn.Module) – 根模块（可能是一个 FullyShardedDataParallel 实例，也可能不是），其参数对应于 full_optim_state_dict 中的优化器状态。

• optim_input (Optional[Union[List[Dict[str, Any]], Iterable[torch.nn.Parameter]]]) – 传入优化器的参数，表示参数组列表或参数的可迭代对象；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传递它。（默认：None）

• optim (Optional[torch.optim.Optimizer]) – 将加载此方法返回的状态字典的优化器。这是比 optim_input 优先使用的参数。（默认：None）

• group (dist.ProcessGroup) – 模型的进程组或 None，如果使用默认进程组。（默认：None）

返回

完整的优化器状态字典现在已重新映射到展平的参数而不是未展平的参数，并且仅限于此 rank 的优化器状态部分。

返回类型

Dict[str, Any]

static set_state_dict_type(module, state_dict_type, state_dict_config=None, optim_state_dict_config=None)

设置目标模块所有后代 FSDP 模块的 state_dict_type。

还接受模型和优化器状态字典的可选配置。目标模块不必是 FSDP 模块。如果目标模块是 FSDP 模块，其 state_dict_type 也将被更改。

注意

此 API 应仅为顶层（根）模块调用。

注意

此 API 使能用户透明地使用传统的 state_dict API 来获取模型检查点，在根 FSDP 模块被另一个 nn.Module 包装的情况下。例如，以下代码将确保对所有非 FSDP 实例调用 state_dict，同时将 FSDP 实例分派到 sharded_state_dict 实现。

示例

>>> model = DDP(FSDP(...))
>>> FSDP.set_state_dict_type(
>>>     model,
>>>     StateDictType.SHARDED_STATE_DICT,
>>>     state_dict_config = ShardedStateDictConfig(offload_to_cpu=True),
>>>     optim_state_dict_config = OptimStateDictConfig(offload_to_cpu=True),
>>> )
>>> param_state_dict = model.state_dict()
>>> optim_state_dict = FSDP.optim_state_dict(model, optim)

参数

• module (torch.nn.Module) – 根模块。

• state_dict_type (StateDictType) – 要设置的 state_dict_type。

• state_dict_config (Optional[StateDictConfig]) – 目标 state_dict_type 的配置。

• optim_state_dict_config (Optional[OptimStateDictConfig]) – 优化器状态字典的配置。

返回

一个 StateDictSettings，包含模块的先前 state_dict 类型和配置。

返回类型

StateDictSettings

static shard_full_optim_state_dict(full_optim_state_dict, model, optim_input=None, optim=None)

分片（Shard）一个完整的优化器状态字典。

将 full_optim_state_dict 中的状态重新映射到展平的参数而不是未展平的参数，并将结果限制为该 rank 的优化器状态部分。第一个参数应该是 full_optim_state_dict() 的返回值。

示例

>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> model, optim = ...
>>> full_osd = FSDP.full_optim_state_dict(model, optim)
>>> torch.save(full_osd, PATH)
>>> # Define new model with possibly different world size
>>> new_model, new_optim = ...
>>> full_osd = torch.load(PATH)
>>> sharded_osd = FSDP.shard_full_optim_state_dict(full_osd, new_model)
>>> new_optim.load_state_dict(sharded_osd)

注意

可以使用 shard_full_optim_state_dict() 和 scatter_full_optim_state_dict() 来获取要加载的分片优化器状态字典。假设完整的优化器状态字典存在于 CPU 内存中，前者要求每个 rank 在 CPU 内存中都有完整的字典，每个 rank 单独对字典进行分片而无需任何通信；而后者仅要求 rank 0 在 CPU 内存中拥有完整的字典，rank 0 将每个分片移动到 GPU 内存（用于 NCCL）并将其适当地通信给 ranks。因此，前者具有更高的聚合 CPU 内存成本，而后者具有更高的通信成本。

参数

• full_optim_state_dict (Dict[str, Any]) – 对应于未展平参数的优化器状态字典，并包含完整的非分片优化器状态。

• model (torch.nn.Module) – 根模块（可能是一个 FullyShardedDataParallel 实例，也可能不是），其参数对应于 full_optim_state_dict 中的优化器状态。

• optim_input (Optional[Union[List[Dict[str, Any]], Iterable[torch.nn.Parameter]]]) – 传入优化器的参数，表示参数组列表或参数的可迭代对象；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传递它。（默认：None）

• optim (Optional[torch.optim.Optimizer]) – 将加载此方法返回的状态字典的优化器。这是比 optim_input 优先使用的参数。（默认：None）

返回

完整的优化器状态字典现在已重新映射到展平的参数而不是未展平的参数，并且仅限于此 rank 的优化器状态部分。

返回类型

Dict[str, Any]

static sharded_optim_state_dict(model, optim, group=None)

以分片形式返回优化器状态字典。

该 API 与 full_optim_state_dict() 类似，但此 API 将所有非零维状态分块为 ShardedTensor 以节省内存。此 API 应仅在使用 with state_dict_type(SHARDED_STATE_DICT): 上下文管理器派生模型 state_dict 时使用。

有关详细用法，请参阅 full_optim_state_dict()。

警告

返回的状态字典包含 ShardedTensor，不能直接由常规 optim.load_state_dict 使用。

返回类型

dict[str, Any]

static state_dict_type(module, state_dict_type, state_dict_config=None, optim_state_dict_config=None)

设置目标模块所有后代 FSDP 模块的 state_dict_type。

这个上下文管理器具有与 set_state_dict_type() 相同的功能。有关详细信息，请阅读 set_state_dict_type() 的文档。

示例

>>> model = DDP(FSDP(...))
>>> with FSDP.state_dict_type(
>>>     model,
>>>     StateDictType.SHARDED_STATE_DICT,
>>> ):
>>>     checkpoint = model.state_dict()

参数

• module (torch.nn.Module) – 根模块。

• state_dict_type (StateDictType) – 要设置的 state_dict_type。

• state_dict_config (Optional[StateDictConfig]) – 目标 state_dict_type 的模型 state_dict 配置。

• optim_state_dict_config (Optional[OptimStateDictConfig]) – 目标 state_dict_type 的优化器 state_dict 配置。

返回类型

生成器

static summon_full_params(module, recurse=True, writeback=True, rank0_only=False, offload_to_cpu=False, with_grads=False)

使用此上下文管理器为 FSDP 实例暴露完整参数。

在模型的前向/后向计算*之后*可能有用，以获取参数以进行额外的处理或检查。它可以接受非 FSDP 模块，并根据 recurse 参数，为所有包含的 FSDP 模块及其子模块调用完整参数。

注意

这可以用于内部 FSDP。

注意

此上下文不能在（或从）前向或后向传递中使用。也不能在此上下文内启动前向和后向。

注意

退出上下文管理器后，参数将恢复为它们的本地分片，存储行为与前向传递相同。

注意

完整参数可以被修改，但只有对应于本地参数分片的部分在退出上下文管理器后才会保留（除非 writeback=False，在这种情况下，更改将被丢弃）。在 FSDP 不分片参数的情况下（例如，仅当 world_size == 1 或配置为 NO_SHARD 时），修改将保留，无论 writeback 如何。

注意

此方法适用于本身不是 FSDP 但可能包含多个独立 FSDP 单元的模块。在这种情况下，给定的参数将应用于所有包含的 FSDP 单元。

警告

请注意，rank0_only=True 与 writeback=True 结合使用目前不支持，并且会引发错误。这是因为在上下文内的模型参数形状在 ranks 之间会有所不同，在上下文退出时写入它们可能导致 ranks 之间的不一致。

警告

请注意，offload_to_cpu 和 rank0_only=False 将导致完整参数被冗余地复制到位于同一台机器上的 GPU 的 CPU 内存中，这可能会带来 CPU OOM 的风险。建议将 offload_to_cpu 与 rank0_only=True 一起使用。

参数

• recurse (布尔值, 可选) – 递归调用所有参数以获取嵌套的FSDP实例（默认值：True）。

• writeback (布尔值, 可选) – 如果为 False，则在退出上下文管理器后会丢弃对参数的修改；禁用此项可以稍微提高效率（默认值：True）

• rank0_only (布尔值, 可选) – 如果为 True，则仅在全局rank 0上实例化完整的参数。这意味着在上下文中，只有rank 0拥有完整的参数，而其他rank则拥有分片（sharded）的参数。请注意，同时设置 rank0_only=True 和 writeback=True 是不支持的，因为在上下文内，模型参数在不同rank上的形状会不同，并且写入这些参数可能导致退出上下文时跨rank的不一致。

• offload_to_cpu (布尔值, 可选) – 如果为 True，则将完整的参数卸载到 CPU。请注意，此卸载目前仅发生在参数被分片时（这仅在 world_size = 1 或 NO_SHARD 配置时不是这种情况）。建议将 offload_to_cpu 与 rank0_only=True 一起使用，以避免将模型参数冗余地复制到相同的 CPU 内存中。

• with_grads (布尔值, 可选) – 如果为 True，则梯度也会随参数一起解分片（unsharded）。目前，这仅在向 FSDP 构造函数传递 use_orig_params=True 并且向此方法传递 offload_to_cpu=False 时才受支持。（默认值：False）

返回类型

生成器

class torch.distributed.fsdp.BackwardPrefetch(value)

此配置用于显式的向后预取（backward prefetching），通过在反向传播中实现通信和计算重叠来提高吞吐量，但会略微增加内存使用。

• BACKWARD_PRE：这提供了最大的重叠，但内存使用也最多。它会在当前参数集计算梯度*之前*预取下一组参数。这会重叠*下一个 all-gather* 和*当前梯度计算*，在峰值时，它会在内存中同时保存当前参数集、下一组参数集以及当前梯度集。

• BACKWARD_POST：这提供的重叠较少，但内存使用也较少。它会在当前参数集计算梯度*之后*预取下一组参数。这会重叠*当前 reduce-scatter* 和*下一个梯度计算*，并且在为下一组参数分配内存之前释放当前参数集，在峰值时仅在内存中保留下一组参数和当前梯度集。

• FSDP 的 backward_prefetch 参数可以接受 None，这将完全禁用向后预取。这没有重叠，也不会增加内存使用。一般来说，我们不推荐这种设置，因为它可能会显著降低吞吐量。

更多技术背景：对于使用 NCCL 后端的单个进程组，任何集体通信（collective operations），即使是从不同的流发出的，都会争用相同的每设备 NCCL 流，这意味着集体通信发出的相对顺序对于重叠很重要。两个向后预取值对应于不同的发出顺序。

class torch.distributed.fsdp.ShardingStrategy(value)

这指定了由 FullyShardedDataParallel 使用的分布式训练分片策略。

• FULL_SHARD：参数、梯度和优化器状态都会被分片。对于参数，此策略在前向传播之前进行解分片（通过 all-gather），在前向传播之后进行重分片，在反向传播计算之前进行解分片，并在反向传播计算之后进行重分片。对于梯度，它在反向传播计算之后进行同步和分片（通过 reduce-scatter）。分片后的优化器状态在每个rank上本地更新。

• SHARD_GRAD_OP：梯度和优化器状态在计算过程中被分片，此外，参数在计算之外也被分片。对于参数，此策略在前向传播之前进行解分片，在前向传播之后不进行重分片，仅在反向传播计算之后进行重分片。分片后的优化器状态在每个rank上本地更新。在 no_sync() 内部，参数在反向传播计算之后不会被重分片。

• NO_SHARD：参数、梯度和优化器状态都不会被分片，而是像 PyTorch 的 DistributedDataParallel API 一样在各个rank上进行复制。对于梯度，此策略在反向传播计算之后通过 all-reduce 进行同步。未分片的优化器状态在每个rank上本地更新。

• HYBRID_SHARD：在节点内应用 FULL_SHARD，并在节点之间复制参数。这减少了通信量，因为昂贵的 all-gather 和 reduce-scatter 操作仅在节点内完成，这对于中等大小的模型可能更具性能优势。

• _HYBRID_SHARD_ZERO2：在节点内应用 SHARD_GRAD_OP，并在节点之间复制参数。这类似于 HYBRID_SHARD，但由于未分片的参数在前向传播后不会被释放，从而节省了反向传播之前的 all-gather 操作，因此可能提供更高的吞吐量。

class torch.distributed.fsdp.MixedPrecision(param_dtype=None, reduce_dtype=None, buffer_dtype=None, keep_low_precision_grads=False, cast_forward_inputs=False, cast_root_forward_inputs=True, _module_classes_to_ignore=(<class 'torch.nn.modules.batchnorm._BatchNorm'>, ))

此配置用于 FSDP 原生的混合精度训练。

变量

• param_dtype (可选[torch.dtype]) – 此参数指定模型参数在前向和后向传播期间的数据类型，因此也指定了前向和后向计算的数据类型。在前向和后向传播之外，*分片*的参数以全精度（例如，用于优化器步骤）保留，并且在模型检查点（checkpointing）时，参数始终以全精度保存。（默认值：None）

• reduce_dtype (可选[torch.dtype]) – 此参数指定梯度约简（即 reduce-scatter 或 all-reduce）的数据类型。如果此参数为 None 但 param_dtype 不是 None，则此参数将采用 param_dtype 的值，仍然以低精度运行梯度约简。此参数可以与 param_dtype 不同，例如，强制梯度约简以全精度运行。（默认值：None）

• buffer_dtype (可选[torch.dtype]) – 此参数指定缓冲区（buffers）的数据类型。FSDP 不分片缓冲区。相反，FSDP 在第一次前向传递时将其转换为 buffer_dtype，并在之后一直保持该数据类型。对于模型检查点，除了 LOCAL_STATE_DICT 外，缓冲区都以全精度保存。（默认值：None）

• keep_low_precision_grads (布尔值) – 如果为 False，则 FSDP 在反向传播后将梯度向上转换为全精度，以准备优化器步骤。如果为 True，则 FSDP 将梯度保留在用于梯度约简的数据类型中，如果使用支持低精度运行的自定义优化器，这可以节省内存。（默认值：False）

• cast_forward_inputs (布尔值) – 如果为 True，则此 FSDP 模块将其前向参数和关键字参数转换为 param_dtype。这是为了确保参数和输入的数据类型在前向计算时匹配，这是许多操作的要求。当仅将混合精度应用于部分但非全部 FSDP 模块时，可能需要将此设置为 True，在这种情况下，一个混合精度 FSDP 子模块需要重新转换其输入。（默认值：False）

• cast_root_forward_inputs (布尔值) – 如果为 True，则根 FSDP 模块将其前向参数和关键字参数转换为 param_dtype，这将覆盖 cast_forward_inputs 的值。对于非根 FSDP 模块，此设置无效。（默认值：True）

• _module_classes_to_ignore (collections.abc.Sequence[type[torch.nn.modules.module.Module]]) – （Sequence[Type[nn.Module]]）：此参数指定在使用 auto_wrap_policy 时要忽略混合精度的模块类别：这些类别的模块将分别应用 FSDP，并禁用混合精度（这意味着最终的 FSDP 构建将偏离指定的策略）。如果未指定 auto_wrap_policy，则此参数无效。此 API 是实验性的，可能会发生更改。（默认值：(_BatchNorm,)）

注意

此 API 是实验性的，可能会发生更改。

注意

只有浮点张量会被转换为指定的数据类型。

注意

在 summon_full_params 中，参数会被强制转换为全精度，但缓冲区不会。

注意

层归一化（Layer norm）和批归一化（Batch norm）即使在输入数据类型为 float16 或 bfloat16 等低精度时，也会以 float32 累积。禁用这些归一化模块的 FSDP 混合精度仅意味着仿射（affine）参数会保留为 float32。然而，这会导致这些归一化模块进行单独的 all-gather 和 reduce-scatter 操作，这可能效率不高。因此，如果工作负载允许，用户应优先考虑仍将混合精度应用于这些模块。

注意

默认情况下，如果用户传递的模型包含任何 _BatchNorm 模块并指定了 auto_wrap_policy，那么批归一化模块将单独应用 FSDP，并禁用混合精度。请参阅 _module_classes_to_ignore 参数。

注意

MixedPrecision 默认具有 cast_root_forward_inputs=True 和 cast_forward_inputs=False。对于根 FSDP 实例，其 cast_root_forward_inputs 优先于其 cast_forward_inputs。对于非根 FSDP 实例，其 cast_root_forward_inputs 值将被忽略。默认设置足以应对典型情况，即每个 FSDP 实例具有相同的 MixedPrecision 配置，并且在模型前向传递的开始处仅需要将输入转换为 param_dtype。

注意

对于具有不同 MixedPrecision 配置的嵌套 FSDP 实例，我们建议将各个 cast_forward_inputs 值设置为 True 或 False，以配置在每个实例的前向传播之前是否进行输入转换。在这种情况下，由于转换发生在每个 FSDP 实例的前向传播之前，父 FSDP 实例应在其非 FSDP 子模块之后运行其 FSDP 子模块，以避免由于不同的 MixedPrecision 配置而导致激活数据类型发生更改。

示例

>>> model = nn.Sequential(nn.Linear(3, 3), nn.Linear(3, 3))
>>> model[1] = FSDP(
>>>     model[1],
>>>     mixed_precision=MixedPrecision(param_dtype=torch.float16, cast_forward_inputs=True),
>>> )
>>> model = FSDP(
>>>     model,
>>>     mixed_precision=MixedPrecision(param_dtype=torch.bfloat16, cast_forward_inputs=True),
>>> )

上述示例是一个可行的示例。另一方面，如果将 model[1] 替换为 model[0]，这意味着使用不同 MixedPrecision 的子模块首先运行其前向传播，那么 model[1] 将错误地看到 float16 激活而不是 bfloat16 激活。

class torch.distributed.fsdp.CPUOffload(offload_params=False)

此配置用于 CPU 卸载。

变量

offload_params (布尔值) – 此参数指定在不参与计算时是否将参数卸载到 CPU。如果为 True，则还会将梯度卸载到 CPU，这意味着优化器步骤将在 CPU 上运行。

class torch.distributed.fsdp.StateDictConfig(offload_to_cpu=False)

StateDictConfig 是所有 state_dict 配置类的基类。用户应实例化一个子类（例如 FullStateDictConfig），以便配置 FSDP 支持的相应 state_dict 类型的设置。

变量

offload_to_cpu (布尔值) – 如果为 True，则 FSDP 将 state dict 的值卸载到 CPU；如果为 False，则 FSDP 将其保留在 GPU 上。（默认值：False）

class torch.distributed.fsdp.FullStateDictConfig(offload_to_cpu=False, rank0_only=False)

FullStateDictConfig 是一个配置类，用于 StateDictType.FULL_STATE_DICT。我们建议在保存完整的 state dict 时同时启用 offload_to_cpu=True 和 rank0_only=True，分别节省 GPU 内存和 CPU 内存。此类应通过 state_dict_type() 上下文管理器使用，如下所示：

>>> from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
>>> fsdp = FSDP(model, auto_wrap_policy=...)
>>> cfg = FullStateDictConfig(offload_to_cpu=True, rank0_only=True)
>>> with FSDP.state_dict_type(fsdp, StateDictType.FULL_STATE_DICT, cfg):
>>>     state = fsdp.state_dict()
>>> # `state` will be empty on non rank 0 and contain CPU tensors on rank 0.
>>> # To reload checkpoint for inference, finetuning, transfer learning, etc:
>>> model = model_fn()  # Initialize model in preparation for wrapping with FSDP
>>> if dist.get_rank() == 0:
>>> # Load checkpoint only on rank 0 to avoid memory redundancy
>>>     state_dict = torch.load("my_checkpoint.pt")
>>>     model.load_state_dict(state_dict)
>>> # All ranks initialize FSDP module as usual. `sync_module_states` argument
>>> # communicates loaded checkpoint states from rank 0 to rest of the world.
>>> fsdp = FSDP(
...     model,
...     device_id=torch.cuda.current_device(),
...     auto_wrap_policy=...,
...     sync_module_states=True,
... )
>>> # After this point, all ranks have FSDP model with loaded checkpoint.

变量

rank0_only (布尔值) – 如果为 True，则仅 rank 0 保存完整的 state dict，非零 rank 保存一个空字典。如果为 False，则所有 rank 保存完整的 state dict。（默认值：False）

class torch.distributed.fsdp.ShardedStateDictConfig(offload_to_cpu=False, _use_dtensor=False)

ShardedStateDictConfig 是一个配置类，用于 StateDictType.SHARDED_STATE_DICT。

变量

_use_dtensor (布尔值) – 如果为 True，则 FSDP 将 state dict 的值保存为 DTensor；如果为 False，则 FSDP 将其保存为 ShardedTensor。（默认值：False）

警告

_use_dtensor 是 ShardedStateDictConfig 的一个私有字段，它被 FSDP 用来确定 state dict 值的类型。用户不应手动修改 _use_dtensor。

class torch.distributed.fsdp.LocalStateDictConfig(offload_to_cpu: bool = False)

class torch.distributed.fsdp.OptimStateDictConfig(offload_to_cpu=True)

OptimStateDictConfig 是所有 optim_state_dict 配置类的基类。用户应实例化一个子类（例如 FullOptimStateDictConfig），以便配置 FSDP 支持的相应 optim_state_dict 类型的设置。

变量

offload_to_cpu (布尔值) – 如果为 True，则 FSDP 将 state dict 的张量值卸载到 CPU；如果为 False，则 FSDP 将其保留在原始设备上（除非启用了参数 CPU 卸载，否则为 GPU）。（默认值：True）

class torch.distributed.fsdp.FullOptimStateDictConfig(offload_to_cpu=True, rank0_only=False)

变量

rank0_only (布尔值) – 如果为 True，则仅 rank 0 保存完整的 state dict，非零 rank 保存一个空字典。如果为 False，则所有 rank 保存完整的 state dict。（默认值：False）

class torch.distributed.fsdp.ShardedOptimStateDictConfig(offload_to_cpu=True, _use_dtensor=False)

ShardedOptimStateDictConfig 是一个配置类，用于 StateDictType.SHARDED_STATE_DICT。

变量

_use_dtensor (布尔值) – 如果为 True，则 FSDP 将 state dict 的值保存为 DTensor；如果为 False，则 FSDP 将其保存为 ShardedTensor。（默认值：False）

警告

_use_dtensor 是 ShardedOptimStateDictConfig 的一个私有字段，它被 FSDP 用来确定 state dict 值的类型。用户不应手动修改 _use_dtensor。

class torch.distributed.fsdp.LocalOptimStateDictConfig(offload_to_cpu: bool = False)

class torch.distributed.fsdp.StateDictSettings(state_dict_type: torch.distributed.fsdp.api.StateDictType, state_dict_config: torch.distributed.fsdp.api.StateDictConfig, optim_state_dict_config: torch.distributed.fsdp.api.OptimStateDictConfig)