Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[tune] Log a deprecation warning for local_dir and related environment variables #44029

Merged

Conversation

justinvyu
Copy link
Contributor

@justinvyu justinvyu commented Mar 15, 2024

Why are these changes needed?

Log a deprecation warning if a user sets RunConfig(local_dir), or either of the legacy RAY_AIR_LOCAL_CACHE_DIR or TUNE_RESULT_DIR environment variables.

For the migration period before passing in local_dir raises a deprecation warning, pass through local_dir to set storage_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 of Tuner.fit, where a logger will now have its default directory set to a folder within DEFAULT_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

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • 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.
  • 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
    • Unit tests
    • Release tests
    • This PR is not tested :(

python/ray/tune/tune.py Outdated Show resolved Hide resolved
python/ray/tune/tune.py Outdated Show resolved Hide resolved
@matthewdeng
Copy link
Contributor

@sven1977 could you PTAL at the RLlib change? Thanks!

Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved from RLlib side.

@justinvyu justinvyu merged commit 835e126 into ray-project:master Apr 5, 2024
5 checks passed
@justinvyu justinvyu deleted the localdir_deprecation_warnings branch April 5, 2024 17:46
ryanaoleary pushed a commit to ryanaoleary/ray that referenced this pull request Jun 7, 2024
…ent variables (ray-project#44029)

Log a deprecation warning if a user sets `RunConfig(local_dir)`, or either of the legacy `RAY_AIR_LOCAL_CACHE_DIR` or `TUNE_RESULT_DIR` environment variables.

---------

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants