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.

Sign up for GitHub

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

Jump to bottom

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

Open
1 task done
kuds opened this issue Oct 10, 2024 · 5 comments · May be fixed by #1257
Open
1 task done

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

kuds opened this issue Oct 10, 2024 · 5 comments · May be fixed by #1257
Assignees
@David-GERARD
Labels
bug Something isn't working

Comments

@kuds
Copy link

kuds commented Oct 10, 2024 •
edited
Loading

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 kuds mentioned this issue Oct 10, 2024
Closed
7 tasks
@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

@David-GERARD David-GERARD self-assigned this Nov 22, 2024
@David-GERARD
Copy link
Collaborator

Hi @kuds,

Thanks for underlining this issue, I'll be happy to review your PR when you submit it!

Important

To edit the documentation, you need to target the branch master, not the branch gh-pages.

Note

gh-pages contains all of the documentation for all of the releases, and is used to generate the website. No manual pushes are made on this branch. However changes to the docs on branch main are pushed to the main(unstable) version of the website (you can change the version with the tab in the lower right corner.

@kuds
Copy link
Author

kuds commented Dec 20, 2024

@David-GERARD

Sorry for the delay in getting back to this. I will have some time this week and next to create the pull PR.

Thank you for patience!

@David-GERARD
Copy link
Collaborator

Hi @kuds, no problem at all, and happy holidays!

@kuds kuds linked a pull request Jan 14, 2025 that will close this issue
Open
7 tasks
@kuds
Copy link
Author

kuds commented Jan 15, 2025

Hi @David-GERARD, I created a pull request to fix this issue. Sorry for the delay!

Let me know if you have any questions or concerns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@David-GERARD David-GERARD

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix Documentation to properly match/display correct environment for Pong kuds/PettingZoo
2 participants
@kuds @David-GERARD