Skip to content

Commit

Permalink
[doc][rllib] the rest of missing api references + lint checker (ray-p…
Browse files Browse the repository at this point in the history
…roject#47114)

Add the rest of missing API references for rllib. We can also now enable
the API policy lint checker for rllib, now that all missing references
are documented

Test:
- CI

<img width="1351" alt="Screenshot 2024-08-13 at 12 15 08 PM"
src="https://github.com/user-attachments/assets/cc1d1c8e-763e-4d2e-a7d1-28243a7fdbab">

Signed-off-by: can <can@anyscale.com>
  • Loading branch information
can-anyscale authored Aug 14, 2024
1 parent 014e252 commit 0631713
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
1 change: 1 addition & 0 deletions .buildkite/lint.rayci.yml
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 rllib

- label: ":lint-roller: lint: linkcheck"
instance_type: medium
Expand Down
5 changes: 5 additions & 0 deletions ci/ray_ci/doc/cmd_check_api_discrepancy.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@
"ray.remote_function.RemoteFunction",
},
},
"rllib": {
"head_modules": {"ray.rllib"},
"head_doc_file": "doc/source/rllib/package_ref/index.rst",
"white_list_apis": {},
},
}


Expand Down
3 changes: 1 addition & 2 deletions doc/source/rllib/package_ref/policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ which maps agent IDs to a policy ID.
by sub-classing either of the available, built-in classes, depending on your
needs.

.. include::
policy/custom_policies.rst
.. include:: policy/custom_policies.rst

.. currentmodule:: ray.rllib

Expand Down
9 changes: 7 additions & 2 deletions doc/source/rllib/package_ref/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,15 @@ Policy utilities
Other utilities
~~~~~~~~~~~~~~~

.. currentmodule:: ray.rllib.utils
.. currentmodule:: ray.rllib

.. autosummary::
:nosignatures:
:toctree: doc/

tensor_dtype.get_np_dtype
utils.tensor_dtype.get_np_dtype
common.CLIArguments
common.FrameworkEnum
common.SupportedFileType
core.rl_module.validate_module_id
train.load_experiments_from_file

0 comments on commit 0631713

Please sign in to comment.