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.

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

[RLlib; docs] Upgrade RLlib examples page (new API stack). #48526

Merged
merged 4 commits into from
Nov 4, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Nov 3, 2024

Upgrade RLlib examples page (new API stack).

  • Make sure all mentioned scripts are new API stack (do not link to the (few) old API stack scripts anymore).
  • Redo, enhance, expand descriptions for each existing script.
  • Make sure all community examples and blog links are still active.

Why are these changes needed?

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: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 added rllib RLlib related issues docs An issue or change related to documentation rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack rllib-oldstack-cleanup Issues related to cleaning up classes, utilities on the old API stack labels Nov 3, 2024
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Nov 4, 2024
@sven1977 sven1977 enabled auto-merge (squash) November 4, 2024 10:06
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Nov 4, 2024
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

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

LGTM. Its great to see how much we already transferred to the new API stack :)

@sven1977
Copy link
Contributor Author

sven1977 commented Nov 4, 2024

LGTM. Its great to see how much we already transferred to the new API stack :)

Yeah, I felt the same way when I did this page :D

@sven1977 sven1977 enabled auto-merge (squash) November 4, 2024 10:43
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) November 4, 2024 13:10
@sven1977 sven1977 merged commit d39c9df into ray-project:master Nov 4, 2024
6 checks passed
@sven1977 sven1977 deleted the docs_redo_examples_page branch November 4, 2024 13:55
Jay-ju pushed a commit to Jay-ju/ray that referenced this pull request Nov 5, 2024
JP-sDEV pushed a commit to JP-sDEV/ray that referenced this pull request Nov 14, 2024
mohitjain2504 pushed a commit to mohitjain2504/ray that referenced this pull request Nov 15, 2024
…ject#48526)

Signed-off-by: mohitjain2504 <mohit.jain@dream11.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack rllib-oldstack-cleanup Issues related to cleaning up classes, utilities on the old API stack tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants