torch.nn.utils.parametrize.register_parametrization

torch.nn.utils.parametrize.register_parametrization(module, tensor_name, parametrization, *, unsafe=False)

向模块中的张量注册参数化。

为简单起见，假设 tensor_name="weight"。访问 module.weight 时，模块将返回参数化版本 parametrization(module.weight)。如果原始张量需要梯度，则反向传播将通过 parametrization 进行微分，并且优化器将相应地更新张量。

模块第一次注册参数化时，此函数将向模块添加一个名为 parametrizations 的属性，其类型为 ParametrizationList。

张量 weight 上的参数化列表可以通过 module.parametrizations.weight 访问。

原始张量可以通过 module.parametrizations.weight.original 访问。

可以通过在同一属性上注册多个参数化来连接参数化。

注册参数化时，其训练模式将更新为与主机模块的训练模式匹配。

参数化参数和缓冲区具有内置的缓存系统，可以使用上下文管理器 cached() 激活。

一个 parametrization 可以选择性地实现一个具有以下签名的函数：

def right_inverse(self, X: Tensor) -> Union[Tensor, Sequence[Tensor]]

在注册第一个参数化时，此函数将在未参数化的张量上调用，以计算原始张量的初始值。如果没有实现此函数，则原始张量将只是未参数化的张量。

如果在张量上注册的所有参数化都实现了 right_inverse，则可以通过赋值来初始化参数化张量，如下面的示例所示。

第一个参数化可以依赖多个输入。这可以通过从 right_inverse 返回一个张量元组来实现（请参阅下面 RankOne 参数化的示例实现）。

在这种情况下，无约束张量也位于 module.parametrizations.weight 下，名称为 original0、original1 等。

注意

如果 unsafe=False（默认值），则将调用一次 forward 和 right_inverse 函数以执行一些一致性检查。如果 unsafe=True，则如果张量未参数化，则将调用 right_inverse，否则不会调用任何函数。

注意

在大多数情况下，right_inverse 将是一个函数，使得 forward(right_inverse(X)) == X（参见 右逆）。有时，当参数化不是满射时，可以合理地放松此条件。

警告

如果参数化依赖多个输入，则 register_parametrization() 将注册多个新参数。如果在创建优化器之后注册此类参数化，则需要手动将这些新参数添加到优化器中。请参阅 torch.Optimizer.add_param_group()。

参数

• module (nn.Module) – 要注册参数化的模块

• tensor_name (str) – 要注册参数化的参数或缓冲区的名称

• 参数化 (nn.Module) – 要注册的参数化

关键字参数

unsafe (bool) – 一个布尔标志，表示参数化是否可能更改张量的 dtype 和形状。默认值：False 警告：注册时不会检查参数化的一致性。启用此标志需自行承担风险。

引发异常

ValueError – 如果模块没有名为 tensor_name 的参数或缓冲区

返回类型

模块

示例

>>> import torch
>>> import torch.nn as nn
>>> import torch.nn.utils.parametrize as P
>>>
>>> class Symmetric(nn.Module):
>>>     def forward(self, X):
>>>         return X.triu() + X.triu(1).T  # Return a symmetric matrix
>>>
>>>     def right_inverse(self, A):
>>>         return A.triu()
>>>
>>> m = nn.Linear(5, 5)
>>> P.register_parametrization(m, "weight", Symmetric())
>>> print(torch.allclose(m.weight, m.weight.T))  # m.weight is now symmetric
True
>>> A = torch.rand(5, 5)
>>> A = A + A.T   # A is now symmetric
>>> m.weight = A  # Initialize the weight to be the symmetric matrix A
>>> print(torch.allclose(m.weight, A))
True

>>> class RankOne(nn.Module):
>>>     def forward(self, x, y):
>>>         # Form a rank 1 matrix multiplying two vectors
>>>         return x.unsqueeze(-1) @ y.unsqueeze(-2)
>>>
>>>     def right_inverse(self, Z):
>>>         # Project Z onto the rank 1 matrices
>>>         U, S, Vh = torch.linalg.svd(Z, full_matrices=False)
>>>         # Return rescaled singular vectors
>>>         s0_sqrt = S[0].sqrt().unsqueeze(-1)
>>>         return U[..., :, 0] * s0_sqrt, Vh[..., 0, :] * s0_sqrt
>>>
>>> linear_rank_one = P.register_parametrization(nn.Linear(4, 4), "weight", RankOne())
>>> print(torch.linalg.matrix_rank(linear_rank_one.weight).item())
1