Skip to content

Commit

Permalink
[Data] Fix documentation link for local shuffle (#40291)
Browse files Browse the repository at this point in the history
This link for local shuffle from followed places are broken:
* https://docs.ray.io/en/master/data/transforming-data.html#shuffling-rows
* https://docs.ray.io/en/master/data/api/doc/ray.data.Dataset.random_shuffle.html

This PR fixs the issue.

Signed-off-by: Cheng Su <[email protected]>
  • Loading branch information
c21 committed Oct 16, 2023
1 parent 8310ce1 commit c49b8ed
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/source/data/transforming-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ To randomly shuffle all rows, call :meth:`~ray.data.Dataset.random_shuffle`.
.. tip::

:meth:`~ray.data.Dataset.random_shuffle` is slow. For better performance, try
`Iterating over batches with shuffling <iterating-over-data#iterating-over-batches-with-shuffling>`_.
:ref:`Iterating over batches with shuffling <iterating-over-batches-with-shuffling>`.

Repartitioning data
===================
Expand Down
2 changes: 1 addition & 1 deletion python/ray/data/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,7 @@ def random_shuffle(
.. tip::
This method can be slow. For better performance, try
`Iterating over batches with shuffling <iterating-over-data#iterating-over-batches-with-shuffling>`_.
:ref:`Iterating over batches with shuffling <iterating-over-batches-with-shuffling>`.
Also, see :ref:`Optimizing shuffles <optimizing_shuffles>`.
Examples:
Expand Down

0 comments on commit c49b8ed

Please sign in to comment.