Add documentation for installing additional packages#29
Open
mattshax wants to merge 3 commits into
Open
Conversation
Clarifies that ray[default] doesn't include deep learning libraries and shows how to install PyTorch/TensorFlow for GPU workloads.
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to help users install deep learning libraries (PyTorch and TensorFlow) in their Ray virtual environment, since the default ray[default] installation doesn't include them.
Changes:
- Added a new "Installing Additional Packages" section explaining how to install PyTorch or TensorFlow
- Clarified that
examples/gpu_workload.pyworks without PyTorch but displays "PyTorch not available" messages unless PyTorch is installed
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+75
to
+76
| # Or install TensorFlow | ||
| uv pip install --python ~/pw/activate-ray/ray_venv/bin/python tensorflow |
There was a problem hiding this comment.
The comment says "Install PyTorch with CUDA support" but the command pip install torch will install the CPU-only version by default. To install PyTorch with CUDA support, you need to specify the appropriate PyTorch index URL or follow PyTorch's installation instructions for CUDA-enabled versions. Consider either:
- Updating the command to include CUDA support (e.g., using PyTorch's recommended installation command with the correct index URL)
- Changing the comment to clarify that this installs the default version and users should consult PyTorch documentation for CUDA-specific installations
- Removing the "with CUDA support" phrase from the comment if the intention is just to install the default version
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
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.
Summary
ray[default]doesn't include deep learning librariesgpu_workload.pyshows "PyTorch not available" unless installedTest plan