added documentation for masked_fill and masked_fill_

julurisaichandu · julurisaichandu · commit f3ac95befbd0 · 2025-03-16T20:54:41.000-04:00
diff --git a/torch/_tensor_docs.py b/torch/_tensor_docs.py
@@ -3185,6 +3185,15 @@ def callable(a, b) -> number
 Args:
     mask (BoolTensor): the boolean mask
     value (float): the value to fill in with
+
+Example:
+    >>> self = torch.tensor([[1, 2, 3, 4, 5], [6, 7, 8, 9, 10]])
+    >>> mask = torch.tensor([[0, 1, 0, 1, 0], [1, 0, 1, 0, 1]], dtype=torch.bool)
+    >>> self.masked_fill_(mask, -1)
+    >>> self
+    tensor([[ 1, -1,  3, -1,  5],
+            [-1,  7, -1,  9, -1]])
+            
 """,
 )
 
@@ -6587,6 +6596,14 @@ def callable(a, b) -> number
 masked_fill(mask, value) -> Tensor
 
 Out-of-place version of :meth:`torch.Tensor.masked_fill_`
+
+Example:
+    >>> self = torch.tensor([[1, 2, 3, 4, 5], [6, 7, 8, 9, 10]])
+    >>> mask = torch.tensor([[0, 1, 0, 1, 0], [1, 0, 1, 0, 1]], dtype=torch.bool)
+    >>> self.masked_fill(mask, -1)
+    tensor([[ 1, -1,  3, -1,  5],
+            [-1,  7, -1,  9, -1]])
+
 """,
 )
 
