docs: Add warning to torch.repeat() (#8116)

Ir1d · soumith · commit ee0b75a3d2b6 · 2018-06-05T10:15:36.000-04:00
* docs: Add warning to torch.repeat() closes #7993 * docs: Add links for numpy functions * docs: Break the too long line
diff --git a/torch/_tensor_docs.py b/torch/_tensor_docs.py
@@ -1558,6 +1558,13 @@ def callable(a, b) -> number
 
 Unlike :meth:`~Tensor.expand`, this function copies the tensor's data.
 
+.. warning::
+
+    :func:`torch.repeat` behaves differently from
+    `numpy.repeat <https://docs.scipy.org/doc/numpy/reference/generated/numpy.repeat.html>`_,
+    but is more similar to
+    `numpy.tile <https://docs.scipy.org/doc/numpy/reference/generated/numpy.tile.html>`_.
+
 Args:
     sizes (torch.Size or int...): The number of times to repeat this tensor along each
         dimension
