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] Docs do-over (new API stack): Remove Catalog pages. #49428

Merged
merged 2 commits into from
Dec 27, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 24, 2024

Docs do-over (new API stack): Remove Catalog pages.

  • To reduce the number of classes a user is exposed to when developing with RLlib, the Catalog API will be deprecated soon and replaced by simpler utility functions.

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 :(

@sven1977 sven1977 added rllib RLlib related issues rllib-catalog issues related to RLlib's model catalog rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack labels Dec 24, 2024
@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Dec 27, 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. I just wonder how users should use the RLModules when the Catalog is not replaced, yet, without these guides?

@sven1977 sven1977 enabled auto-merge (squash) December 27, 2024 14:40
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 27, 2024
@sven1977
Copy link
Contributor Author

LGTM. I just wonder how users should use the RLModules when the Catalog is not replaced, yet, without these guides?

Great question. 👍 👍 I would like to convert all the catalog magic that's in these classes right now into algo-independent utility functions that can be used by any RLModule, regardless of the algorithm used. Similar to the RLModule APIs.
We need to still do this work (carve out the code) and then document it properly .

@sven1977 sven1977 merged commit 7d7bfb0 into ray-project:master Dec 27, 2024
7 checks passed
@sven1977 sven1977 deleted the docs_redo_remove_catalogs branch December 27, 2024 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-catalog issues related to RLlib's model catalog rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack 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.

2 participants