Skip to content

Add doc pages for notable Atari environment sets - #733

Open
BolunDai0216 wants to merge 2 commits into
Farama-Foundation:mainfrom
BolunDai0216:bolun/env-set-pages
Open

Add doc pages for notable Atari environment sets#733
BolunDai0216 wants to merge 2 commits into
Farama-Foundation:mainfrom
BolunDai0216:bolun/env-set-pages

Conversation

@BolunDai0216

@BolunDai0216 BolunDai0216 commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes #708

Adds sidebar-visible documentation pages listing the games in each commonly benchmarked subset of Atari environments, so multiple views exist simultaneously as suggested in the issue:

  • Atari 57 (environments/atari_57) — the 57 games of the DeepMind benchmark (DQN through Agent57), with references and a note that Defender/Surround were unavailable in atari-py, which is why some papers benchmark on only 55 of these games.
  • Previously in OpenAI Gym (environments/gym) — the 62 games that were registered in OpenAI Gym, explaining the Pong-v0ALE/Pong-v5 naming migration and how the set relates to Atari 57 (all of it except Surround, plus Adventure, AirRaid, Carnival, ElevatorAction, JourneyEscape and Pooyan).
  • Complete list — now included in a toctree (it previously wasn't in any), with cross-links to the set pages.

The Environments page gets a visible "Environment sets" section linking the three views, and the three pages live under a separate "Environment Sets" sidebar dropdown directly below Environments (per review, keeping the Environments dropdown to just the individual game pages).

The new pages follow the existing complete_list pattern: a checked-in env-grid HTML file embedded in a markdown page via {raw} html, using the same relative-link style (correct for the dirhtml builder used in CI). The grids were generated programmatically from the display names in complete_list.html, with assertions validating both set definitions and the relationship between them. Additional sets (e.g., the DQN Nature 49) can be added the same way if desired.

Sphinx build succeeds with no new warnings.

🤖 Generated with Claude Code

Add sidebar-visible pages listing the games in each commonly
benchmarked subset of Atari environments:

- Atari 57: the DeepMind benchmark set (DQN through Agent57)
- Environments previously in Gym: the 62 games registered in OpenAI Gym
- Complete list: now included in the Environments toctree

Also add an "Environment sets" section to the Environments page
linking the different views, with cross-links between the set pages.

Fixes Farama-Foundation#708

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @BolunDai0216 for the PR. Reviewing this locally, I don't like "Complete List", "Atari 57" and "Environments Previously in Gym" being in the table of contents
image

Could you remove these from the table of contents and rename "Environments Previously in Gym" to "Previously in OpenAI Gym"

@jkterry1

Copy link
Copy Markdown
Member

@pseudo-rnd-thoughts where are you asking for links to the pages to be places if not in the left hand bar? Perhaps they should go under a different "environment sets" drop down and not in the main environments drop down?

@pseudo-rnd-thoughts

Copy link
Copy Markdown
Member

Currently the links exist in the environments root page and I don't think these need to exist anywhere in the table of contents. If we need to have them in the TOC, then as a single item below environments could work as well. I think we need to render these locally to see what looks good and is helpful

@jkterry1

jkterry1 commented Aug 27, 2026 via email

Copy link
Copy Markdown
Member

Per review: the three set pages (Complete List, Atari 57, Previously in
OpenAI Gym) are no longer in the Environments toctree; they now live under
their own "Environment Sets" sidebar item below Environments. The Gym page
is renamed from "Environments previously in Gym" to "Previously in OpenAI
Gym", with cross-links updated to match.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RxxFUPvh664Gveft3dHK7V
@BolunDai0216

Copy link
Copy Markdown
Contributor Author

Done in 836d04b:

  • The three set pages are removed from the Environments toctree. They now live under a separate "Environment Sets" dropdown directly below Environments in the sidebar (as @jkterry1 suggested), so the Environments dropdown again contains only the individual game pages.
  • Renamed "Environments previously in Gym" → "Previously in OpenAI Gym" (page title and all cross-links).

The links on the Environments root page are kept as before. Rendered locally with the dirhtml builder — no new warnings, and the new dropdown is collapsed by default:

▸ Environments
▸ Environment Sets
    Complete List - Atari
    Atari 57
    Previously in OpenAI Gym
  ALE Vector Environment Guide
  ...

@jkterry1

jkterry1 commented Aug 31, 2026 via email

Copy link
Copy Markdown
Member

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.

Clearly Mark Different Sets of Atari Games In Documentation

3 participants