[train/tune] Raise actionable error message for missing dependencies #38497
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
added 2 commits
August 16, 2023 17:46
Signed-off-by: Kai Fricke <kai@anyscale.com>
justinvyu
reviewed
Aug 16, 2023
ericl
added
the
@author-action-required
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
…ay-project#38497) When users `pip install ray` but not `ray[train]`/`ray[tune]`, they can run into confusing error messages, such as: ``` ModuleNotFoundError: No module named 'pyarrow' ``` With this PR, we import the core library requirements in the respective `__init__.py` and raise an actionable error message if they are not found: ``` ImportError: Can't import ray.train as some dependencies are missing. Run `pip install ray[train]` to fix. ``` Signed-off-by: Kai Fricke <kai@anyscale.com> Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao
pushed a commit
to vymao/ray
that referenced
this pull request
Oct 11, 2023
…ay-project#38497) When users `pip install ray` but not `ray[train]`/`ray[tune]`, they can run into confusing error messages, such as: ``` ModuleNotFoundError: No module named 'pyarrow' ``` With this PR, we import the core library requirements in the respective `__init__.py` and raise an actionable error message if they are not found: ``` ImportError: Can't import ray.train as some dependencies are missing. Run `pip install ray[train]` to fix. ``` Signed-off-by: Kai Fricke <kai@anyscale.com> Signed-off-by: Victor <vctr.y.m@example.com>
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?
When users
pip install raybut notray[train]/ray[tune], they can run into confusing error messages, such as:With this PR, we import the core library requirements in the respective
__init__.pyand raise an actionable error message if they are not found: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.