torch.testing

创建于: 2021年5月7日 | 最后更新于: 2025年6月10日

torch.testing.assert_close(actual, expected, *, allow_subclasses=True, rtol=None, atol=None, equal_nan=False, check_device=True, check_dtype=True, check_layout=True, check_stride=False, msg=None)

断言 actual 和 expected 非常接近。

如果 actual 和 expected 是 strided、非量化的、实值且有限的，则它们被认为是接近的，如果

$$\lvert \text{actual} - \text{expected} \rvert \le \texttt{atol} + \texttt{rtol} \cdot \lvert \text{expected} \rvert$$

非有限值（-inf 和 inf）仅在它们相等时才被视为接近。NaN 仅当 equal_nan 为 True 时才被视为相等。

此外，它们仅在具有相同的

• device （如果 check_device 为 True），

• dtype （如果 check_dtype 为 True），

• layout （如果 check_layout 为 True），以及

• stride （如果 check_stride 为 True）时才被视为接近。

如果 actual 或 expected 是元张量，则仅执行属性检查。

如果 actual 和 expected 是稀疏的（具有 COO、CSR、CSC、BSR 或 BSC 布局），则会单独检查它们的 strided 成员。索引，即 COO 的 indices，CSR 和 BSR 的 crow_indices 和 col_indices，或者 CSC 和 BSC 布局的 ccol_indices 和 row_indices，总是被检查相等性，而值根据上述定义检查接近度。

如果 actual 和 expected 是量化的，则当它们具有相同的 qscheme() 并且 dequantize() 的结果根据上述定义接近时，它们才被视为接近。

actual 和 expected 可以是 Tensor 或任何可以从 torch.Tensor 构建的张量或标量类型。除了 Python 标量外，输入类型必须直接相关。此外，actual 和 expected 可以是 Sequence 或 Mapping，在这种情况下，如果它们的结构匹配并且所有元素都根据上述定义被认为是接近的，那么它们就被认为是接近的。

注意

Python 标量是类型关系要求的例外，因为它们的 type()，即 int、float 和 complex，等同于张量类型的 dtype。因此，可以检查不同类型的 Python 标量，但这需要 check_dtype=False。

参数

• actual (Any) – 实际输入。

• expected (Any) – 预期输入。

• allow_subclasses (bool) – 如果为 True（默认），并且除了 Python 标量之外，允许使用直接相关的类型的输入。否则需要类型相等。

• rtol (Optional[float]) – 相对容差。如果指定了 atol，则也必须指定。如果省略，则使用下表基于 dtype 选择的默认值。

• atol (Optional[float]) – 绝对容差。如果指定了 rtol，则也必须指定。如果省略，则使用下表基于 dtype 选择的默认值。

• equal_nan (Union[bool, str]) – 如果为 True，则两个 NaN 值将被视为相等。

• check_device (bool) – 如果为 True（默认），则断言相应的张量在相同的 device 上。如果禁用此检查，则将不同 device 上的张量移至 CPU 再进行比较。

• check_dtype (bool) – 如果为 True（默认），则断言相应的张量具有相同的 dtype。如果禁用此检查，则将具有不同 dtype 的张量提升到共同的 dtype（根据 torch.promote_types()）后再进行比较。

• check_layout (bool) – 如果为 True（默认），则断言相应的张量具有相同的 layout。如果禁用此检查，则将具有不同 layout 的张量转换为 strided 张量后再进行比较。

• check_stride (bool) – 如果为 True 且相应的张量是 strided 的，则断言它们具有相同的 stride。

• msg (Optional[Union[str, Callable[[str], str]]]) – 在比较期间发生失败时可用于错误消息的可选参数。也可以作为可调用对象传递，在这种情况下，它将使用生成的 msg 进行调用，并应返回新的消息。

引发

• ValueError – 如果无法从输入构造任何 torch.Tensor。

• ValueError – 如果仅指定了 rtol 或 atol。

• AssertionError – 如果相应的输入不是 Python 标量且不直接相关。

• AssertionError – 如果 allow_subclasses 为 False，但相应的输入不是 Python 标量且类型不同。

• AssertionError – 如果输入是 Sequence，但它们的长度不匹配。

• AssertionError – 如果输入是 Mapping，但它们的键集不匹配。

• AssertionError – 如果相应的张量不具有相同的 shape。

• AssertionError – 如果 check_layout 为 True，但相应的张量不具有相同的 layout。

• AssertionError – 如果只有其中一个相应张量是量化的。

• AssertionError – 如果相应的张量是量化的，但具有不同的 qscheme()。

• AssertionError – 如果 check_device 为 True，但相应的张量不在相同的 device 上。

• AssertionError – 如果 check_dtype 为 True，但相应的张量不具有相同的 dtype。

• AssertionError – 如果 check_stride 为 True，但相应的 strided 张量不具有相同的 stride。

• AssertionError – 如果相应张量的值根据上述定义不接近。

下表显示了不同 dtype 的默认 rtol 和 atol。如果 dtype 不匹配，则使用两种容差的最大值。

dtype	rtol	atol
float16	1e-3	1e-5
bfloat16	1.6e-2	1e-5
float32	1.3e-6	1e-5
float64	1e-7	1e-7
complex32	1e-3	1e-5
complex64	1.3e-6	1e-5
complex128	1e-7	1e-7
quint8	1.3e-6	1e-5
quint2x4	1.3e-6	1e-5
quint4x2	1.3e-6	1e-5
qint8	1.3e-6	1e-5
qint32	1.3e-6	1e-5
other	0.0	0.0

注意

assert_close() 具有高度可配置性，并带有严格的默认设置。鼓励用户使用 partial() 来适应他们的用例。例如，如果需要相等性检查，可以定义一个 assert_equal，该函数默认对所有 dtype 使用零容差。

>>> import functools
>>> assert_equal = functools.partial(torch.testing.assert_close, rtol=0, atol=0)
>>> assert_equal(1e-9, 1e-10)
Traceback (most recent call last):
...
AssertionError: Scalars are not equal!

Expected 1e-10 but got 1e-09.
Absolute difference: 9.000000000000001e-10
Relative difference: 9.0

示例

>>> # tensor to tensor comparison
>>> expected = torch.tensor([1e0, 1e-1, 1e-2])
>>> actual = torch.acos(torch.cos(expected))
>>> torch.testing.assert_close(actual, expected)

>>> # scalar to scalar comparison
>>> import math
>>> expected = math.sqrt(2.0)
>>> actual = 2.0 / math.sqrt(2.0)
>>> torch.testing.assert_close(actual, expected)

>>> # numpy array to numpy array comparison
>>> import numpy as np
>>> expected = np.array([1e0, 1e-1, 1e-2])
>>> actual = np.arccos(np.cos(expected))
>>> torch.testing.assert_close(actual, expected)

>>> # sequence to sequence comparison
>>> import numpy as np
>>> # The types of the sequences do not have to match. They only have to have the same
>>> # length and their elements have to match.
>>> expected = [torch.tensor([1.0]), 2.0, np.array(3.0)]
>>> actual = tuple(expected)
>>> torch.testing.assert_close(actual, expected)

>>> # mapping to mapping comparison
>>> from collections import OrderedDict
>>> import numpy as np
>>> foo = torch.tensor(1.0)
>>> bar = 2.0
>>> baz = np.array(3.0)
>>> # The types and a possible ordering of mappings do not have to match. They only
>>> # have to have the same set of keys and their elements have to match.
>>> expected = OrderedDict([("foo", foo), ("bar", bar), ("baz", baz)])
>>> actual = {"baz": baz, "bar": bar, "foo": foo}
>>> torch.testing.assert_close(actual, expected)

>>> expected = torch.tensor([1.0, 2.0, 3.0])
>>> actual = expected.clone()
>>> # By default, directly related instances can be compared
>>> torch.testing.assert_close(torch.nn.Parameter(actual), expected)
>>> # This check can be made more strict with allow_subclasses=False
>>> torch.testing.assert_close(
...     torch.nn.Parameter(actual), expected, allow_subclasses=False
... )
Traceback (most recent call last):
...
TypeError: No comparison pair was able to handle inputs of type
<class 'torch.nn.parameter.Parameter'> and <class 'torch.Tensor'>.
>>> # If the inputs are not directly related, they are never considered close
>>> torch.testing.assert_close(actual.numpy(), expected)
Traceback (most recent call last):
...
TypeError: No comparison pair was able to handle inputs of type <class 'numpy.ndarray'>
and <class 'torch.Tensor'>.
>>> # Exceptions to these rules are Python scalars. They can be checked regardless of
>>> # their type if check_dtype=False.
>>> torch.testing.assert_close(1.0, 1, check_dtype=False)

>>> # NaN != NaN by default.
>>> expected = torch.tensor(float("Nan"))
>>> actual = expected.clone()
>>> torch.testing.assert_close(actual, expected)
Traceback (most recent call last):
...
AssertionError: Scalars are not close!

