From ad40e19ca0773b9e121d49b65c8056d8437142c8 Mon Sep 17 00:00:00 2001 From: Eric Liang Date: Mon, 22 Aug 2022 16:41:51 -0700 Subject: [PATCH] [docs] Add the AIR technical whitepaper to our docs (#28053) --- README.rst | 2 ++ doc/source/ray-air/getting-started.rst | 2 +- doc/source/ray-contribute/whitepaper.rst | 6 ++++-- doc/source/ray-overview/learn-more.md | 1 + 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 07b2add96..ab7f15d21 100644 --- a/README.rst +++ b/README.rst @@ -64,6 +64,7 @@ More Information - `Documentation`_ - `Ray Architecture whitepaper`_ +- `Ray AIR Technical whitepaper`_ - `Exoshuffle: large-scale data shuffle in Ray`_ - `Ownership: a distributed futures system for fine-grained tasks`_ - `RLlib paper`_ @@ -81,6 +82,7 @@ More Information .. _`Objects`: https://docs.ray.io/en/latest/ray-core/objects.html .. _`Documentation`: http://docs.ray.io/en/latest/index.html .. _`Ray Architecture whitepaper`: https://docs.google.com/document/d/1lAy0Owi-vPz2jEqBSaHNQcy2IBSDEHyXNOQZlGuj93c/preview +.. _`Ray AIR Technical whitepaper`: https://docs.google.com/document/d/1bYL-638GN6EeJ45dPuLiPImA8msojEDDKiBx3YzB4_s/preview .. _`Exoshuffle: large-scale data shuffle in Ray`: https://arxiv.org/abs/2203.05072 .. _`Ownership: a distributed futures system for fine-grained tasks`: https://www.usenix.org/system/files/nsdi21-wang.pdf .. _`Ray paper`: https://arxiv.org/abs/1712.05889 diff --git a/doc/source/ray-air/getting-started.rst b/doc/source/ray-air/getting-started.rst index 3dd8edd3a..09e21a020 100644 --- a/doc/source/ray-air/getting-started.rst +++ b/doc/source/ray-air/getting-started.rst @@ -203,5 +203,5 @@ Next Steps - :ref:`air-key-concepts` - :ref:`air-examples-ref` -- :ref:`Deployment Guide ` - :ref:`API reference ` +- :ref:`Technical whitepaper ` diff --git a/doc/source/ray-contribute/whitepaper.rst b/doc/source/ray-contribute/whitepaper.rst index e2d5fa50a..be90b1fbb 100644 --- a/doc/source/ray-contribute/whitepaper.rst +++ b/doc/source/ray-contribute/whitepaper.rst @@ -1,8 +1,10 @@ .. _whitepaper: -Architecture Whitepaper -======================= +Architecture Whitepapers +======================== For an in-depth overview of Ray internals, check out the `Ray 1.0 Architecture whitepaper `__. For more about the scalability and performance of the Ray dataplane, see the `Exoshuffle paper `__. + +To learn about the technical design and value proposition of Ray AI Runtime (AIR) see the `Ray AIR Technical Whitepaper `__. diff --git a/doc/source/ray-overview/learn-more.md b/doc/source/ray-overview/learn-more.md index 0e6c74cf7..c04933a4a 100644 --- a/doc/source/ray-overview/learn-more.md +++ b/doc/source/ray-overview/learn-more.md @@ -46,6 +46,7 @@ Please raise an issue if any of the below links are broken, or if you'd like to ## Papers - [Ray 1.0 Architecture whitepaper](https://docs.google.com/document/d/1lAy0Owi-vPz2jEqBSaHNQcy2IBSDEHyXNOQZlGuj93c/preview) +- [Ray AIR Technical whitepaper](https://docs.google.com/document/d/1bYL-638GN6EeJ45dPuLiPImA8msojEDDKiBx3YzB4_s/preview) - [Exoshuffle: large-scale data shuffle in Ray](https://arxiv.org/abs/2203.05072) - [RLlib paper](https://arxiv.org/abs/1712.09381) - [RLlib flow paper](https://arxiv.org/abs/2011.12719)