[train] Create top-level ray.train aliases for public APIs#57758
Merged
justinvyu merged 15 commits intoray-project:masterfrom Oct 17, 2025
Merged
[train] Create top-level ray.train aliases for public APIs#57758justinvyu merged 15 commits intoray-project:masterfrom
justinvyu merged 15 commits intoray-project:masterfrom
Conversation
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors Ray Train's public API by creating top-level aliases for TrainingFailedError, WorkerGroupError, ControllerError, and TrainContext in the ray.train namespace. This is a good improvement for user experience, as it avoids imports from internal modules. The changes in the documentation and the __init__.py file are mostly correct. I've found a couple of minor issues regarding redundancy and consistency in __init__.py and have left specific comments with suggestions to address them.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
matthewdeng
approved these changes
Oct 15, 2025
doc/source/train/api/api.rst
Outdated
| ~train.v2.api.exceptions.WorkerGroupError | ||
| ~train.ControllerError | ||
| ~train.WorkerGroupError | ||
| ~train.TrainingFailedError |
Contributor
There was a problem hiding this comment.
curious how the generated doc looks like for this since it's just a union of the other two errors
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
aslonnie
approved these changes
Oct 17, 2025
Collaborator
aslonnie
left a comment
There was a problem hiding this comment.
approve for check_api_discrepancy change
justinyeh1995
pushed a commit
to justinyeh1995/ray
that referenced
this pull request
Oct 20, 2025
…ct#57758) Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com>
xinyuangui2
pushed a commit
to xinyuangui2/ray
that referenced
this pull request
Oct 22, 2025
…ct#57758) Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com> Signed-off-by: xgui <xgui@anyscale.com>
elliot-barn
pushed a commit
that referenced
this pull request
Oct 23, 2025
Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
landscapepainter
pushed a commit
to landscapepainter/ray
that referenced
this pull request
Nov 17, 2025
…ct#57758) Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Aydin-ab
pushed a commit
to Aydin-ab/ray-aydin
that referenced
this pull request
Nov 19, 2025
…ct#57758) Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>
Future-Outlier
pushed a commit
to Future-Outlier/ray
that referenced
this pull request
Dec 7, 2025
…ct#57758) Add top-level aliases for public APIs. Users should never import from internal modules. This includes: * `ray.train.TrainingFailedError` * `ray.train.WorkerGroupError` * `ray.train.ControllerError` * `ray.train.TrainContext` Also removes the top-level `ray.train.TrainingIterator` import since this is a V1 DeveloperAPI that shouldn't be imported anymore. --------- Signed-off-by: Justin Yu <justinvyu@anyscale.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Add top-level aliases for public APIs. Users should never import from internal modules.
This includes:
ray.train.TrainingFailedErrorray.train.WorkerGroupErrorray.train.ControllerErrorray.train.TrainContextAlso removes the top-level
ray.train.TrainingIteratorimport since this is a V1 DeveloperAPI that shouldn't be imported anymore.Related issues
Types of change
Checklist
Does this PR introduce breaking changes?
Testing:
Code Quality:
git commit -s)Documentation:
doc/source/(if applicable)Additional context