Expected nan but got nan.
Absolute difference: nan (up to 1e-05 allowed)
Relative difference: nan (up to 1.3e-06 allowed)
>>> torch.testing.assert_close(actual, expected, equal_nan=True)

>>> expected = torch.tensor([1.0, 2.0, 3.0])
>>> actual = torch.tensor([1.0, 4.0, 5.0])
>>> # The default error message can be overwritten.
>>> torch.testing.assert_close(
...     actual, expected, msg="Argh, the tensors are not close!"
... )
Traceback (most recent call last):
...
AssertionError: Argh, the tensors are not close!
>>> # If msg is a callable, it can be used to augment the generated message with
>>> # extra information
>>> torch.testing.assert_close(
...     actual, expected, msg=lambda msg: f"Header\n\n{msg}\n\nFooter"
... )
Traceback (most recent call last):
...
AssertionError: Header

Tensor-likes are not close!

Mismatched elements: 2 / 3 (66.7%)
Greatest absolute difference: 2.0 at index (1,) (up to 1e-05 allowed)
Greatest relative difference: 1.0 at index (1,) (up to 1.3e-06 allowed)

Footer

torch.testing.make_tensor(*shape, dtype, device, low=None, high=None, requires_grad=False, noncontiguous=False, exclude_zero=False, memory_format=None)

使用给定的 shape、device 和 dtype 创建一个张量，并填充从 [low, high) 中均匀抽取的随机值。

如果指定了 low 或 high 并且它们超出了 dtype 的可表示有限值的范围，则它们将分别被裁剪到最低或最高可表示的有限值。如果为 None，则下表描述了 low 和 high 的默认值，这些值取决于 dtype。

dtype	low	high
boolean type	0	2
unsigned integral type	0	10
signed integral types	-9	10
floating types	-9	9
complex types	-9	9

参数

• shape (Tuple[int, ...]) – 定义输出张量形状的单个整数或整数序列。

• dtype (torch.dtype) – 返回张量的数据类型。

• device (Union[str, torch.device]) – 返回张量的设备。

• low (Optional[Number]) – 设置给定范围的下限（包含）。如果提供数字，则会将其裁剪到给定 dtype 的可表示的最小有限值。当为 None（默认）时，此值根据 dtype 确定（请参阅上表）。默认值：None。

• high (Optional[Number]) –

  设置给定范围的上限（不包含）。如果提供数字，则会将其裁剪到给定 dtype 的可表示的最大有限值。当为 None（默认）时，此值根据 dtype 确定（请参阅上表）。默认值：None。

  自 2.1 版本起已弃用： 将 low==high 传递给 make_tensor() 以用于浮点或复数类型，自 2.1 版本起已弃用，并将在 2.3 版本中删除。请改用 torch.full()。

• requires_grad (Optional[bool]) – 是否应自动记录返回张量上的操作。默认值：False。

• noncontiguous (Optional[bool]) – 如果为 True，则返回的张量将是非连续的。如果构造的张量少于两个元素，则忽略此参数。与 memory_format 互斥。

• exclude_zero (Optional[bool]) – 如果为 True，则零将被替换为根据 dtype 的小正值。对于布尔和整数类型，零被替换为一。对于浮点类型，它被替换为 dtype 的最小正正常数（dtype 的 finfo() 对象的“微小”值），对于复数类型，它被替换为一个实部和虚部都表示为该复数类型可表示的最小正正常数的复数。默认值 False。

• memory_format (Optional[torch.memory_format]) – 返回张量的内存格式。与 noncontiguous 互斥。

引发

• ValueError – 如果为整数 dtype 传递了 requires_grad=True。

• ValueError – 如果 low >= high。

• ValueError – 如果 low 或 high 为 nan。

• ValueError – 如果同时传递了 noncontiguous 和 memory_format。

• TypeError – 如果 dtype 不被此函数支持。

返回类型

张量

示例

>>> from torch.testing import make_tensor
>>> # Creates a float tensor with values in [-1, 1)
>>> make_tensor((3,), device="cpu", dtype=torch.float32, low=-1, high=1)
tensor([ 0.1205, 0.2282, -0.6380])
>>> # Creates a bool tensor on CUDA
>>> make_tensor((2, 2), device="cuda", dtype=torch.bool)
tensor([[False, False],
        [False, True]], device='cuda:0')

torch.testing.assert_allclose(actual, expected, rtol=None, atol=None, equal_nan=True, msg='')

警告

torch.testing.assert_allclose() 自 1.12 版本起已弃用，并将在未来版本中删除。请改用 torch.testing.assert_close()。您可以在 此处 找到详细的升级说明。