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

Rename core to AEC #822

Merged
merged 2 commits into from
Oct 12, 2022
Merged

Rename core to AEC #822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4419598
rename core to aec
mgoulao Oct 12, 2022
a6d653f
improve title consistency
mgoulao Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions docs/api/core.md → docs/api/aec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Core API

## AECEnv
# AEC API

```{eval-rst}
.. currentmodule:: pettingzoo.utils.env
Expand All @@ -9,7 +7,7 @@

```

### Attributes
## Attributes


```{eval-rst}
Expand Down Expand Up @@ -40,13 +38,9 @@

:type: AgentID

.. autoattribute:: AECEnv.dones

A dict of the done state of every current agent at the time called, keyed by name. `last()` accesses this attribute. Note that agents can be added or removed from this dict. The returned dict looks like::

dones = {0:[first agent done state], 1:[second agent done state] ... n-1:[nth agent done state]}
.. autoattribute:: AECEnv.terminations

:type: Dict[AgentID, bool]
.. autoattribute:: AECEnv.truncations

.. autoattribute:: AECEnv.rewards

Expand All @@ -60,7 +54,7 @@

A dict of info for each current agent, keyed by name. Each agent's info is also a dict. Note that agents can be added or removed from this attribute. `last()` accesses this attribute. The returned dict looks like::

infos = {0:[first agent info], 1:[second agent info] ... n-1:[nth agent info]}
infos = {0:[first agent info], 1:[second agent info] ... n-1:[nth agent info]}

:type: Dict[AgentID, Dict[str, Any]]

Expand All @@ -77,7 +71,7 @@
:type: Dict[AgentID, gymnasium.spaces.Space]
```

### Methods
## Methods

```{eval-rst}
.. automethod:: AECEnv.step
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ tutorials/rllib/pistonball
:hidden:
:caption: API

api/core
api/aec
api/parallel
api/pz_wrappers
api/supersuit_wrappers
Expand Down