Skip to content

Commit

Permalink
[docs] Hide output of very verbose ipynb notebooks (#51140)
Browse files Browse the repository at this point in the history
## Why are these changes needed?

Some docs were failing to index properly due to their extremely long
length. I've hidden verbose cell outputs so that they index properly

## Related issue number

N/A

## Checks

- [x] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [ ] I've run `scripts/format.sh` to lint the changes in this PR.
- [ ] I've included any doc changes needed for
https://docs.ray.io/en/master/.
- [ ] I've added any new APIs to the API Reference. For example, if I
added a
method in Tune, I've added it in `doc/source/tune/api/` under the
           corresponding `.rst` file.
- [ ] I've made sure the tests are passing. Note that there might be a
few flaky tests, see the recent failures at https://flakey-tests.ray.io/
- Testing Strategy
   - [ ] Unit tests
   - [ ] Release tests
   - [ ] This PR is not tested :(

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
  • Loading branch information
crypdick authored Mar 6, 2025
1 parent 4a6fbd9 commit 8fb43eb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"metadata": {},
"outputs": [],
"source": [
"! pip install \"datasets\" \"evaluate\" \"accelerate==0.18.0\" \"transformers==4.26.0\" \"torch>=1.12.0\" \"deepspeed==0.12.3\""
"! pip install -q \"datasets\" \"evaluate\" \"accelerate==0.18.0\" \"transformers==4.26.0\" \"torch>=1.12.0\" \"deepspeed==0.12.3\""
]
},
{
Expand Down Expand Up @@ -626,7 +626,9 @@
"cell_type": "code",
"execution_count": 14,
"metadata": {
"tags": []
"tags": [
"hide-output"
]
},
"outputs": [
{
Expand Down
8 changes: 6 additions & 2 deletions doc/source/tune/examples/tune-pytorch-lightning.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"To run this example, you will need to install the following:\n",
"\n",
"```bash\n",
"$ pip install \"ray[tune]\" torch torchvision pytorch_lightning\n",
"$ pip install -q \"ray[tune]\" torch torchvision pytorch_lightning\n",
"```\n",
":::\n",
"\n",
Expand Down Expand Up @@ -415,7 +415,11 @@
{
"cell_type": "code",
"execution_count": 28,
"metadata": {},
"metadata": {
"tags": [
"hide-output"
]
},
"outputs": [
{
"data": {
Expand Down

0 comments on commit 8fb43eb

Please sign in to comment.