Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc][ml] add one missing train public API reference + lint checker #47134

Merged
merged 1 commit into from
Aug 19, 2024
Merged

[doc][ml] add one missing train public API reference + lint checker #47134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .buildkite/lint.rayci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
5 changes: 5 additions & 0 deletions ci/ray_ci/doc/cmd_check_api_discrepancy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
12 changes: 11 additions & 1 deletion doc/source/train/api/api.rst
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@justinvyu PTAL!

Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move ~train.base_trainer.TrainingFailedError from the section below into this one as well?

~train.base_trainer.TrainingFailedError


Ray Train Developer APIs
------------------------
Expand All @@ -178,7 +189,6 @@ Trainer Base Classes

~train.trainer.BaseTrainer
~train.data_parallel_trainer.DataParallelTrainer
~train.base_trainer.TrainingFailedError


Train Backend Base Classes
Expand Down
Loading