[train+tune][doc] Remove docs sections recommending RAY_AIR_LOCAL_CACHE_DIR
#44284
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
Signed-off-by: Justin Yu <[email protected]>
Signed-off-by: Justin Yu <[email protected]>
justinvyu
requested review from
matthewdeng,
woshiyyya and
a team
as code owners
Signed-off-by: Justin Yu <[email protected]>
matthewdeng
reviewed
Mar 26, 2024
Comment on lines
398
to
405
| Prior to 2.10, the ``RAY_AIR_LOCAL_CACHE_DIR`` environment variable was the way to configure | ||
| the local staging directory to be outside of the home directory (``~/ray_results``). | ||
|
|
||
| ``RunConfig(local_dir)`` was another deprecated alternative to set the local staging directory. | ||
|
|
||
| These options are now deprecated, and you should instead set ``storage_path``. | ||
| When ``storage_path`` is set, there will no longer be any files written to | ||
| ``~/ray_results`` starting from Ray 2.10. |
There was a problem hiding this comment.
This is a bit confusing since there's a bunch of branching logic based on env var / storage path. Could we maybe simplify this to just focus on the staging directory being set by RAY_AIR_LOCAL_CACHE_DIR or local_dir? And not talk about storage_path?
There was a problem hiding this comment.
I kept the mention about switching to storage path as a migration path, because users were setting ONLY the environment variable. But now that the env variable doesn't do anything, they need to switch to setting storage path.
matthewdeng
approved these changes
Mar 29, 2024
Signed-off-by: Justin Yu <[email protected]>
justinvyu
added a commit
to justinvyu/ray
that referenced
this pull request
Apr 2, 2024
…CHE_DIR` (ray-project#44284) Removes docs that recommend using the `RAY_AIR_LOCAL_CACHE_DIR` env variable. --------- Signed-off-by: Justin Yu <[email protected]>
Merged
8 tasks
khluu
added a commit
that referenced
this pull request
Apr 3, 2024
…CHE_DIR` (#44284) (#44422) This is a docs only cherry-pick of #44284 Removes docs that recommend using the `RAY_AIR_LOCAL_CACHE_DIR` env variable. --------- Signed-off-by: Justin Yu <[email protected]> Co-authored-by: Kevin H. Luu <[email protected]>
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
…CHE_DIR` (ray-project#44284) Removes docs that recommend using the `RAY_AIR_LOCAL_CACHE_DIR` env variable. --------- Signed-off-by: Justin Yu <[email protected]>
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?
The recent local directory refactor (#43369, #43403, #43689) removed usage of the environment variable
RAY_AIR_LOCAL_CACHE_DIRfor configuring the local staging dir.The local staging directory is now a subdirectory of the Ray temp session dir (
/tmp/ray/session_*), and the customization of this directory location is now offloaded to Ray Core (ray.init(_temp_dir="/tmp/custom")).This PR updates docs to reflect this new behavior.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.