Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] update batch guide link, fix tensor ref #35171

Merged
merged 2 commits into from
May 10, 2023
Merged

[docs] update batch guide link, fix tensor ref #35171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10041f6
[docs] update batch guide link, fix tensor ref
maxpumperla May 9, 2023
de4271f
Merge branch 'master' into mp_ref_batch_guide
maxpumperla May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/source/data/data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Streaming Batch Inference
-------------------------

Ray Data simplifies general purpose parallel GPU and CPU compute in Ray through its
powerful :ref:`Dataset <dataset_concept>` primitive. Datasets enable workloads such as
:ref:`GPU batch inference <ref-use-cases-batch-infer>` to run efficiently on large datasets,
powerful :ref:`Datastream <datastream_concept>` primitive. Datastreams enable workloads such as
:doc:`GPU batch inference <batch_inference>` to run efficiently on large datasets,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my own understanding, when would I want to use ::doc: instead of :ref:?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, doc is for reference by filename, ref is by explicit reference of the form .. ref-foo-bar:. the latter is more granular, as you can point it to subsections etc. too

maximizing resource utilization by keeping the working data fitting into Ray object store memory.

.. image:: images/stream-example.png
Expand Down Expand Up @@ -117,7 +117,7 @@ Advanced users can refer directly to the Ray Data :ref:`API reference <data-api>
Learn how to :ref:`load data <loading_data>`, :ref:`save
data <saving_data>`, :ref:`transform data <transforming_data>`,
:ref:`access and exchange data <consuming_data>`, or
:ref:`work with tensor data <data_tensor_support>`.
:ref:`work with tensor data <working_with_tensors>`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! strangely the warning for this was only surfaced after I introduced a typo in the other ref... we might have more of those


+++
.. button-ref:: data_user_guide
Expand Down