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

Expand AEC documentation significantly (comparison with EFGs/POSGs, info from PettingZoo paper) #1041

Merged
merged 1 commit into from
Jul 23, 2023

Conversation

elliottower
Copy link
Contributor

A user asked for more info about AEC envs because the original paper got taken down (combined with the PettingZoo paper), so I figure the page should have an about section in case someone else gets confused. I think it's also good to have examples showing how we have implemented the various design goals stated in the paper, with links to example environments to check out, etc.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue), Depends on # (pull request)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.
To upload images to a PR -- simply drag and drop or copy paste.

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@elliottower elliottower marked this pull request as ready for review July 21, 2023 23:30
@elliottower elliottower mentioned this pull request Jul 21, 2023
7 tasks
@elliottower elliottower merged commit 902d94c into Farama-Foundation:master Jul 23, 2023
@elliottower elliottower deleted the update-aec-docs branch July 23, 2023 14:23
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.

1 participant