[Doc] Fix broken links in train documentation #44953
Merged
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
peytondmurray
requested review from
matthewdeng,
justinvyu,
woshiyyya and
a team
as code owners
woshiyyya
reviewed
Apr 25, 2024
peytondmurray
force-pushed
the
docs-fix-train-bad-links-39658
branch
from
9831cdc
to
6281f98
Compare
|
@peytondmurray we can go ahead and remove |
Signed-off-by: pdmurray <[email protected]>
peytondmurray
force-pushed
the
docs-fix-train-bad-links-39658
branch
from
6281f98
to
be28d5e
Compare
|
Removed. Should be good to merge once docs build+tests pass. |
aslonnie
reviewed
Apr 26, 2024
doc/source/train/examples/pytorch/torch_data_prefetch_benchmark/benchmark_example.rst
Show resolved
Hide resolved
aslonnie
approved these changes
Apr 26, 2024
aslonnie
approved these changes
Apr 26, 2024
There was a problem hiding this comment.
approved for docs, but @matthewdeng leaving this PR to you.
anyscalesam
added
the
triage
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?
This PR fixes a few broken links in the train library and documentation.
Related issue number
Partially addresses #39658.
@matthewdeng @justinvyu Before merging this, the
benchmark_example.rstis totally orphaned at the moment. It's not part of any example gallery, and there's no real way for people to find it on our docs. What should we do about that?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.