RandomProjectionHash

class torchrl.data.RandomProjectionHash(*, n_components: int | None = None, dtype_cast=torch.bfloat16, as_tensor: bool = True, init_method: Callable[[torch.Tensor], torch.Tensor | None] | None = None, **kwargs)

一个模块，它将随机投影与 SipHash 结合，以获得低维张量，更易于通过 SipHash 进行嵌入。

此模块需要安装 sklearn。

关键字参数:

• n_components (int, optional) – 投影的低维分量数量。默认为 16。

• dtype_cast (torch.dtype, optional) – 将投影转换为的数据类型。默认为 torch.bfloat16。

• as_tensor (bool, optional) – 如果为 True，则字节将通过内置的 hash 函数转换为整数并映射到张量。默认为 True。

• 警告: (..) – 此模块依赖于内置的 hash 函数。: 为了在不同运行中获得可重现的结果，必须在运行代码之前设置 PYTHONHASHSEED 环境变量（在代码执行期间更改此值无效）。

• init_method – TODO

add_module(name: str, module: Optional[Module]) → None

将子模块添加到当前模块。

可以使用给定的名称作为属性访问该模块。

参数:

• name (str) – 子模块的名称。可以从此模块使用给定的名称访问子模块

• module (Module) – 要添加到模块的子模块。

apply(fn: Callable[[Module], None]) → T

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

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

参数:

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

返回:

self

返回类型:

Module

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

bfloat16() → T

将所有浮点参数和缓冲区转换为 bfloat16 数据类型。

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

buffers(recurse: bool = True) → Iterator[Tensor]

返回模块缓冲区上的迭代器。

参数:

recurse (bool) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成此模块直接成员的缓冲区。

生成:

torch.Tensor – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children() → Iterator[Module]

返回直接子模块上的迭代器。

生成:

Module – 一个子模块

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的 forward 方法。

此模块的 __call__ 方法被编译，所有参数都按原样传递给 torch.compile()。

有关此函数参数的详细信息，请参阅 torch.compile()。

cpu() → T

将所有模型参数和缓冲区移动到 CPU。

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

cuda(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 GPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 GPU 上，则应在构建优化器之前调用此方法。

注意

此方法会就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

Module

double() → T

将所有浮点参数和缓冲区转换为 double 数据类型。

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

eval() → T

将模块设置为评估模式。

这只对某些模块有效。有关它们在训练/评估模式下的行为细节（即它们是否受影响），请参阅特定模块的文档，例如 Dropout、BatchNorm 等。

这等同于 self.train(False)。

有关 .eval() 与可能与它混淆的几种类似机制的比较，请参阅 局部禁用梯度计算。

返回:

self

返回类型:

Module

extra_repr() str

返回模块的额外表示。

要打印自定义的额外信息，您应该在自己的模块中重新实现此方法。单行和多行字符串都可以接受。

fit(x)

将随机投影拟合到输入数据。

float() → T

将所有浮点参数和缓冲区转换为 float 数据类型。

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

forward(x: Tensor) → Tensor

定义每次调用时执行的计算。

应被所有子类重写。

注意

虽然前向传播的步骤需要在函数内定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行注册的钩子，而后者会默默忽略它们。

get_buffer(target: str) → Tensor

返回由 target 指定的缓冲区（如果存在），否则抛出错误。

有关此方法功能的更详细解释以及如何正确指定 target，请参阅 get_submodule 的 docstring。

参数:

target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的缓冲区

返回类型:

torch.Tensor

抛出:

AttributeError – 如果目标字符串引用了无效路径或解析到的不是缓冲区

get_extra_state() → Any

返回要包含在模块 state_dict 中的任何额外状态。

如果需要存储额外状态，请为您的模块实现此方法和相应的 set_extra_state()。此函数在构建模块 state_dict() 时调用。

请注意，额外状态应该是可 pickle 的，以确保 state_dict 的序列化工作正常。我们仅为序列化张量提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生变化，可能会破坏向后兼容性。

返回:

要存储在模块 state_dict 中的任何额外状态

返回类型:

object

get_parameter(target: str) → Parameter

返回由 target 指定的参数（如果存在），否则抛出错误。

有关此方法功能的更详细解释以及如何正确指定 target，请参阅 get_submodule 的 docstring。

参数:

target – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的 Parameter

返回类型:

torch.nn.Parameter

抛出:

AttributeError – 如果目标字符串引用了无效路径或解析到的不是 nn.Parameter

get_submodule(target: str) → Module

返回由 target 指定的子模块（如果存在），否则抛出错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

（此图展示了一个 nn.Module A。A 有一个嵌套子模块 net_b，它本身有两个子模块 net_c 和 linear。net_c 接着有一个子模块 conv。）

要检查我们是否拥有 linear 子模块，我们可以调用 get_submodule("net_b.linear")。要检查我们是否拥有 conv 子模块，我们可以调用 get_submodule("net_b.net_c.conv")。

get_submodule 的运行时受目标中模块嵌套程度的限制。named_modules 的查询可以实现相同的结果，但在传递模块数量上是 O(N)。因此，对于检查某个子模块是否存在这种简单情况，应始终使用 get_submodule。

参数:

target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上面的示例。）

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

抛出:

AttributeError – 如果目标字符串引用了无效路径或解析到的不是 nn.Module

half() → T

将所有浮点参数和缓冲区转换为 half 数据类型。

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

ipu(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 IPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 IPU 上，则应在构建优化器之前调用此方法。

注意

此方法会就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

Module

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)

将参数和缓冲区从 state_dict 复制到此模块及其后代。

如果 strict 为 True，则 state_dict 的键必须与此模块 state_dict() 函数返回的键完全匹配。

警告

如果 assign 为 True，则除非 get_swap_module_params_on_conversion() 为 True，否则必须在调用 load_state_dict 之后创建优化器。

参数:

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• strict (bool, optional) – 是否严格执行 state_dict 中的键与此模块 state_dict() 函数返回的键匹配。默认为 True

• assign (bool, optional) – 设置为 False 时，保留当前模块中张量的属性；设置为 True 时，保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。 默认值： ``False``

返回:

• missing_keys 是一个字符串列表，包含此模块期望但所提供的 state_dict 中缺失的任何键。

• unexpected_keys 是一个字符串列表，包含此模块不期望但所提供的 state_dict 中存在的键。

返回类型:

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

如果参数或缓冲区注册为 None，并且其对应的键存在于 state_dict 中，则 load_state_dict() 将引发 RuntimeError。

modules() → Iterator[Module]

返回一个迭代器，用于迭代网络中的所有模块。

生成:

Module – 网络中的一个模块

注意

重复的模块只返回一次。在下面的示例中，l 将只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

mtia(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 MTIA。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果在优化时模块将位于 MTIA 上，则应在构建优化器之前调用此方法。

注意

此方法会就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

Module

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Tensor]]

返回一个迭代器，用于迭代模块缓冲区，产生缓冲区的名称以及缓冲区本身。

参数:

• prefix (str) – 要附加到所有缓冲区名称前的**前缀**。

• recurse (bool, 可选) – 如果为 True，则产生此模块和所有子模块的缓冲区。否则，只产生作为此模块直接成员的缓冲区。默认为 True。

• remove_duplicate (bool, 可选) – 是否删除结果中的重复缓冲区。默认为 True。

生成:

(str, torch.Tensor) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → Iterator[Tuple[str, Module]]

返回一个迭代器，用于迭代直接子模块，产生模块的名称以及模块本身。

生成:

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool =True)

返回一个迭代器，用于迭代网络中的所有模块，产生模块的名称以及模块本身。

参数:

• memo – 一个备忘录，用于存储已添加到结果中的模块集合

• prefix – 将添加到模块名称前的**前缀**

• remove_duplicate – 是否删除结果中的重复模块实例

生成:

(str, Module) – 包含名称和模块的元组

注意

