[doc][rllib] the rest of missing api references + lint checker #47114
+14
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
can-anyscale
force-pushed
the
can-dr02
branch
2 times, most recently
from
a9032fd to
ca32a00
Compare
can-anyscale
commented
Aug 13, 2024
| @@ -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:: | |||
There was a problem hiding this comment.
fix this while i'm here to assist with the rst parser a little bit
can-anyscale
requested review from
sven1977,
ArturNiederfahrenhorst,
maxpumperla,
simonsays1980 and
a team
as code owners
can-anyscale
commented
Aug 13, 2024
|
|
||
| .. autosummary:: | ||
| :nosignatures: | ||
| :toctree: doc/ | ||
|
|
||
| tensor_dtype.get_np_dtype | ||
| utils.tensor_dtype.get_np_dtype |
There was a problem hiding this comment.
I'm not sure where to document these, or whitelisting them, so leave this for @sven1977 to help with, thankks
The reason we document these are because they are PublicAPIs
There was a problem hiding this comment.
Makes sense. Let's leave this here as-is. We'll later retract these (old API stack) APIs' PublicAPI status and then also remove these form the docs again, but for now this is fine.
sven1977
approved these changes
Aug 14, 2024
aslonnie
approved these changes
Aug 14, 2024
Signed-off-by: can <can@anyscale.com>
simonsays1980
pushed a commit
to simonsays1980/ray
that referenced
this pull request
Aug 15, 2024
…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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: