torch.testing

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 是 meta tensor，則僅執行屬性檢查。

如果 actual 和 expected 是稀疏張量（具有 COO、CSR、CSC、BSR 或 BSC 佈局），則分別檢查其跨步成員。索引部分，即 COO 的 indices，CSR 和 BSR 的 crow_indices 和 col_indices，或 CSC 和 BSC 佈局的 ccol_indices 和 row_indices，總是檢查是否相等，而值則根據上述定義檢查是否接近。

如果 actual 和 expected 是量化的，則它們在具有相同的 qscheme() 且 dequantize() 的結果根據上述定義接近時被視為接近。

actual 和 expected 可以是 Tensor 或任何可以透過 torch.as_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 的張量轉換為跨步張量後再進行比較。

• check_stride (bool) – 如果為 True 且對應的張量是跨步的，斷言它們具有相同的 stride。

• msg (Optional[Union[str, Callable[[str], str]]]) – 比較失敗時使用的可選錯誤訊息。也可以作為可呼叫物件傳遞，在這種情況下，它將使用生成的錯誤訊息呼叫，並應返回新的訊息。

丟擲

• 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，但對應的跨步張量沒有相同的 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
其他	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
布林型別	0	2
無符號整型	0	10
有符號整型	-9	10
浮點型別	-9	9
複數型別	-9	9

引數

• shape (Tuple[int, ...]) – 定義輸出張量形狀的單個整數或整數序列。

• dtype (torch.dtype) – 返回張量的資料型別。

• device (Union[str, torch.device]) – 返回張量的 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]) – 如果 autograd 應該記錄返回張量上的操作。預設值：False。

• noncontiguous (Optional[bool]) – 如果 True，返回的張量將是非連續的。如果構造的張量少於兩個元素，則忽略此引數。與 memory_format 互斥。

• exclude_zero (Optional[bool]) – 如果為 True，則根據 dtype 將零替換為 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。

返回型別

Tensor

示例

>>> 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()。您可以在此處找到詳細的升級說明。