[CI] Run doc notebooks in CI #24816
Merged
[CI] Run doc notebooks in CI #24816
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
This reverts commit 1e80492.
maxpumperla
reviewed
May 17, 2022
| @@ -188,13 +168,13 @@ py_test_run_all_subdirectory( | |||
|
|
|||
|
|
|||
| # -------------------------------------------------------------------- | |||
| # Test all doc/source/ray-overview/doc_code snippets, used on ray.io | |||
| # Test all doc/source/ray-overview/doc_test snippets, used on ray.io | |||
maxpumperla
approved these changes
May 17, 2022
krfricke
approved these changes
May 17, 2022
maxpumperla
pushed a commit
that referenced
this pull request
May 18, 2022
Currently, we are not running doc notebooks in CI due to a bazel misconfiguration - we are using `glob` in a top level package in order to get the paths for the notebooks, but those are contained inside subpackages, which glob purposefully ignores. Therefore, the lists of notebooks to run are empty. This PR fixes that by: * Running the `py_test_run_all_notebooks` macro inside the relevant subpackages * Editing the `test_myst_doc.py` script to allow for recursive search for the target file, allowing to deal with mismatches between `name` and `data` arguments in `py_test_run_all_notebooks` * Setting the `allow_empty=False` flag inside `glob` calls in our macros to ensure that this oversight is caught early * Enabling detection of changes in doc folder for `*.ipynb` and `BUILD` files This PR also adds a GPU runner for doc tests, allowing one of our examples to pass - and setting the infra for more to come. Finally, a misconfigured path for one set of doc tests is also fixed.
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?
Currently, we are not running doc notebooks in CI due to a bazel misconfiguration - we are using
globin a top level package in order to get the paths for the notebooks, but those are contained inside subpackages, which glob purposefully ignores. Therefore, the lists of notebooks to run are empty. This PR fixes that by:py_test_run_all_notebooksmacro inside the relevant subpackagestest_myst_doc.pyscript to allow for recursive search for the target file, allowing to deal with mismatches betweennameanddataarguments inpy_test_run_all_notebooksallow_empty=Falseflag insideglobcalls in our macros to ensure that this oversight is caught early*.ipynbandBUILDfilesThis PR also adds a GPU runner for doc tests, allowing one of our examples to pass - and setting the infra for more to come. Finally, a misconfigured path for one set of doc tests is also fixed.
Related issue number
Checks
scripts/format.shto lint the changes in this PR.