重复的模块只返回一次。在下面的示例中，l 将只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.named_modules()):
...     print(idx, '->', m)

0 -> ('', Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
))
1 -> ('0', Linear(in_features=2, out_features=2, bias=True))

named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]

返回一个迭代器，用于迭代模块参数，产生参数的名称以及参数本身。

参数:

• prefix (str) – 要附加到所有参数名称前的**前缀**。

• recurse (bool) – 如果为 True，则产生此模块和所有子模块的参数。否则，只产生作为此模块直接成员的参数。

• remove_duplicate (bool, 可选) – 是否删除结果中的重复参数。默认为 True。

生成:

(str, Parameter) – 包含名称和参数的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse: bool = True) → Iterator[Parameter]

返回一个用于迭代模块参数的迭代器。

这通常会传递给优化器。

参数:

recurse (bool) – 如果为 True，则产生此模块和所有子模块的参数。否则，只产生作为此模块直接成员的参数。

生成:

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle

在模块上注册一个反向钩子。

此函数已弃用，推荐使用 register_full_backward_hook()，并且此函数的行为将在未来版本中更改。

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None

向模块添加一个缓冲区。

这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，但属于模块状态的一部分。缓冲区默认是持久的，并将与参数一起保存。通过将 persistent 设置为 False 可以更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别是后者将不属于此模块的 state_dict。

缓冲区可以使用给定的名称作为属性来访问。

参数:

• name (str) – 缓冲区的名称。可以使用给定的名称从此模块访问缓冲区

• tensor (Tensor 或 None) – 要注册的缓冲区。如果为 None，则在缓冲区上运行的操作（例如 cuda）将被忽略。如果为 None，则该缓冲区将**不**包含在模块的 state_dict 中。

• persistent (bool) – 缓冲区是否属于此模块的 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool =False, always_call: bool =False) → RemovableHandle

在模块上注册一个前向钩子。

每次在 forward() 计算出输出后，都会调用该钩子。

如果 with_kwargs 为 False 或未指定，则输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输出。它可以在原地修改输入，但这不会影响前向传播，因为此钩子在 forward() 调用后执行。该钩子应具有以下签名：

hook(module, args, output) -> None or modified output

如果 with_kwargs 为 True，前向钩子将接收传递给前向函数的 kwargs，并且应返回可能已修改的输出。该钩子应具有以下签名：

hook(module, args, kwargs, output) -> None or modified output

参数:

• hook (Callable) – 要注册的用户定义的钩子。

• prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在此方法注册的所有钩子之前触发。默认值： False

• with_kwargs (bool) – 如果为 True，则传递给前向函数的 kwargs 将传递给 hook。默认值： False

• always_call (bool) – 如果为 True，则无论在调用模块时是否引发异常，都会运行该 hook。默认值： False

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool =False) → RemovableHandle

在模块上注册一个前向预钩子。

每次在 forward() 调用之前，都会调用该钩子。

如果 with_kwargs 为 false 或未指定，则输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输入。用户可以在钩子中返回一个元组或一个修改后的单个值。如果返回单个值（除非该值已经是元组），我们将把该值包装在一个元组中。该钩子应具有以下签名：

hook(module, args) -> None or modified input

如果 with_kwargs 为 true，前向预钩子将接收传递给前向函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。该钩子应具有以下签名：

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

参数:

• hook (Callable) – 要注册的用户定义的钩子。

• prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在此方法注册的所有钩子之前触发。默认值： False

• with_kwargs (bool) – 如果为 true，则传递给前向函数的 kwargs 将传递给 hook。默认值： False

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模块上注册一个反向钩子。

每次计算模块的梯度时都会调用 hook，即，仅当计算模块输出的梯度时，hook 才会执行。hook 应具有以下签名

hook(module, grad_input, grad_output) -> tuple(Tensor) or None

grad_input 和 grad_output 是包含输入和输出梯度的元组。hook 不应修改其参数，但它可以选择性地返回新的输入梯度，该梯度将在后续计算中替换 grad_input 使用。grad_input 将仅对应于作为位置参数给出的输入，所有关键字参数将被忽略。grad_input 和 grad_output 中的条目对于所有非 Tensor 参数将为 None。

