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

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

Open
1 task done
kuds opened this issue Oct 10, 2024 · 1 comment
Open
1 task done

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

kuds opened this issue Oct 10, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@kuds
Copy link

kuds commented Oct 10, 2024

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

  • I have checked that there is no similar issue in the repo
@kuds kuds added the bug Something isn't working label Oct 10, 2024
@kuds kuds changed the title [Bug Report] Pong Documentation has the wrong import [Bug Report] Pong Documentation has the wrong import in sample code Oct 10, 2024
@kuds
Copy link
Author

kuds commented Oct 11, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant