From e4756db5d70e235f532d272c2cfdb7e06a14329a Mon Sep 17 00:00:00 2001 From: can Date: Wed, 14 Aug 2024 18:10:01 +0000 Subject: [PATCH] [doc][ml] add one missing train public API reference Signed-off-by: can --- .buildkite/lint.rayci.yml | 1 + ci/ray_ci/doc/cmd_check_api_discrepancy.py | 5 +++++ doc/source/train/api/api.rst | 12 +++++++++++- 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.buildkite/lint.rayci.yml b/.buildkite/lint.rayci.yml index c51ba9c4275b..ae8d8276ec42 100644 --- a/.buildkite/lint.rayci.yml +++ b/.buildkite/lint.rayci.yml @@ -35,6 +35,7 @@ steps: - api_policy_check core - api_policy_check serve - api_policy_check data + - api_policy_check train - api_policy_check rllib - label: ":lint-roller: lint: linkcheck" diff --git a/ci/ray_ci/doc/cmd_check_api_discrepancy.py b/ci/ray_ci/doc/cmd_check_api_discrepancy.py index 79209e578eec..62a0a89ad14c 100644 --- a/ci/ray_ci/doc/cmd_check_api_discrepancy.py +++ b/ci/ray_ci/doc/cmd_check_api_discrepancy.py @@ -42,6 +42,11 @@ "ray.remote_function.RemoteFunction", }, }, + "train": { + "head_modules": {"ray.train"}, + "head_doc_file": "doc/source/train/api/api.rst", + "white_list_apis": {}, + }, "rllib": { "head_modules": {"ray.rllib"}, "head_doc_file": "doc/source/rllib/package_ref/index.rst", diff --git a/doc/source/train/api/api.rst b/doc/source/train/api/api.rst index 06b091229011..17606d533e33 100644 --- a/doc/source/train/api/api.rst +++ b/doc/source/train/api/api.rst @@ -163,6 +163,17 @@ Ray Train Output ~train.Result +Ray Train Errors +---------------- + +.. autosummary:: + :nosignatures: + :template: autosummary/class_without_autosummary.rst + :toctree: doc/ + + ~train.error.SessionMisuseError + ~train.base_trainer.TrainingFailedError + Ray Train Developer APIs ------------------------ @@ -178,7 +189,6 @@ Trainer Base Classes ~train.trainer.BaseTrainer ~train.data_parallel_trainer.DataParallelTrainer - ~train.base_trainer.TrainingFailedError Train Backend Base Classes