[tune] Log a deprecation warning for local_dir
and related environment variables
#44029
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?
Log a deprecation warning if a user sets
RunConfig(local_dir)
, or either of the legacyRAY_AIR_LOCAL_CACHE_DIR
orTUNE_RESULT_DIR
environment variables.For the migration period before passing in
local_dir
raises a deprecation warning, pass throughlocal_dir
to setstorage_path
if that is not set.This PR also removes the remaining dependency on
RAY_AIR_LOCAL_CACHE_DIR
. The usage in Tune / RLlib is for running a Trainable manually, outside ofTuner.fit
, where a logger will now have its default directory set to a folder withinDEFAULT_STORAGE_PATH
. The difference is that this is now no longer configurable via env vars, but the manual trainable use case is not a common pattern and use mainly used for debugging purposes.Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.