isclose

paddle. isclose ( x: Tensor, y: Tensor, rtol: float = 1e-05, atol: float = 1e-08, equal_nan: bool = False, name: str | None = None ) → Tensor [source]

Check if all \(x\) and \(y\) satisfy the condition: .. math:

System Message: ERROR/3 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 3)

Unexpected indentation.

\left| x - y

System Message: WARNING/2 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 1)

Block quote ends without a blank line; unexpected unindent.

ight| leq atol + rtol imes left| y ight|

System Message: ERROR/3 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 6)

Unexpected indentation.

elementwise, for all elements of \(x\) and \(y\). The behaviour of this operator is analogous to \(numpy.isclose\), namely that it returns \(True\) if two tensors are elementwise equal within a tolerance. Args:

System Message: ERROR/3 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 10)

Unexpected indentation.

x(Tensor): The input tensor, it’s data type should be float16, float32, float64, complex64, complex128. y(Tensor): The input tensor, it’s data type should be float16, float32, float64, complex64, complex128. rtol(float, optional): The relative tolerance. Default: \(1e-5\) . atol(float, optional): The absolute tolerance. Default: \(1e-8\) . equal_nan(bool, optional): If \(True\) , then two \(NaNs\) will be compared as equal. Default: \(False\) . name (str|None, optional): Name for the operation. For more information, please

System Message: ERROR/3 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 16)

Unexpected indentation.

refer to api_guide_Name. Default: None.

System Message: WARNING/2 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 12)

Block quote ends without a blank line; unexpected unindent.

Returns:

Tensor: The output tensor, it’s data type is bool.

Examples:

System Message: ERROR/3 (/usr/local/lib/python3.10/site-packages/paddle/base/dygraph/generated_tensor_methods_patch.py:docstring of paddle.base.dygraph.generated_tensor_methods_patch._isclose, line 15)

Error in “code-block” directive: maximum 1 argument(s) allowed, 99 supplied.

.. code-block:: python
    >>> import paddle
    >>> x = paddle.to_tensor([10000., 1e-07])
    >>> y = paddle.to_tensor([10000.1, 1e-08])
    >>> result1 = paddle.isclose(x, y, rtol=1e-05, atol=1e-08,
    ...                          equal_nan=False, name="ignore_nan")
    >>> print(result1)
    Tensor(shape=[2], dtype=bool, place=Place(cpu), stop_gradient=True,
    [True , False])
    >>> result2 = paddle.isclose(x, y, rtol=1e-05, atol=1e-08,
    ...                          equal_nan=True, name="equal_nan")
    >>> print(result2)
    Tensor(shape=[2], dtype=bool, place=Place(cpu), stop_gradient=True,
    [True , False])
    >>> x = paddle.to_tensor([1.0, float('nan')])
    >>> y = paddle.to_tensor([1.0, float('nan')])
    >>> result1 = paddle.isclose(x, y, rtol=1e-05, atol=1e-08,
    ...                          equal_nan=False, name="ignore_nan")
    >>> print(result1)
    Tensor(shape=[2], dtype=bool, place=Place(cpu), stop_gradient=True,
    [True , False])
    >>> result2 = paddle.isclose(x, y, rtol=1e-05, atol=1e-08,
    ...                          equal_nan=True, name="equal_nan")
    >>> print(result2)
    Tensor(shape=[2], dtype=bool, place=Place(cpu), stop_gradient=True,
    [True, True])