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

[Docs][Rllib] How To Create a Good Gym Environment for use with RLlib #24655

Closed
avnishn opened this issue May 10, 2022 · 2 comments
Closed

[Docs][Rllib] How To Create a Good Gym Environment for use with RLlib #24655

avnishn opened this issue May 10, 2022 · 2 comments
Assignees
Labels
docs An issue or change related to documentation enhancement Request for new feature and/or capability rllib RLlib related issues stale The issue is stale. It will be closed within 7 days unless there are further conversation

Comments

@avnishn
Copy link
Member

avnishn commented May 10, 2022

Description

There's many tutorials on the internet explaining how to create a gym env, but there aren't many that show how to make sure that the environment is created with all the correct properties so that its easy to validate and has no foot-gun errors. I'm suggesting that we add this to our documentation and replace our current docs on gym environments.

The environments documentation page is out of date and a little difficult to understand for beginners .

We should write the page to have the following outline:

  • How to create a simple environment
  • How do I make sure that it’s working? (Use check_env)
  • How to pass it to an rllib experiment
  • Use the updated config objects to do that

Use case

How does a beginner create environments that work with RLlib for sure?

@avnishn avnishn added enhancement Request for new feature and/or capability rllib RLlib related issues labels May 10, 2022
@dynamicwebpaige dynamicwebpaige added the docs An issue or change related to documentation label May 10, 2022
@christy christy self-assigned this May 13, 2022
@christy christy mentioned this issue Jun 7, 2022
6 tasks
@christy christy mentioned this issue Jul 2, 2022
6 tasks
@stale
Copy link

stale bot commented Sep 17, 2022

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 stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Sep 17, 2022
@stale
Copy link

stale bot commented Oct 9, 2022

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 stale bot closed this as completed Oct 9, 2022
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 enhancement Request for new feature and/or capability rllib RLlib related issues stale The issue is stale. It will be closed within 7 days unless there are further conversation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants