FullyShardedDataParallel¶

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)[source][source]¶

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

这受到 Xu 等人以及来自 DeepSpeed 的 ZeRO Stage 3 的启发。FullyShardedDataParallel 通常缩写为 FSDP。

要理解 FSDP 内部原理，请参阅 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 内核执行。

由于自动梯度相关的原因，FSDP 在前向和反向计算期间用 torch.Tensor 视图替换了托管模块的参数。如果您的模块的前向传播依赖于已保存的参数引用，而不是每次迭代都重新获取引用，那么它将看不到 FSDP 新创建的视图，并且自动梯度将无法正常工作。

最后，当使用 sharding_strategy=ShardingStrategy.HYBRID_SHARD 时，如果分片进程组是节点内进程组，而复制进程组是节点间进程组，则设置 NCCL_CROSS_NIC=1 可以帮助提高某些集群设置中复制进程组的 all-reduce 时间。

限制

使用 FSDP 时需要注意以下几个限制

当使用 CPU 卸载时，FSDP 当前不支持在 no_sync() 之外进行梯度累积。这是因为 FSDP 使用新减少的梯度而不是与任何现有梯度累积，这可能导致不正确的结果。
FSDP 不支持运行包含在 FSDP 实例中的子模块的前向传播。这是因为子模块的参数将被分片，但子模块本身不是 FSDP 实例，因此其前向传播将不会适当地 all-gather 所有参数。
由于 FSDP 注册反向钩子的方式，FSDP 不支持双重反向传播。
当冻结参数时，FSDP 有一些约束。对于 use_orig_params=False，每个 FSDP 实例必须管理所有冻结或所有非冻结的参数。对于 use_orig_params=True，FSDP 支持混合冻结和非冻结参数，但建议避免这样做，以防止高于预期的梯度内存使用量。
截至 PyTorch 1.12，FSDP 对共享参数提供有限的支持。如果您的用例需要增强的共享参数支持，请在此问题中发帖。
您应该避免在不使用 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，指定如果 recurse=False，是否应将 FSDP 应用于传入的 module，或者如果 recurse=True，是否应继续遍历到模块的子树中。用户可以向可调用对象添加其他参数。torch.distributed.fsdp.wrap.py 中的 size_based_auto_wrap_policy 提供了一个示例可调用对象，如果子树中的参数超过 100M 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，则不使用混合精度。否则，可以设置参数、缓冲区和梯度缩减数据类型。有关详细信息，请参阅 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 的 (https://github.com/pytorch/torchdistX) deferred_init() API 支持延迟初始化，其中延迟模块通过调用 param_init_fn（如果指定）或 torchdistX 的默认 materialize_module()（否则）来初始化。如果指定了 param_init_fn，则会将其应用于所有 meta 设备模块，这意味着它可能应该根据模块类型进行区分。FSDP 在参数展平和分片之前调用初始化函数。

示例
```
>>> 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），则用户可以将 torch.cuda.current_device 传递给此项。（默认值：None）
sync_module_states (bool) – 如果为 True，则每个 FSDP 模块将从 rank 0 广播模块参数和缓冲区，以确保它们在 rank 之间复制（从而增加了此构造函数的通信开销）。这可以帮助以内存高效的方式通过 load_state_dict 加载 state_dict 检查点。有关示例，请参阅 FullStateDictConfig。（默认值：False）
forward_prefetch (bool) – 如果为 True，则 FSDP 在当前前向计算之前显式预取下一个前向传播 all-gather。这仅对 CPU 密集型工作负载有用，在这种情况下，更早地发出下一个 all-gather 可能会改善重叠。这仅应用于静态图模型，因为预取遵循第一次迭代的执行顺序。（默认值：False）
limit_all_gathers (bool) – 如果为 True，则 FSDP 显式同步 CPU 线程，以确保仅来自两个连续 FSDP 实例（当前正在运行计算的实例和下一个预取其 all-gather 的实例）的 GPU 内存使用量。如果为 False，则 FSDP 允许 CPU 线程在没有任何额外同步的情况下发出 all-gather。（默认值：True）我们通常将此功能称为“速率限制器”。仅当特定的 CPU 密集型工作负载的内存压力较低时，才应将此标志设置为 False，在这种情况下，CPU 线程可以积极地发出所有内核，而无需担心 GPU 内存使用量。
use_orig_params (bool) – 将此项设置为 True 会使 FSDP 使用 module 的原始参数。FSDP 通过 nn.Module.named_parameters() 向用户公开这些原始参数，而不是 FSDP 的内部 FlatParameter。这意味着优化器步骤在原始参数上运行，从而启用每个原始参数的超参数。FSDP 保留原始参数变量，并在非分片形式和分片形式之间操作其数据，其中它们始终是底层非分片或分片 FlatParameter 的视图。使用当前算法，分片形式始终为 1D，从而丢失了原始张量结构。原始参数可能具有给定 rank 的所有数据、部分数据或没有数据。在没有数据的情况下，其数据将类似于大小为 0 的空张量。用户不应编写依赖于给定 rank 的原始参数在其分片形式中存在哪些数据的程序。True 是使用 torch.compile() 所必需的。将此项设置为 False 会通过 nn.Module.named_parameters() 向用户公开 FSDP 的内部 FlatParameter。（默认值：False）
ignored_states (Optional[Iterable[torch.nn.Parameter]], Optional[Iterable[torch.nn.Module]]) – 将被此 FSDP 实例忽略的参数或模块，这意味着参数未分片，并且其梯度未在 rank 之间缩减。此参数与现有的 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)[source][source]¶

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

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

与 torch.nn.Module.apply 相比，此版本还会在应用 fn 之前收集所有参数。不应从另一个 summon_full_params 上下文中调用它。

参数

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

返回

self

返回类型

Module

check_is_root()[source][source]¶

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

返回类型: 布尔值

clip_grad_norm_(max_norm, norm_type=2.0)[source][source]¶

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

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

参数

max_norm (float 或 int) – 梯度的最大范数
norm_type (float 或 int) – 使用的 p-范数的类型。可以是 'inf' 表示无穷范数。

返回

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

返回类型

张量

如果每个 FSDP 实例都使用 NO_SHARD，意味着梯度不会跨 rank 分片，那么您可以直接使用 torch.nn.utils.clip_grad_norm_()。

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

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

警告

这需要在所有 rank 上调用，因为它使用 collective communications。

static flatten_sharded_optim_state_dict(sharded_optim_state_dict, model, optim)[source][source]¶

展平分片优化器状态字典。

此 API 类似于 shard_full_optim_state_dict()。唯一的区别是输入 sharded_optim_state_dict 应该从 sharded_optim_state_dict() 返回。因此，每个 rank 上都会有 all-gather 调用来收集 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)[source][source]¶

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

返回类型: Any

static fsdp_modules(module, root_only=False)[source][source]¶

返回所有嵌套的 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)[source][source]¶

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

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

这需要在所有 rank 上调用，因为它使用 collective communications。但是，如果 rank0_only=True，则状态字典仅在 rank 0 上填充，所有其他 rank 返回一个空的 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]]]) – 传递到优化器 optim 的输入，表示参数组的 list 或参数的可迭代对象；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传入。（默认值：None）
rank0_only (bool) – 如果为 True，则仅在 rank 0 上保存填充的 dict；如果为 False，则在所有 rank 上保存。（默认值：True）
group (dist.ProcessGroup) – 模型的进程组，如果使用默认进程组，则为 None。（默认值：None）

返回

一个 dict，包含 model 原始未展平参数的优化器状态，并包含键 “state” 和 “param_groups”，遵循 torch.optim.Optimizer.state_dict() 的约定。如果 rank0_only=True，则非零 rank 返回一个空的 dict。

返回类型

Dict[str, Any]

static get_state_dict_type(module)[source][source]¶

获取以 module 为根的 FSDP 模块的 state_dict_type 和相应的配置。

目标模块不必是 FSDP 模块。

返回

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

Raises

AssertionError` 如果 differen 的 StateDictSettings –
FSDP 子模块不同。 –

返回类型

StateDictSettings

property module: Module¶: 返回包装的模块。

named_buffers(*args, **kwargs)[source][source]¶

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

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

返回类型: Iterator[Tuple[str, Tensor]]

named_parameters(*args, **kwargs)[source][source]¶

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

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

返回类型: Iterator[Tuple[str, Parameter]]

no_sync()[source][source]¶

禁用跨 FSDP 实例的梯度同步。

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

注意

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

注意

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

返回类型: 生成器

static optim_state_dict(model, optim, optim_state_dict=None, group=None)[source][source]¶

转换与分片模型对应的优化器的 state-dict。

给定的 state-dict 可以转换为三种类型之一：1) 完整优化器 state_dict，2) 分片优化器 state_dict，3) 本地优化器 state_dict。

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

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

