[docs][core] Improve Compiled Graphs docs #50627
Merged
+279
−207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dayshah
approved these changes
Feb 17, 2025
There was a problem hiding this comment.
some build failures that should be fixed by the comments
/home/docs/checkouts/readthedocs.org/user_builds/anyscale-ray/checkouts/50627/doc/source/ray-core/compiled-graph/quickstart.rst:57: WARNING: Enumerated list ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/anyscale-ray/checkouts/50627/doc/source/ray-core/compiled-graph/quickstart.rst:153: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/anyscale-ray/checkouts/50627/doc/source/ray-core/compiled-graph/quickstart.rst:266: WARNING: Inline literal start-string without end-string.
kevin85421
reviewed
Feb 17, 2025
There was a problem hiding this comment.
The Ray documentation team recommends using Vale, which defines several writing rules, such as avoiding the use of “we,” “will,” and parentheses, among others.
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Stephanie Wang <smwang@cs.washington.edu>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Stephanie Wang <smwang@cs.washington.edu>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Stephanie Wang <smwang@cs.washington.edu>
edoakes
approved these changes
Feb 25, 2025
| .. _compiled-graph-overlap: | ||
|
|
||
| Experimental: Overlapping communication and computation | ||
| ======================================================= | ||
|
|
||
| Compiled Graph currently provides experimental support for GPU communication and computation overlap. When you turn this feature on, it automatically overlaps the GPU communication with computation operations, thereby hiding the communication overhead and improving performance. |
There was a problem hiding this comment.
curious, why is this an experimental feature // not turned on by default? is there a behavior difference, or just not stable yet?
There was a problem hiding this comment.
It's not stable yet.
Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com> Signed-off-by: Stephanie Wang <smwang@cs.washington.edu>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
|
Pushed two commits to fix docs build |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
A few improvements:
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.