由于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图（view）。类似地，调用者将接收模块 forward 函数返回的每个 Tensor 的视图。

警告

使用 backward hook 时不允许就地修改输入或输出，否则会引发错误。

参数:

• hook (Callable) – 要注册的用户定义 hook。

• prepend (bool) – 如果为 true，提供的 hook 将在此 torch.nn.modules.Module 上所有现有的 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有的 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模块上注册一个 backward pre-hook。

每次计算模块的梯度时都会调用 hook。hook 应具有以下签名

hook(module, grad_output) -> tuple[Tensor] or None

grad_output 是一个元组。hook 不应修改其参数，但它可以选择性地返回新的输出梯度，该梯度将在后续计算中替换 grad_output 使用。grad_output 中的条目对于所有非 Tensor 参数将为 None。

由于技术原因，当此 hook 应用于模块时，其 forward 函数将接收传递给该模块的每个 Tensor 的视图（view）。类似地，调用者将接收模块 forward 函数返回的每个 Tensor 的视图。

警告

使用 backward hook 时不允许就地修改输入，否则会引发错误。

参数:

• hook (Callable) – 要注册的用户定义 hook。

• prepend (bool) – 如果为 true，提供的 hook 将在此 torch.nn.modules.Module 上所有现有的 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有的 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

注册一个 post-hook，在模块的 load_state_dict() 被调用后运行。

它应具有以下签名：

hook(module, incompatible_keys) -> None

module 参数是此 hook 注册到的当前模块，而 incompatible_keys 参数是一个 NamedTuple，包含属性 missing_keys 和 unexpected_keys。missing_keys 是一个包含缺失键的 str 列表，而 unexpected_keys 是一个包含意外键的 str 列表。

如果需要，可以就地修改给定的 incompatible_keys。

请注意，如预期所示，当使用 strict=True 调用 load_state_dict() 时执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 所做修改的影响。向任何一组键添加内容都会在使用 strict=True 时导致抛出错误，清空所有缺失和意外键将避免错误。

返回:

一个句柄，通过调用 handle.remove() 可用于移除已添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

注册一个 pre-hook，在模块的 load_state_dict() 被调用前运行。

它应具有以下签名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数:

hook (Callable) – 在加载 state dict 前将被调用的可调用 hook。

register_module(name: str, module: Optional[Module]) → None

add_module() 的别名。

register_parameter(name: str, param: Optional[Parameter]) → None

向模块添加一个参数。

可以使用给定的名称作为属性访问该参数。

参数:

• name (str) – 参数的名称。可以使用此名称从当前模块访问该参数

• param (Parameter or None) – 要添加到模块的参数。如果为 None，则在参数上运行的操作（例如 cuda）将被忽略。如果为 None，则该参数将**不**包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)

为 state_dict() 方法注册一个 post-hook。

它应具有以下签名：

hook(module, state_dict, prefix, local_metadata) -> None

注册的 hook 可以就地修改 state_dict。

register_state_dict_pre_hook(hook)

为 state_dict() 方法注册一个 pre-hook。

它应具有以下签名：

hook(module, prefix, keep_vars) -> None

注册的 hook 可用于在调用 state_dict 之前执行预处理。

requires_grad_(requires_grad: bool = True) → T

更改 autograd 是否应记录此模块中参数上的操作。

此方法就地设置参数的 requires_grad 属性。

此方法对于冻结模块的部分进行微调或单独训练模型的部分（例如 GAN 训练）很有帮助。

请参阅 局部禁用梯度计算，了解 .requires_grad_() 与一些可能与之混淆的类似机制之间的比较。

参数:

requires_grad (bool) – autograd 是否应记录此模块中参数上的操作。默认值：True。

返回:

self

返回类型:

Module

set_extra_state(state: Any) → None

设置加载的 state_dict 中包含的额外状态。

