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?
Doctests are flaky for three reasons:
tips-for-first-time.rst
is failing because Ray is re-initialized in some examples. This wasn't an issue before because most of the examples were skipped. However, after [Docs] Fix docstring examples with mocked outputs #35928, all of the examples are run. To fix this issue, I've added cleanup code that shutsdown Ray between examples.async_api.rst
is flaky because print calls from a previous example manifests in subsequent examples. To avoid flakiness, I've added a short sleep after the example that prints asynchronously.loading-data.rst
fails for one of two errors reasons: Either the Python frontend falsely determines that Ray is initialized, so the app complainsThe core worker process is not initialized yet or already shutdown.
; or, the Python frontend thinks Ray isn't initialized and tries to re-init, but the back is actually already initialized. In either case, it seems like the backend and frontend go out of sync. I wasn't able to figure out the underlying issue, so I'm disabling the test for now.Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.