[train] update Train API references & annotations #39294

matthewdeng · 2023-09-06T03:03:02Z

Why are these changes needed?

Changes

Remove deprecated API references.
Reorganize API References to improve navigation of the headers.
Update modules to point to ray.train.
Update API stability annotations.
Alias ray.air.integrations.keras.ReportCheckpointCallback to ray.train.tensorflow.keras.ReportCheckpointCallback.

Stability

API	Stability
ray.train.torch.TorchTrainer	beta → stable
ray.train.torch.TorchConfig	beta → stable
ray.train.torch.get_device	beta → stable
ray.train.torch.prepare_model	beta → stable
ray.train.torch.prepare_data_loader	beta → stable
ray.train.torch.enable_reproducibility	beta → stable
ray.train.lightning.LightningTrainer	alpha → deprecated
ray.train.lightning.LightningConfigBuilder	alpha → deprecated
ray.train.lightning.prepare_trainer	n/a → beta
ray.train.lightning.RayTrainReportCallback	n/a → beta
ray.train.lightning.RayLightningEnvironment	n/a → beta
ray.train.lightning.RayDDPStrategy	n/a → beta
ray.train.lightning.RayFSDPStrategy	n/a → beta
ray.train.lightning.RayDeepSpeedStrategy	n/a → beta
ray.train.huggingface.AccelerateTrainer	none → deprecated
ray.train.huggingface.TransformersTrainer	alpha → deprecated
ray.train.huggingface.transformers.prepare_trainer	n/a → beta
ray.train.huggingface.transformers.RayTrainReportCallback	n/a → beta
ray.train.CheckpointConfig	beta → stable
ray.train.DataConfig	public → stable
ray.train.FailureConfig	beta → stable
ray.train.RunConfig	beta → stable
ray.train.ScalingConfig	beta → stable
ray.train.SyncConfig	public → stable
ray.train.Checkpoint	beta
ray.train.TrainContext	n/a → stable
ray.train.get_context	n/a → stable
ray.train.get_checkpoint	beta → stable
ray.train.get_dataset_shard	beta → stable
ray.train.report	beta → stable
ray.train.Result	beta → stable

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 :(

Signed-off-by: Matthew Deng <matt@anyscale.com>

matthewdeng · 2023-09-07T05:21:08Z

python/ray/air/config.py

+    # DEPRECATED
    _max_cpu_fraction_per_node: Optional[Union[float, SampleRange]] = None

    def __post_init__(self):
+        if self._max_cpu_fraction_per_node:
+            warnings.warn(
+                "_max_cpu_fraction_per_node is deprecated and will be removed in Ray 2.8.",  # noqa: E501
+                DeprecationWarning,
+            )


@ericl I wasn't sure if there was a better way to do this, LMK if you think I should raise the warning or completely remove it from the API (and let it fail without a message) instead .

Let's just remove it, since it was underscore/experimental.

Signed-off-by: Matthew Deng <matt@anyscale.com>

woshiyyya

Overall looks good to me. Left a few comments.

python/ray/train/lightning/lightning_trainer.py

python/ray/train/huggingface/accelerate/accelerate_trainer.py

python/ray/train/__init__.py

doc/source/train/api/api.rst

Signed-off-by: Matthew Deng <matt@anyscale.com>

richardliaw · 2023-09-08T00:51:06Z

doc/source/tune/api/syncing.rst


    ray.train.SyncConfig
+        :noindex:


what's the reason why we are no indexing here?

It's indexed in the Train API now

Signed-off-by: Matthew Deng <matt@anyscale.com>

…39468) * [train] Fix issues in migration of tune_cifar_torch_pbt_example (#39158) Resolves three issues that come up when migrating the `tune_cifar_torch_pbt_example` from Ray 2.6 to Ray 2.7: 1. There is a warning message because PBT uses the `_schedule_trial_save` interface. This is added to the white list attributes so it doesn't come up anymore. 2. PBT malfunctions in Python 2.7, so instead of silently failing, we raise an error and ask users to migrate 3. When users use old `ray.air.Checkpoint` APIs on `ray.train.Checkpoint`, we should raise an actionable error message. Signed-off-by: Kai Fricke <kai@anyscale.com> * [tune] Make Trainable.save/restore developer APIs (#39391) Signed-off-by: Kai Fricke <kai@anyscale.com> * [Telemetry] Add Telemetry for Ray Train Utilities (#39363) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> * [train] update Train API references & annotations (#39294) Signed-off-by: Matthew Deng <matt@anyscale.com> * [2.7] Cleanup all LightningTrainer Mentions in Ray Doc (#39406) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> * [train] remove _max_cpu_fraction_per_node (#39412) Signed-off-by: Matthew Deng <matt@anyscale.com> * [train] Legacy interface cleanup (`air.Checkpoint`, `LegacyExperimentAnalysis`) (#39289) Signed-off-by: Justin Yu <justinvyu@anyscale.com> Co-authored-by: matthewdeng <matt@anyscale.com> * [Train][Telemetry] Limit the usage of `ray.train.torch.get_device`. (#39432) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> * [train-ci] Fix Train examples with authentication buildkite commands. (#39387) * [train-ci] fix Train examples with authentication buildkite commands. Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com> * [train][doc] Remove preprocessor reference in tune+train user guide (#39442) Signed-off-by: Justin Yu <justinvyu@anyscale.com> * [train/docs] Extend resource guide (training backend + choosing resources) (#39202) Signed-off-by: Kai Fricke <kai@anyscale.com> Co-authored-by: matthewdeng <matthew.j.deng@gmail.com> * fix docs Signed-off-by: Matthew Deng <matt@anyscale.com> * [Minor] Remove remaining LightningTrainer Mentions (#39441) Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> --------- Signed-off-by: Kai Fricke <kai@anyscale.com> Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com> Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Justin Yu <justinvyu@anyscale.com> Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com> Co-authored-by: Yunxuan Xiao <yunxuanx@anyscale.com> Co-authored-by: Justin Yu <justinvyu@anyscale.com> Co-authored-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Jim Thompson <jimthompson5802@gmail.com>

Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Victor <vctr.y.m@example.com>

matthewdeng added 9 commits September 5, 2023 20:02

[train] update Train API references & annotations

c504017

Signed-off-by: Matthew Deng <matt@anyscale.com>

fix SyncConfig

e7aec77

Signed-off-by: Matthew Deng <matt@anyscale.com>

add deprecation messages

4053381

Signed-off-by: Matthew Deng <matt@anyscale.com>

fix SyncConfig

66453d3

Signed-off-by: Matthew Deng <matt@anyscale.com>

trainer stability

c9e8bed

Signed-off-by: Matthew Deng <matt@anyscale.com>

update to stable

73656f2

Signed-off-by: Matthew Deng <matt@anyscale.com>

fix

774b257

Signed-off-by: Matthew Deng <matt@anyscale.com>

Merge branch 'master' of github.com:ray-project/ray into train-api-2.7

ea8aafd

[core] fix runtime_context.get_resource_ids docstring

b8bfceb

Signed-off-by: Matthew Deng <matt@anyscale.com>

matthewdeng marked this pull request as ready for review September 7, 2023 05:18

matthewdeng requested review from richardliaw, krfricke, xwjiang2010, amogkam, Yard1, maxpumperla and a team as code owners September 7, 2023 05:18

matthewdeng commented Sep 7, 2023

View reviewed changes

matthewdeng added 3 commits September 7, 2023 15:56

max cpu

e010e89

Signed-off-by: Matthew Deng <matt@anyscale.com>

Merge branch 'master' of github.com:ray-project/ray into train-api-2.7

ff4dff2

update

c07db8c

Signed-off-by: Matthew Deng <matt@anyscale.com>

matthewdeng assigned justinvyu, krfricke and woshiyyya Sep 7, 2023

woshiyyya approved these changes Sep 7, 2023

View reviewed changes

update

7aed5b7

Signed-off-by: Matthew Deng <matt@anyscale.com>

richardliaw reviewed Sep 8, 2023

View reviewed changes

richardliaw approved these changes Sep 8, 2023

View reviewed changes

matthewdeng added the v2.7.0-pick label Sep 8, 2023

matthewdeng merged commit fb4dd92 into ray-project:master Sep 8, 2023

matthewdeng added a commit to matthewdeng/ray that referenced this pull request Sep 8, 2023

[train] update Train API references & annotations (ray-project#39294)

191e10a

Signed-off-by: Matthew Deng <matt@anyscale.com>

jimthompson5802 pushed a commit to jimthompson5802/ray that referenced this pull request Sep 12, 2023

[train] update Train API references & annotations (ray-project#39294)

1c828f6

Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Jim Thompson <jimthompson5802@gmail.com>

vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023

[train] update Train API references & annotations (ray-project#39294)

99ea0b0

Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Victor <vctr.y.m@example.com>

rickyyx mentioned this pull request Oct 24, 2023

[core] microbenchmark regression #40606

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[train] update Train API references & annotations #39294

[train] update Train API references & annotations #39294

matthewdeng commented Sep 6, 2023 •

edited

Loading

matthewdeng Sep 7, 2023

ericl Sep 7, 2023

woshiyyya left a comment

richardliaw Sep 8, 2023

matthewdeng Sep 8, 2023

[train] update Train API references & annotations #39294

[train] update Train API references & annotations #39294

Conversation

matthewdeng commented Sep 6, 2023 • edited Loading

Why are these changes needed?

Changes

Stability

Related issue number

Checks

matthewdeng Sep 7, 2023

Choose a reason for hiding this comment

ericl Sep 7, 2023

Choose a reason for hiding this comment

woshiyyya left a comment

Choose a reason for hiding this comment

richardliaw Sep 8, 2023

Choose a reason for hiding this comment

matthewdeng Sep 8, 2023

Choose a reason for hiding this comment

matthewdeng commented Sep 6, 2023 •

edited

Loading