返回顶部

API#

class onnxruntime.training.ORTModule(module: Module, debug_options: Optional[DebugOptions] = None)[source]#

基类：Module

扩展用户的 torch.nn.Module 模型，以利用 ONNX Runtime 的超快速训练引擎。

ORTModule 对用户的 torch.nn.Module 模型进行专门化，提供 forward()、backward() 以及所有其他 torch.nn.Module 的 API。

参数:

module (torch.nn.Module) – ORTModule 进行专门化的用户 PyTorch 模块
debug_options (DebugOptions, optional) – ORTModule 的调试选项。

初始化内部模块状态，nn.Module 和 ScriptModule 共享此状态。

forward(*inputs, **kwargs)[source]#

将 PyTorch 训练的 forward() 传递委托给 ONNX Runtime。

对 forward 的第一次调用会执行设置和检查步骤。在此调用期间，ORTModule 会确定该模块是否可以使用 ONNX Runtime 进行训练。因此，第一次 forward 调用执行所需的时间比后续调用要长。如果 ONNX Runtime 无法处理模型进行训练，则执行会中断。

参数:

inputs – PyTorch 模块 forward 方法的位置参数和可变位置参数输入。
kwargs – PyTorch 模块 forward 方法的关键字参数和可变关键字参数。

返回:

用户 PyTorch 模块定义的 forward 方法的预期输出。支持的输出值包括张量、嵌套的张量序列和嵌套的张量值字典。

add_module(name: str, module: Optional[Module]) → None[source]#: 由于 ORTModule 不支持向其添加模块，因此会引发 ORTModuleTorchModelException 异常

property module#

此模块包装的原始 torch.nn.Module。

此属性提供对原始模块上的方法和属性的访问。

apply(fn: Callable[[Module], None]) → T[source]#: 覆盖 apply()，将执行委托给 ONNX Runtime

train(mode: bool = True) → T[source]#: 覆盖 train()，将执行委托给 ONNX Runtime

state_dict(destination=None, prefix='', keep_vars=False)[source]#: 覆盖 state_dict()，将执行委托给 ONNX Runtime

load_state_dict(state_dict: OrderedDict[str, Tensor], strict: bool = True)[source]#: 覆盖 load_state_dict()，将执行委托给 ONNX Runtime

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

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

get_parameter(target: str) → Parameter#: 覆盖 get_parameter()

get_buffer(target: str) → Tensor#: 覆盖 get_buffer()

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

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

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

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

named_children() → Iterator[Module]#: 覆盖 named_children()

modules() → Iterator[Module]#: 覆盖 modules()

named_modules(*args, **kwargs)#: 覆盖 named_modules()

bfloat16() → T#

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

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#

返回模块的额外表示。

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

float() → T#

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

get_extra_state() → Any#

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

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

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

返回:: 存储在模块 state_dict 中的任何额外状态。
返回类型:: object

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
抛出:: AttributeError – 如果沿着 target 字符串形成的路径的任何一点，（子）路径解析为不存在的属性名称或不是 nn.Module 实例的对象。

half() → T#

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

注意

此方法会就地修改模块。

返回:: self
返回类型:: Module

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

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

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

注意

此方法会就地修改模块。

参数:: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回:: self
返回类型:: Module

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

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

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

注意

此方法会就地修改模块。

参数:: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回:: self
返回类型:: Module

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

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

此函数已弃用，推荐使用 register_full_backward_hook()。此函数的行为在未来版本中将发生变化。

返回:: 一个句柄，可以通过调用 handle.remove() 来移除添加的钩子
返回类型:: torch.utils.hooks.RemovableHandle

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 没有影响，因为此钩子是在 forward() 调用后被调用的。钩子应具有以下签名

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

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

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

参数:

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前触发。默认值: False
with_kwargs (bool) – 如果为 True，钩子将获得传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用模块时是否抛出异常，钩子都将运行。默认值: 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，正向预钩子将获得传递给 forward 函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应具有以下签名

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

参数:

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 true，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.Module 上的所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在通过此方法注册的所有钩子之前触发。默认值: False
with_kwargs (bool) – 如果为 true，钩子将获得传递给 forward 函数的 kwargs。默认值: False

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

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

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

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

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

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

警告

在使用反向钩子时，不允许在原地修改输入或输出，否则会抛出错误。

参数:

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

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

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

在模块上注册一个反向传播前置钩子。

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

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

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

警告

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

参数:

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，提供的 `hook` 将在此 torch.nn.Module 上所有现有 `backward_pre` 钩子之前触发。否则，提供的 `hook` 将在此 torch.nn.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` 是一个包含缺失键的 `str` 列表，`unexpected_keys` 是一个包含意外键的 `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_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 训练）。

请参阅 Locally disabling gradient computation，了解 `.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, strict: bool = False) → None#

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

注意

如果 `strict` 设置为 `False`（默认值），该方法将替换现有子模块或在父模块存在时创建新的子模块。如果 `strict` 设置为 `True`，该方法将仅尝试替换现有子模块，并在子模块不存在时抛出错误。

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

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(3, 3, 3)
        )
        (linear): Linear(3, 3)
    )
)

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

要将 `Conv2d` 覆盖为一个新的子模块 `Linear`，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(1, 1))，其中 `strict` 可以是 `True` 或 `False`

要向现有的 `net_b` 模块添加一个新的子模块 `Conv2d`，您可以调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))。

在上述示例中，如果您设置 `strict=True` 并调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)，将引发 AttributeError，因为 `net_b` 没有名为 `conv` 的子模块。

参数:

target – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串的信息，请参见上面的示例。）
module – 要将子模块设置为何值。
strict – 如果为 `False`，该方法将替换现有子模块或在父模块存在时创建新的子模块。如果为 `True`，该方法将仅尝试替换现有子模块，并在子模块尚不存在时抛出错误。

抛出:

ValueError – 如果 `target` 字符串为空或 `module` 不是 `nn.Module` 的实例。
AttributeError – 如果在 `target` 字符串形成的路径中的任何位置，(子)路径解析为不存在的属性名称或不是 `nn.Module` 实例的对象。

share_memory() → T#: 请参阅 torch.Tensor.share_memory_()。

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 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device
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

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()。