此函数由 load_state_dict() 调用，用于处理在 state_dict 中找到的任何额外状态。如果需要在模块的 state_dict 中存储额外状态，请为您的模块实现此函数以及相应的 get_extra_state()。

参数:

state (dict) – 来自 state_dict 的额外状态

set_submodule(target: str, module: Module) → None

如果存在，则设置由 target 指定的子模块，否则抛出错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(图示显示了一个 nn.Module A。`A` 包含一个嵌套子模块 net_b，该模块本身包含两个子模块 net_c 和 linear。然后 net_c 包含一个子模块 conv。)

要将 Conv2d 替换为新的子模块 Linear，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数:

• target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上面的示例。）

• module – 用于设置子模块的模块。

抛出:

• ValueError – 如果目标字符串为空

• AttributeError – 如果目标字符串引用了无效路径或解析到的不是 nn.Module

share_memory() → T

请参阅 torch.Tensor.share_memory_()。

state_dict(*args, destination=None, prefix='', keep_vars=False)

返回一个字典，其中包含对模块整个状态的引用。

参数和持久缓冲区（例如，运行平均值）都包含在内。键是相应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包含在内。

注意

返回的对象是浅拷贝。它包含对模块参数和缓冲区的引用。

警告

目前，state_dict() 也按顺序接受 destination、prefix 和 keep_vars 的位置参数。但是，此用法已被弃用，未来的版本将强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数:

• destination (dict, optional) – 如果提供，模块的状态将更新到此字典中，并返回同一对象。否则，将创建一个 OrderedDict 并返回。默认值：None。

• prefix (str, optional) – 添加到参数和缓冲区名称前的字符串，用于构成 state_dict 中的键。默认值：''。

• keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensor 会从 autograd 分离。如果设置为 True，则不会执行分离。默认值：False。

返回:

一个包含模块整个状态的字典

返回类型:

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

to(*args, **kwargs)

移动和/或转换参数和缓冲区。

可以按如下方式调用

to(device=None, dtype=None, non_blocking=False)

to(dtype, non_blocking=False)

to(tensor, non_blocking=False)

to(memory_format=torch.channels_last)

其签名与 torch.Tensor.to() 类似，但仅接受浮点或复数 dtype。此外，此方法仅将浮点或复数参数和缓冲区转换为 dtype（如果给定）。整型参数和缓冲区（如果给定 device）将被移动到 device，但 dtype 保持不变。当设置 non_blocking 时，它会尝试在可能的情况下相对于主机异步转换/移动，例如将具有锁定内存的 CPU Tensor 移动到 CUDA 设备。

参见下面的示例。

注意

此方法会就地修改模块。

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备

• dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点或复数 dtype

• tensor (torch.Tensor) – 其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device 的 Tensor

• memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式（仅限关键字参数）

返回:

self

返回类型:

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) → T

将参数和缓冲区移动到指定设备，而不复制存储。

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备。

• recurse (bool) – 是否应递归地将子模块的参数和缓冲区移动到指定设备。

返回:

self

返回类型:

Module

train(mode: bool = True) → T

将模块设置为训练模式。

这仅对某些模块有效。请参阅特定模块的文档，了解它们在训练/评估模式下的行为详情，即它们是否受影响，例如 Dropout、BatchNorm 等。

参数:

mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。

返回:

self

返回类型:

Module

type(dst_type: Union[dtype, str]) → T

将所有参数和缓冲区转换为 dst_type。

注意

此方法会就地修改模块。

参数:

dst_type (type or string) – 期望的类型

返回:

self

返回类型:

Module

xpu(device: Optional[Union[int,device]] = None) → T

将所有模型参数和缓冲区移动到 XPU。

这也使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 XPU 上，则应在构造优化器之前调用此方法。

注意

此方法会就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

重置所有模型参数的梯度。

请参阅 torch.optim.Optimizer 下的类似函数以获取更多上下文。

参数:

set_to_none (bool) – 不设置为零，而是将梯度设置为 None。有关详细信息，请参阅 torch.optim.Optimizer.zero_grad()。