# {py:mod}`evorl.envs.jaxmarl`

```{py:module} evorl.envs.jaxmarl
```

```{autodoc2-docstring} evorl.envs.jaxmarl
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`JaxMARLAdapter <evorl.envs.jaxmarl.JaxMARLAdapter>`
  -
* - {py:obj}`MABraxAdapter <evorl.envs.jaxmarl.MABraxAdapter>`
  -
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`create_mabrax_env <evorl.envs.jaxmarl.create_mabrax_env>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.create_mabrax_env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`create_wrapped_mabrax_env <evorl.envs.jaxmarl.create_wrapped_mabrax_env>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.create_wrapped_mabrax_env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_random_actions <evorl.envs.jaxmarl.get_random_actions>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.get_random_actions
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`jaxmarl_space_to_evorl_space <evorl.envs.jaxmarl.jaxmarl_space_to_evorl_space>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.jaxmarl_space_to_evorl_space
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ma_brax_env_list <evorl.envs.jaxmarl.ma_brax_env_list>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.ma_brax_env_list
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`supported_jaxmarl_env_list <evorl.envs.jaxmarl.supported_jaxmarl_env_list>`
  - ```{autodoc2-docstring} evorl.envs.jaxmarl.supported_jaxmarl_env_list
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} JaxMARLAdapter(env: jaxmarl.environments.MultiAgentEnv)
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter

Bases: {py:obj}`evorl.envs.multi_agent_env.MultiAgentEnvAdapter`

````{py:property} action_space
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter.action_space
:type: collections.abc.Mapping[evorl.types.AgentID, evorl.envs.space.Space]

````

````{py:property} agents
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter.agents
:type: list[evorl.types.AgentID]

```{autodoc2-docstring} evorl.envs.jaxmarl.JaxMARLAdapter.agents
:parser: autodoc2_docstrings_parser
```

````

````{py:property} obs_space
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter.obs_space
:type: collections.abc.Mapping[evorl.types.AgentID, evorl.envs.space.Space]

````

````{py:method} reset(key: chex.PRNGKey) -> evorl.envs.env.EnvState
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter.reset

````

````{py:method} step(state: evorl.envs.env.EnvState, action: evorl.types.Action) -> evorl.envs.env.EnvState
:canonical: evorl.envs.jaxmarl.JaxMARLAdapter.step

````

`````

`````{py:class} MABraxAdapter(env: jaxmarl.environments.MultiAgentEnv)
:canonical: evorl.envs.jaxmarl.MABraxAdapter

Bases: {py:obj}`evorl.envs.jaxmarl.JaxMARLAdapter`

````{py:method} reset(key: chex.PRNGKey) -> evorl.envs.env.EnvState
:canonical: evorl.envs.jaxmarl.MABraxAdapter.reset

````

````{py:method} step(state: evorl.envs.env.EnvState, action: evorl.types.Action) -> evorl.envs.env.EnvState
:canonical: evorl.envs.jaxmarl.MABraxAdapter.step

````

`````

````{py:function} create_mabrax_env(env_name: str, **kwargs) -> evorl.envs.jaxmarl.JaxMARLAdapter
:canonical: evorl.envs.jaxmarl.create_mabrax_env

```{autodoc2-docstring} evorl.envs.jaxmarl.create_mabrax_env
:parser: autodoc2_docstrings_parser
```
````

````{py:function} create_wrapped_mabrax_env(env_name: str, episode_length: int = 1000, parallel: int = 1, autoreset_mode: evorl.envs.wrappers.training_wrapper.AutoresetMode = AutoresetMode.NORMAL, **kwargs) -> evorl.envs.jaxmarl.JaxMARLAdapter
:canonical: evorl.envs.jaxmarl.create_wrapped_mabrax_env

```{autodoc2-docstring} evorl.envs.jaxmarl.create_wrapped_mabrax_env
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_random_actions(env: jaxmarl.environments.MultiAgentEnv)
:canonical: evorl.envs.jaxmarl.get_random_actions

```{autodoc2-docstring} evorl.envs.jaxmarl.get_random_actions
:parser: autodoc2_docstrings_parser
```
````

````{py:function} jaxmarl_space_to_evorl_space(space)
:canonical: evorl.envs.jaxmarl.jaxmarl_space_to_evorl_space

```{autodoc2-docstring} evorl.envs.jaxmarl.jaxmarl_space_to_evorl_space
:parser: autodoc2_docstrings_parser
```
````

````{py:data} ma_brax_env_list
:canonical: evorl.envs.jaxmarl.ma_brax_env_list
:value: >
   ('ant_4x2', 'halfcheetah_6x1', 'hopper_3x1', 'humanoid_9|8', 'walker2d_2x3')

```{autodoc2-docstring} evorl.envs.jaxmarl.ma_brax_env_list
:parser: autodoc2_docstrings_parser
```

````

````{py:data} supported_jaxmarl_env_list
:canonical: evorl.envs.jaxmarl.supported_jaxmarl_env_list
:value: >
   ('MPE_simple_v3', 'MPE_simple_tag_v3', 'MPE_simple_world_comm_v3', 'MPE_simple_spread_v3', 'MPE_simp...

```{autodoc2-docstring} evorl.envs.jaxmarl.supported_jaxmarl_env_list
:parser: autodoc2_docstrings_parser
```

````