ray icon indicating copy to clipboard operation
ray copied to clipboard

[Docs] RLlib: Reduce usage of long config lists

Open maxpumperla opened this issue 3 years ago • 2 comments

Search before asking

  • [X] I had searched in the issues and found no similar feature requirement.

Description

Many places in the RLlib docs rely on "config dumps" like here and here. Given the current API, the content itself has to be presented somehow. But commented long lists are not the way. We need to do a better job of explaining what to use when, what side effects changing things might have, and generally how configuration settings interact.

Can we group common configuration into categories? Or can we explain what can be configured in principle and defer the actual lists of config options into a reference? For instance, the (in principle very good) page on algorithms might actually be better placed under API reference, the way it is presented (pure info). As a pure reference it is great, as learning material it's not.

Of course, there's an underlying API component to all of this that needs to be solved eventually. For now, we need to see that our Training API makes sense to new-ish users.

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • [ ] Yes I am willing to submit a PR!

maxpumperla avatar Jan 24 '22 21:01 maxpumperla

@avnishn please make sure you fully understand the task at hand before implementing/addressing this! Feel free to ping Max with questions.

richardliaw avatar Jan 25 '22 21:01 richardliaw

Hi, I'm a bot from the Ray team :)

To help human contributors to focus on more relevant issues, I will automatically add the stale label to issues that have had no activity for more than 4 months.

If there is no further activity in the 14 days, the issue will be closed!

  • If you'd like to keep the issue open, just leave any comment, and the stale label will be removed!
  • If you'd like to get more attention to the issue, please tag one of Ray's contributors.

You can always ask for help on our discussion forum or Ray's public slack channel.

stale[bot] avatar Aug 10 '22 03:08 stale[bot]

Hi again! The issue will be closed because there has been no more activity in the 14 days since the last message.

Please feel free to reopen or open a new issue if you'd still like it to be addressed.

Again, you can always ask for help on our discussion forum or Ray's public slack channel.

Thanks again for opening the issue!

stale[bot] avatar Sep 20 '22 18:09 stale[bot]