Commit 8a1dc90
[docs] Add guidance for matching Ray and Python versions with uv envi… (#56597)
**docs: Add important note about using `uv run --active` to avoid Python
version mismatch errors**
- Added best practices for launching Ray applications with uv.
<!-- Thank you for your contribution! Please review
https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before
opening a pull request. -->
<!-- Please add a reviewer to the assignee section when you create a PR.
If you don't have the access to it, we will shortly find a reviewer and
assign them to your PR. -->
## Why are these changes needed?
This change adds a prominent note to the dependency management
documentation, warning users to use `uv run --active` to avoid Python
version mismatches and related runtime errors when launching Ray
applications. This addresses a common pitfall and improves the developer
experience.
## Related issue number
Closes #56583
## Checks
- [x] I've signed off every commit (by using the -s flag, i.e., `git
commit -s`) in this PR.
- [x] I've run `scripts/format.sh` to lint the changes in this PR.
- [x] I've included any doc changes needed for
https://docs.ray.io/en/master/.
- [x] 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.
- [x] 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
- [x] This PR only updates documentation; no code changes to test.
---------
Signed-off-by: jitesh majety <[email protected]>
Signed-off-by: Philipp Moritz <[email protected]>
Co-authored-by: jitesh majety <[email protected]>
Co-authored-by: Philipp Moritz <[email protected]>
Signed-off-by: elliot-barn <[email protected]>1 parent f7235e5 commit 8a1dc90
1 file changed
+5
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
377 | 377 | | |
378 | 378 | | |
379 | 379 | | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
380 | 385 | | |
381 | 386 | | |
382 | 387 | | |
| |||
0 commit comments