Farama-Foundation / PettingZoo

An API standard for multi-agent reinforcement learning environments, with popular reference environments and related utilities
https://pettingzoo.farama.org
Other
2.6k stars 410 forks source link

[Bug Report] Pong Documentation has the wrong import in sample code #1235

Open kuds opened 1 week ago

kuds commented 1 week ago

Describe the bug

The PettingZoo Documentation for Atari's Pong has the wrong imports in the AEC and Parallel and lists basketball_pong_v3 instead of pong_v3. With your permission, I want to create a pull request to fix the documentation against the gh-pages branch.

Pong Info image

AEC Section image

Code example

No response

System info

Environment: Google Colab T4 Python Version: 3.10.12 Torch Version: 2.4.1+cu121 Is Cuda Available: True Cuda Version: 12.1 Gymnasium Version: 0.28.1 Numpy Version: 1.26.4 PettingZoo Version: 1.24.3 Ray Version: 2.37.0 ALE Version: 0.8.1

Additional context

No response

Checklist

kuds commented 1 week ago

After some further troubleshooting, I realized that the issue was not with the Github Pages branch but with how the gen_envs_mds.py gathers the environments' names. When it tries to match on pong, it returns multiple results and grabs the first one, basketball_pong, and not pong. I will close my original pull request against the gh-pages branch and will create a new one against the master branch with the new fix.

docs/_scripts/gen_envs_mds.py image