对于本地 state_dict，将不执行任何转换。但是状态将从 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]) – 要转换的目标优化器 state_dict。如果值为 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)[source][source]¶

转换优化器 state-dict，以便可以将其加载到与 FSDP 模型关联的优化器中。

给定通过 optim_state_dict() 转换的 optim_state_dict，它将被转换为可以加载到 optim 的展平优化器 state_dict，而 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)[source][source]¶

注册通信钩子。

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

警告

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

参数

state (object) –
传递给钩子以在训练过程中维护任何状态信息。示例包括梯度压缩中的错误反馈，在 GossipGrad 中接下来要通信的对等方等。它由每个 worker 本地存储，并由 worker 上的所有梯度张量共享。
hook (Callable) – Callable，具有以下签名之一：1) hook: Callable[torch.Tensor] -> None：此函数接受一个 Python 张量，该张量表示与此 FSDP 单元正在包装的模型（未被其他 FSDP 子单元包装）对应的所有变量相关的完整、展平、未分片的梯度。然后，它执行所有必要的处理并返回 None； 2) hook: Callable[torch.Tensor, torch.Tensor] -> None：此函数接受两个 Python 张量，第一个张量表示与此 FSDP 单元正在包装的模型（未被其他 FSDP 子单元包装）对应的所有变量相关的完整、展平、未分片的梯度。后者表示一个预先调整大小的张量，用于存储缩减后分片梯度的一部分。在这两种情况下，callable 都执行所有必要的处理并返回 None。签名 1 的 Callable 预计会处理 NO_SHARD 情况下的梯度通信。签名 2 的 Callable 预计会处理分片情况下的梯度通信。

static rekey_optim_state_dict(optim_state_dict, optim_state_key_type, model, optim_input=None, optim=None)[source][source]¶

重新键入优化器状态字典 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)[source][source]¶

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

在每个 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）并将其适当地通信到 rank。因此，前者具有较高的聚合 CPU 内存成本，而后者具有较高的通信成本。

参数

full_optim_state_dict (Optional[Dict[str, Any]]) – 如果在 rank 0 上，则为对应于未展平参数并保存完整非分片优化器状态的优化器状态字典；在非零 rank 上，此参数将被忽略。
model (torch.nn.Module) – 根模块（可以是也可以不是 FullyShardedDataParallel 实例），其参数与 full_optim_state_dict 中的优化器状态相对应。
optim_input (可选[Union[List[Dict[str, Any]], Iterable[torch.nn.Parameter]]]) – 传入优化器的输入，表示参数组的 list 或参数的 iterable；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传入。（默认值：None）
optim (可选[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)[source][source]¶

设置目标模块的所有后代 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 (可选[StateDictConfig]) – 目标 state_dict_type 的配置。
optim_state_dict_config (可选[OptimStateDictConfig]) – 优化器状态字典的配置。

返回

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

返回类型

StateDictSettings

static shard_full_optim_state_dict(full_optim_state_dict, model, optim_input=None, optim=None)[source][source]¶

对完整的优化器状态字典进行分片。

将 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）并将其适当地通信到 rank。因此，前者具有较高的聚合 CPU 内存成本，而后者具有较高的通信成本。

参数

full_optim_state_dict (Dict[str, Any]) – 对应于非扁平化参数并保存完整非分片优化器状态的优化器状态字典。
model (torch.nn.Module) – 根模块（可以是也可以不是 FullyShardedDataParallel 实例），其参数与 full_optim_state_dict 中的优化器状态相对应。
optim_input (可选[Union[List[Dict[str, Any]], Iterable[torch.nn.Parameter]]]) – 传入优化器的输入，表示参数组的 list 或参数的 iterable；如果为 None，则此方法假定输入为 model.parameters()。此参数已弃用，不再需要传入。（默认值：None）
optim (可选[torch.optim.Optimizer]) – 将加载此方法返回的状态字典的优化器。这是优于使用 optim_input 的首选参数。（默认值：None）

返回

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

返回类型

Dict[str, Any]

static sharded_optim_state_dict(model, optim, group=None)[source][source]¶

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

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

有关详细用法，请参阅 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)[source][source]¶

设置目标模块的所有后代 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 (可选[StateDictConfig]) – 目标 state_dict_type 的模型 state_dict 配置。
optim_state_dict_config (可选[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)[source][source]¶

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

在模型的正向/反向传播之后，获取参数以进行额外处理或检查可能很有用。它可以接受非 FSDP 模块，并将根据 recurse 参数，为所有包含的 FSDP 模块及其子模块召唤完整参数。

注意

这可以用于内部 FSDP。

注意

这不能在正向或反向传播中使用。正向和反向传播也不能从此上下文中启动。

注意

参数将在上下文管理器退出后恢复为其本地分片，存储行为与正向传播相同。

注意

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

注意

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

警告

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

警告

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

参数

recurse (bool, 可选) – 递归地为嵌套 FSDP 实例召唤所有参数（默认值：True）。
writeback (bool, 可选) – 如果为 False，则在上下文管理器退出后，对参数的修改将被丢弃；禁用此功能可能会稍微提高效率（默认值：True）
rank0_only (bool, 可选) – 如果为 True，则仅在全局 rank 0 上物化完整参数。这意味着在上下文中，只有 rank 0 将具有完整参数，而其他 rank 将具有分片参数。请注意，不支持将 rank0_only=True 与 writeback=True 一起设置，因为上下文中的模型参数形状在不同 rank 之间会不同，并且写入它们可能会导致上下文退出时 rank 之间不一致。
offload_to_cpu (bool, 可选) – 如果为 True，则完整参数被卸载到 CPU。请注意，此卸载当前仅在参数被分片时发生（仅当 world_size = 1 或 NO_SHARD 配置时才不是这种情况）。建议将 offload_to_cpu 与 rank0_only=True 一起使用，以避免将模型参数的冗余副本卸载到相同的 CPU 内存。
with_grads (bool, 可选) – 如果为 True，梯度也会与参数一起取消分片。目前，仅当将 use_orig_params=True 传递给 FSDP 构造函数并将 offload_to_cpu=False 传递给此方法时，才支持此功能。（默认值：False）

返回类型

生成器

class torch.distributed.fsdp.BackwardPrefetch(value)[source][source]¶

此配置显式反向预取，通过在反向传播中启用通信和计算重叠来提高吞吐量，但代价是略微增加内存使用量。

BACKWARD_PRE：这实现了最大的重叠，但也最大程度地增加了内存使用量。这在当前参数集的梯度计算之前预取下一组参数。这重叠了下一个 all-gather 和当前梯度计算，并且在峰值时，它在内存中保存当前参数集、下一组参数和当前梯度集。
BACKWARD_POST：这实现了较小的重叠，但需要较少的内存使用量。这在当前参数集的梯度计算之后预取下一组参数。这重叠了当前 reduce-scatter 和下一个梯度计算，并且它在为下一组参数分配内存之前释放当前参数集，在峰值时仅在内存中保存下一组参数和当前梯度集。
FSDP 的 backward_prefetch 参数接受 None，这完全禁用反向预取。这没有重叠，也不会增加内存使用量。一般来说，我们不建议使用此设置，因为它可能会显着降低吞吐量。

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

class torch.distributed.fsdp.ShardingStrategy(value)[source][source]¶

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

FULL_SHARD：参数、梯度和优化器状态被分片。对于参数，此策略在正向传播之前取消分片（通过 all-gather），在正向传播之后重新分片，在反向计算之前取消分片，并在反向计算之后重新分片。对于梯度，它在反向计算后同步并分片它们（通过 reduce-scatter）。分片的优化器状态在每个 rank 本地更新。
SHARD_GRAD_OP：梯度和优化器状态在计算期间被分片，此外，参数在计算之外被分片。对于参数，此策略在正向传播之前取消分片，在正向传播之后不重新分片它们，并且仅在反向计算之后重新分片它们。分片的优化器状态在每个 rank 本地更新。在 no_sync() 内部，参数在反向计算后不会重新分片。
NO_SHARD：参数、梯度和优化器状态不分片，而是在 rank 之间复制，类似于 PyTorch 的 DistributedDataParallel API。对于梯度，此策略在反向计算后同步它们（通过 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'>, ))[source][source]¶

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

变量

param_dtype (可选[torch.dtype]) – 这指定了正向和反向传播期间模型参数的 dtype，因此也是正向和反向计算的 dtype。在正向和反向传播之外，分片参数以全精度保存（例如，用于优化器步骤），并且对于模型检查点，参数始终以全精度保存。（默认值：None）
reduce_dtype (可选[torch.dtype]) – 这指定了梯度缩减（即 reduce-scatter 或 all-reduce）的 dtype。如果这是 None 但 param_dtype 不是 None，则这将采用 param_dtype 值，仍然以低精度运行梯度缩减。允许这与 param_dtype 不同，例如，强制梯度缩减以全精度运行。（默认值：None）
buffer_dtype (可选[torch.dtype]) – 这指定了缓冲区的 dtype。FSDP 不分片缓冲区。相反，FSDP 在第一个正向传播中将它们转换为 buffer_dtype，并在之后保持该 dtype。对于模型检查点，缓冲区以全精度保存，除了 LOCAL_STATE_DICT。（默认值：None）
keep_low_precision_grads (bool) – 如果为 False，则 FSDP 在反向传播后将梯度向上转换为全精度，以准备优化器步骤。如果为 True，则 FSDP 将梯度保持在用于梯度缩减的 dtype 中，如果使用支持以低精度运行的自定义优化器，则可以节省内存。（默认值：False）
cast_forward_inputs (bool) – 如果为 True，则此 FSDP 模块将其正向 args 和 kwargs 转换为 param_dtype。这是为了确保参数和输入 dtype 与正向计算匹配，这是许多 ops 所要求的。当仅将混合精度应用于某些而非所有 FSDP 模块时，可能需要将其设置为 True，在这种情况下，混合精度 FSDP 子模块需要重新转换其输入。（默认值：False）
cast_root_forward_inputs (bool) – 如果为 True，则根 FSDP 模块将其正向 args 和 kwargs 转换为 param_dtype，从而覆盖 cast_forward_inputs 的值。对于非根 FSDP 模块，这不会执行任何操作。（默认值：True）
_module_classes_to_ignore (Sequence[Type[torch.nn.modules.module.Module]]) – (Sequence[Type[nn.Module]]): 这指定了在使用 auto_wrap_policy 时要忽略混合精度的模块类：这些类的模块将单独应用 FSDP，并且禁用混合精度（这意味着最终的 FSDP 构造将偏离指定的策略）。如果未指定 auto_wrap_policy，则这不会执行任何操作。此 API 是实验性的，可能会发生更改。（默认值：(_BatchNorm,)）

注意

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

注意

只有浮点张量会被转换为其指定的 dtype。

注意

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

注意

即使层归一化和批量归一化的输入采用低精度（如 float16 或 bfloat16），它们也会以 float32 累积。为这些归一化模块禁用 FSDP 的混合精度仅意味着仿射参数保持为 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 值，以配置在每个实例的正向传播之前是否转换输入。在这种情况下，由于转换发生在每个 FSDP 实例的正向传播之前，因此父 FSDP 实例应使其非 FSDP 子模块在其 FSDP 子模块之前运行，以避免由于不同的 MixedPrecision 配置而导致激活 dtype 发生更改。

示例

>>> 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)[source][source]¶

此配置 CPU 卸载。

变量: offload_params (bool) – 这指定了在不参与计算时是否将参数卸载到 CPU。如果为 True，则这也会将梯度卸载到 CPU，这意味着优化器步骤在 CPU 上运行。

class torch.distributed.fsdp.StateDictConfig(offload_to_cpu=False)[source][source]¶

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

变量: offload_to_cpu (bool) – 如果为 True，则 FSDP 将状态字典值卸载到 CPU，如果为 False，则 FSDP 将它们保留在 GPU 上。（默认值：False）

class torch.distributed.fsdp.FullStateDictConfig(offload_to_cpu=False, rank0_only=False)[source][source]¶

FullStateDictConfig 是一个配置类，旨在与 StateDictType.FULL_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 (bool) – 如果 True，则只有 rank 0 保存完整的状态字典，非零 rank 保存空字典。如果 False，则所有 rank 都保存完整的状态字典。（默认值：False）

class torch.distributed.fsdp.ShardedStateDictConfig(offload_to_cpu=False, _use_dtensor=False)[source][source]¶

ShardedStateDictConfig 是一个配置类，旨在与 StateDictType.SHARDED_STATE_DICT 一起使用。

变量: _use_dtensor (bool) – 如果 True，则 FSDP 将状态字典值保存为 DTensor，如果 False，则 FSDP 将它们保存为 ShardedTensor。（默认值：False）

