SipHash

class torchrl.data.SipHash(as_tensor: bool = True)

一个用于计算给定张量的 SipHash 值的模块。

一个基于 python 中 SipHash 实现的哈希函数模块。

参数:

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

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

示例

>>> # Assuming we set PYTHONHASHSEED=0 prior to running this code
>>> a = torch.tensor([[0.1, 0.2], [0.3, 0.4], [0.5, 0.6]])
>>> b = a.clone()
>>> hash_module = SipHash(as_tensor=True)
>>> hash_a = hash_module(a)
>>> hash_a
tensor([-4669941682990263259, -3778166555168484291, -9122128731510687521])
>>> hash_b = hash_module(b)
>>> assert (hash_a == hash_b).all()

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, 可选) – 如果指定，所有参数都将被复制到该设备

返回:

self

返回类型:

Module

double() → T

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

注意

此方法就地修改模块。

返回:

self

返回类型:

Module

eval() → T

将模块设置为评估模式。

这仅对某些模块有效。有关它们在训练/评估模式下的行为的详细信息，请参阅特定模块的文档（如果它们受到影响），例如 Dropout、BatchNorm 等。

这等效于 self.train(False)。

有关 .eval() 和可能与其混淆的几种类似机制之间的比较，请参阅 在本地禁用梯度计算。

返回:

self

返回类型:

Module

extra_repr() → str

设置模块的额外表示。

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

float() → T

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

注意

此方法就地修改模块。

返回:

self

返回类型:

Module

forward(x: Tensor) → Union[Tensor, List[bytes]]

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

应该被所有子类重写。

注意

尽管前向传递的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行注册的钩子，而后者会静默地忽略它们。

get_buffer(target: str) → Tensor

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

有关此方法的功能以及如何正确指定 target 的更详细说明，请参阅 get_submodule 的文档字符串。

参数:

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

返回:

由 target 引用的缓冲区

返回类型:

torch.Tensor

Raises:

AttributeError – 如果目标字符串引用了无效路径或解析为非缓冲区的内容

get_extra_state() → Any

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

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

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

返回:

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

返回类型:

object

get_parameter(target: str) → Parameter

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

有关此方法的功能以及如何正确指定 target 的更详细说明，请参阅 get_submodule 的文档字符串。

参数:

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

返回:

由 target 引用的 Parameter

返回类型:

torch.nn.Parameter

Raises:

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 的运行时受 target 中模块嵌套程度的限制。针对 named_modules 的查询可以实现相同的结果，但它在传递模块的数量中是 O(N) 的。因此，对于一个简单的检查，以查看某些子模块是否存在，应始终使用 get_submodule。

参数:

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

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

Raises:

AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容

half() → T

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

注意

此方法就地修改模块。

返回:

self

返回类型:

Module

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

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

这也使得相关的参数和缓冲区成为不同的对象。因此，如果模块将在 IPU 上运行并在优化过程中，则应在构建优化器之前调用此方法。

注意

此方法就地修改模块。

参数:

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

返回:

self

返回类型:

Module

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

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

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

Warning

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

参数:

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

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

• assign (bool, optional) – 当 False 时，当前模块中张量的属性将被保留，而当 True 时，状态字典中张量的属性将被保留。唯一的例外是 Default: ``False` 的 requires_grad 字段

返回:

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

  由该模块但提供的 state_dict 中缺少的任何键。

• unexpected_keys 是一个字符串列表，其中包含此模块不

  期望但存在于提供的 state_dict 中的键。

返回类型:

NamedTuple 带有 missing_keys 和 unexpected_keys 字段

注意

如果参数或缓冲区注册为 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, 可选) – 如果指定，所有参数都将被复制到该设备

返回:

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 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，而只会传递给 forward。Hook 可以修改输出。它可以就地修改输入，但这不会对 forward 产生影响，因为 forward 是在 forward() 调用之后调用的。Hook 应该具有以下签名

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

如果 with_kwargs 是 True，则 forward hook 将被传递给 forward 函数的 kwargs，并期望返回可能被修改的输出。Hook 应该具有以下签名

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

参数:

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

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

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

• always_call (bool) – 如果 True，则无论在调用 Module 时是否引发异常，都将运行 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 pre-hook。

每次调用 forward() 之前，都会调用该 hook。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 将被传递给 forward 函数的 kwargs。并且如果 hook 修改了输入，则应同时返回 args 和 kwargs。Hook 应该具有以下签名

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

参数:

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

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

• with_kwargs (bool) – 如果为 true，则 hook 将被传递给 forward 函数的 kwargs。默认值：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 将仅对应于作为位置参数给出的输入，并且所有 kwarg 参数都将被忽略。grad_input 和 grad_output 中的条目对于所有非 Tensor 参数都将为 None。

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

Warning

当使用 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

注册模块的反向传播前置钩子。

每次计算模块的梯度时，都会调用该钩子。钩子应具有以下签名：

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

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

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

Warning

当使用反向传播钩子时，不允许就地修改输入，否则会引发错误。

参数:

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

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

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

注册一个后置钩子，在模块的 load_state_dict() 被调用后运行。

它应该具有以下签名：

hook(module, incompatible_keys) -> None

module 参数是注册此钩子的当前模块，incompatible_keys 参数是一个 NamedTuple，由属性 missing_keys 和 unexpected_keys 组成。missing_keys 是一个 list 的 str，包含缺失的键，unexpected_keys 是一个 list 的 str，包含意外的键。

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

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

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 之前将被调用的可调用钩子。

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

别名，用于 add_module()。

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

向模块添加一个参数。

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

参数:

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

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

register_state_dict_post_hook(hook)

为 state_dict() 方法注册一个后置钩子。

它应该具有以下签名：

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

注册的钩子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)

为 state_dict() 方法注册一个前置钩子。

它应该具有以下签名：

hook(module, prefix, keep_vars) -> None

注册的钩子可用于在进行 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。)

要使用新的子模块 Linear 覆盖 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数:

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

• module – 要将子模块设置为的模块。

Raises:

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

• AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容

share_memory() → T

参见 torch.Tensor.share_memory_()。

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

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

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

注意

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

Warning

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

Warning

请避免使用参数 destination，因为它并非为最终用户设计。

参数:

• destination (dict, optional) – 如果提供，模块的状态将被更新到 dict 中，并返回相同的对象。否则，将创建并返回一个 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（如果给定），但 dtype 保持不变。当设置 non_blocking 时，它会尝试相对于主机异步转换/移动（如果可能），例如，将带有固定内存的 CPU Tensor 移动到 CUDA 设备。

有关示例，请参见下文。

注意

此方法就地修改模块。

参数:

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

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

• tensor (torch.Tensor) – Tensor，其 dtype 和设备是此模块中所有参数和缓冲区所需的 dtype 和设备

• 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, 可选) – 如果指定，所有参数都将被复制到该设备

返回:

self

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

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

有关更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

参数:

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