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] Remove CLI from docs (soon to be deprecated and replaced by python API). #46724

Merged
merged 11 commits into from
Jul 23, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jul 20, 2024

Remove CLI from docs (soon to be deprecated; replaced by python API).

Reasons, why we are deprecating the CLI:

  • Simplification: Maintaining one python API is simpler than maintaining 2 top-level user APIs
  • The CLI - even though it is a nice tool to quickly run a first RLlib experiment - has users quickly run into roadblocks when relying on this API.
  • Instead, users should immediately learn the "only" valid API, which will be the python API of RLlib.
  • To keep some level of command-line based ease-of-access, all our example scripts and tuned_examples are already directly runnable as python scripts with unified command line options.

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>
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. Very nice cleanup!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Awesome, this relict is also gone, now!

The Python API provides the needed flexibility for applying RLlib to new problems.
For instance, you will need to use this API if you wish to use
`custom environments, preprocessors, or models <rllib-models.html>`__ with RLlib.
The Python API provides the all the flexibility required for applying RLlib to any type of problem.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove one "the" ;)

sven1977 added 3 commits July 22, 2024 17:18
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) July 22, 2024 18:10
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jul 22, 2024
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge July 22, 2024 18:46
sven1977 added 5 commits July 23, 2024 11:59
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) July 23, 2024 22:18
@sven1977 sven1977 merged commit 5c00c92 into ray-project:master Jul 23, 2024
6 checks passed
@sven1977 sven1977 deleted the docs_redo_remove_cli branch July 27, 2024 21:01
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants