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

Add more introductory pages #791

Conversation

pseudo-rnd-thoughts
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts commented Nov 24, 2023

Description

In reviewing the website, I realised that we currently have a pretty bad set of introductory pages for new users.
Therefore, this PR adds several key pages that I believe will be very helpful for new users:

  • basic usage - Same as before just updated and addresses [Bug Report] "Basic usage" documentation incorrect/incomplete #735
  • training an agent - Most users will be interested in using a built-in gymnasium environment to train a basic RL agents to begin with. The easiest solution is to move the "Solving blackjack using Q-learning" tutorial with minor changes. We should look to add tutorials for training agents to play Atari and Mujoco environments.
  • create a custom environment - The second most common thing for users should be creating their own custom environment. The easiest solution again is to move the "Creating a custom environment" tutorial but this tutorial needs large scale changes (@kir0ul is working on this). We should look to add a section at the end linking to third-party environments.
  • Recording agents - While uncommon, I think having a page about recording data on agents during training and evaluation is helpful. In particular how to use the RecordVideo and RecordEpisodeStatistics.
  • Speeding up environments - A bit more niche but critical is using vector environments. I think "speeding up environment" is more helpful to new users than "how to use vector environments" and we can note other techniques that can be used.
  • Compatibility with OpenAI Gym - Same as before (show be updated for v1.0.0)
  • Migration guide - Same as before but should include updating to v1.0.0

Todo

  • Add compiling from python to rst (we support this for tutorials but we don't want the gallery aspect)
  • Finish "Recording agents"
  • Modify "Speeding up the environment" to add an explanation of vector environments
  • Update training an agent to be more introductory

Copy link
Member

@jjshoots jjshoots left a comment

Choose a reason for hiding this comment

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

Just some minor grammatical fixes and suggestions

docs/introduction/basic_usage.md Outdated Show resolved Hide resolved
docs/introduction/basic_usage.md Outdated Show resolved Hide resolved
docs/introduction/basic_usage.md Outdated Show resolved Hide resolved
docs/introduction/basic_usage.md Outdated Show resolved Hide resolved
docs/introduction/basic_usage.md Outdated Show resolved Hide resolved
docs/introduction/speed_up_env.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/environment_creation.py Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/environment_creation.py Outdated Show resolved Hide resolved
docs/introduction/train_agent.md Outdated Show resolved Hide resolved
docs/introduction/train_agent.md Outdated Show resolved Hide resolved
Copy link
Member

@jjshoots jjshoots left a comment

Choose a reason for hiding this comment

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

Some small minor comments.

Copy link
Member

@jjshoots jjshoots left a comment

Choose a reason for hiding this comment

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

Few more minor ones, then LGTM!

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 650aa5f into Farama-Foundation:main Dec 8, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants