from_modules

class tensordict.from_modules(*modules, as_module: bool = False, lock: bool = True, use_state_dict: bool = False, lazy_stack: bool = False, expand_identical: bool = False)

为 vmap 的 ensemable 学习/特征期望应用检索多个模块的参数。

参数:

modules (nn.Module 序列) – 要从中获取参数的模块。如果模块结构不同，则需要懒惰堆叠（请参阅下面的 `lazy_stack` 参数）。

关键字参数:

• as_module (bool, optional) – 如果为 True，则将返回一个 TensorDictParams 实例，可用于在 torch.nn.Module 中存储参数。默认为 False。

• lock (bool, optional) – 如果为 True，则生成的 tensordict 将被锁定。默认为 True。

• use_state_dict (bool, optional) –

  如果为 True，则将使用模块的 state-dict 并将其解压到具有模型树结构的 TensorDict 中。默认为 False。

  注意

  这在使用 state-dict hook 时尤其有用。

• lazy_stack (bool, optional) –

  是否密集堆叠或懒惰堆叠参数。默认为 False（密集堆叠）。

  注意

  lazy_stack 和 as_module 是互斥的特性。

  警告

  懒惰输出和非懒惰输出之间有一个重要的区别：非懒惰输出将使用所需的批次大小重新实例化参数，而 `lazy_stack` 将仅将参数表示为懒惰堆叠。这意味着，虽然原始参数可以安全地传递给优化器（当 `lazy_stack=True` 时），但在设置为 `True` 时需要传递新参数。

  警告

  虽然使用 lazy stack 来保留原始参数引用可能很诱人，但请记住，每次调用 get() 时，lazy stack 都会执行堆栈操作。这将需要内存（参数大小的 N 倍，如果构建了图，则更多）和计算时间。它还意味着优化器将包含更多参数，像 step() 或 zero_grad() 这样的操作执行起来会更慢。总的来说，lazy_stack 应该只用于非常少的用例。

• expand_identical (bool, optional) – 如果为 True 且正在堆叠相同的参数（相同标识），则将返回该参数的扩展版本。当 lazy_stack=True 时，将忽略此参数。

示例

>>> from torch import nn
>>> from tensordict import from_modules
>>> torch.manual_seed(0)
>>> empty_module = nn.Linear(3, 4, device="meta")
>>> n_models = 2
>>> modules = [nn.Linear(3, 4) for _ in range(n_models)]
>>> params = from_modules(*modules)
>>> print(params)
TensorDict(
    fields={
        bias: Parameter(shape=torch.Size([2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        weight: Parameter(shape=torch.Size([2, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False)
>>> # example of batch execution
>>> def exec_module(params, x):
...     with params.to_module(empty_module):
...         return empty_module(x)
>>> x = torch.randn(3)
>>> y = torch.vmap(exec_module, (0, None))(params, x)
>>> assert y.shape == (n_models, 4)
>>> # since lazy_stack = False, backprop leaves the original params untouched
>>> y.sum().backward()
>>> assert params["weight"].grad.norm() > 0
>>> assert modules[0].weight.grad is None

当 lazy_stack=True 时，情况略有不同

>>> params = TensorDict.from_modules(*modules, lazy_stack=True)
>>> print(params)
LazyStackedTensorDict(
    fields={
        bias: Tensor(shape=torch.Size([2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        weight: Tensor(shape=torch.Size([2, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False)},
    exclusive_fields={
    },
    batch_size=torch.Size([2]),
    device=None,
    is_shared=False,
    stack_dim=0)
>>> # example of batch execution
>>> y = torch.vmap(exec_module, (0, None))(params, x)
>>> assert y.shape == (n_models, 4)
>>> y.sum().backward()
>>> assert modules[0].weight.grad is not None