警告

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

class torch.distributed.fsdp.LocalStateDictConfig(offload_to_cpu: bool = False)[source][source]¶

class torch.distributed.fsdp.OptimStateDictConfig(offload_to_cpu=True)[source][source]¶

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

变量: offload_to_cpu (bool) – 如果 True，则 FSDP 将状态字典的张量值卸载到 CPU，如果 False，则 FSDP 将它们保留在原始设备上（除非启用了参数 CPU 卸载，否则为 GPU）。（默认值：True）

class torch.distributed.fsdp.FullOptimStateDictConfig(offload_to_cpu=True, rank0_only=False)[source][source]¶

变量: rank0_only (bool) – 如果 True，则只有 rank 0 保存完整的状态字典，非零 rank 保存空字典。如果 False，则所有 rank 都保存完整的状态字典。（默认值：False）

class torch.distributed.fsdp.ShardedOptimStateDictConfig(offload_to_cpu=True, _use_dtensor=False)[source][source]¶

ShardedOptimStateDictConfig 是一个配置类，旨在与 StateDictType.SHARDED_STATE_DICT 一起使用。

变量: _use_dtensor (bool) – 如果 True，则 FSDP 将状态字典值保存为 DTensor，如果 False，则 FSDP 将它们保存为 ShardedTensor。（默认值：False）

警告

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

class torch.distributed.fsdp.LocalOptimStateDictConfig(offload_to_cpu: bool = False)[source][source]¶

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)[source][source]¶

FullyShardedDataParallel¶

文档

教程

资源