[Docs] Add PyTorch Lightning examples to Tune examples README (#54954)#63438
Open
dstrodtman wants to merge 1 commit into
Open
[Docs] Add PyTorch Lightning examples to Tune examples README (#54954)#63438dstrodtman wants to merge 1 commit into
dstrodtman wants to merge 1 commit into
Conversation
…oject#54954) Users navigating to python/ray/tune/examples on GitHub previously found no PyTorch Lightning entry, even though mnist_ptl_mini.py and mlflow_ptl.py live in that directory. Add a PyTorch Lightning Examples section to python/ray/tune/examples/README.rst that lists the surviving scripts and links to the tune-pytorch-lightning walkthrough. Closes ray-project#54954 [DOC-965] Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds a new section for PyTorch Lightning examples to the Ray Tune examples README, including links to a tutorial and two example scripts. Feedback focuses on improving the consistency of the example descriptions and specifically mentioning the MLflow autologging feature in the relevant script description.
| For a full walkthrough of tuning a PyTorch Lightning model with Ray Tune, see the | ||
| `Using PyTorch Lightning with Tune <https://docs.ray.io/en/latest/tune/examples/tune-pytorch-lightning.html>`__ tutorial. | ||
|
|
||
| - `mnist_ptl_mini <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mnist_ptl_mini.py>`__: A minimal example of tuning a PyTorch Lightning MNIST classifier with Ray Tune. |
Contributor
There was a problem hiding this comment.
For consistency with other entries in this file, consider removing the leading 'A ' and using 'Tune' instead of 'Ray Tune'.
Suggested change
| - `mnist_ptl_mini <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mnist_ptl_mini.py>`__: A minimal example of tuning a PyTorch Lightning MNIST classifier with Ray Tune. | |
| - `mnist_ptl_mini <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mnist_ptl_mini.py>`__: Minimal example of tuning a PyTorch Lightning MNIST classifier with Tune. |
| `Using PyTorch Lightning with Tune <https://docs.ray.io/en/latest/tune/examples/tune-pytorch-lightning.html>`__ tutorial. | ||
|
|
||
| - `mnist_ptl_mini <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mnist_ptl_mini.py>`__: A minimal example of tuning a PyTorch Lightning MNIST classifier with Ray Tune. | ||
| - `mlflow_ptl <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mlflow_ptl.py>`__: Example for using `MLflow <https://github.com/mlflow/mlflow/>`__ and PyTorch Lightning with Ray Tune. |
Contributor
There was a problem hiding this comment.
The mlflow_ptl.py script specifically demonstrates MLflow's autologging feature. It would be helpful to mention this in the description. Also, 'Example of using' and 'Tune' are more consistent with the rest of the file.
Suggested change
| - `mlflow_ptl <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mlflow_ptl.py>`__: Example for using `MLflow <https://github.com/mlflow/mlflow/>`__ and PyTorch Lightning with Ray Tune. | |
| - `mlflow_ptl <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/mlflow_ptl.py>`__: Example of using `MLflow <https://github.com/mlflow/mlflow/>`__ autologging and PyTorch Lightning with Tune. |
ray-gardener
Bot
added
tune
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
The reporter followed a stale link from a 2022 issue to
python/ray/tune/exampleslooking for a PyTorch Lightning example script. The historicalmnist_pytorch_lightning.pyis gone, but two surviving Lightning scripts (mnist_ptl_mini.py,mlflow_ptl.py) still live in that directory and aren't mentioned in the directory'sREADME.rst. This PR adds aPyTorch Lightning Examplessection topython/ray/tune/examples/README.rstthat names those scripts and links to thetune-pytorch-lightningwalkthrough so users browsing the examples folder on GitHub can find Lightning content.Related issues
Closes #54954
[DOC-965]
Additional information
python/ray/tune/examples/README.rstmnist_pytorch_lightning.py, so this PR doesn't update any inbound links — it surfaces the existing Lightning examples that were previously hidden from the README's index.🤖 Generated with Claude Code