Skip to content

Commit 1e38c94

Browse files
authored
[train] update TrainingFailedError module (#57865)
## Description Updating so that the module shows as `ray.train` rather than `ray.train.v2.api.exceptions` ## Testing https://anyscale-ray--57865.com.readthedocs.build/en/57865/train/api/doc/ray.train.v2.api.data_parallel_trainer.DataParallelTrainer.fit.html#ray.train.v2.api.data_parallel_trainer.DataParallelTrainer.fit <img width="960" height="302" alt="image" src="https://github.com/user-attachments/assets/02206542-54fe-4674-b2b4-1868fa7e8580" /> Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>
1 parent 85a7acb commit 1e38c94

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

doc/source/train/api/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Ray Train Errors
180180

181181
~train.ControllerError
182182
~train.WorkerGroupError
183-
~train.v2.api.exceptions.TrainingFailedError
183+
~train.TrainingFailedError
184184

185185
Ray Tune Integration Utilities
186186
------------------------------

python/ray/train/v2/api/data_parallel_trainer.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@
5454
from ray.train.v2._internal.execution.scaling_policy import create_scaling_policy
5555
from ray.train.v2._internal.util import ObjectRefWrapper, construct_train_func
5656
from ray.train.v2.api.callback import UserCallback
57-
from ray.train.v2.api.exceptions import TrainingFailedError # noqa: F401
5857
from ray.util.annotations import Deprecated, DeveloperAPI
5958
from ray.util.scheduling_strategies import NodeAffinitySchedulingStrategy
6059

@@ -157,7 +156,7 @@ def fit(self) -> Result:
157156
A Result object containing the training result.
158157
159158
Raises:
160-
ray.train.v2.api.exceptions.TrainingFailedError: This is a union of the ControllerError and WorkerGroupError.
159+
ray.train.TrainingFailedError: This is a union of the ControllerError and WorkerGroupError.
161160
This returns a :class:`ray.train.ControllerError` if internal Ray Train controller logic
162161
encounters a non-retryable error or reaches the controller failure limit configured in `FailureConfig`.
163162
This returns a :class:`ray.train.WorkerGroupError` if one or more workers fail during

0 commit comments

Comments
 (0)