Optimize torch.equal description (#149618)

zeshengzong · pytorchmergebot · commit 732f9d743577 · 2025-03-21T03:44:49.000Z
Fixes #149222 ## Test Result ![image](https://github.com/user-attachments/assets/559a376f-2dd0-4474-bbd5-9299d9df51e3) Pull Request resolved: #149618 Approved by: https://github.com/zou3519
diff --git a/torch/_torch_docs.py b/torch/_torch_docs.py
@@ -4014,14 +4014,20 @@ def merge_dicts(*dicts):
 
 ``True`` if two tensors have the same size and elements, ``False`` otherwise.
 
-Note that tensors containing NaNs are never equal to each other.
+.. note::
+
+    Tensors containing NaNs are never equal to each other. Additionally, this function does not
+    differentiate between the data types of the tensors during comparison. For more thorough tensor checks,
+    use :meth:`torch.testing.assert_close`.
 
 Example::
 
     >>> torch.equal(torch.tensor([1, 2]), torch.tensor([1, 2]))
     True
     >>> torch.equal(torch.tensor([3, torch.nan]), torch.tensor([3, torch.nan]))
     False
+    >>> torch.equal(torch.tensor([1, 2, 3], dtype=torch.int32), torch.tensor([1, 2, 3], dtype=torch.float32))
+    True
 """,
 )
 
