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

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

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

## Module Contents

### Classes

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

* - {py:obj}`GymnaxAdapter <evorl.envs.gymnax.GymnaxAdapter>`
  - ```{autodoc2-docstring} evorl.envs.gymnax.GymnaxAdapter
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`create_gymnax_env <evorl.envs.gymnax.create_gymnax_env>`
  - ```{autodoc2-docstring} evorl.envs.gymnax.create_gymnax_env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`create_wrapped_gymnax_env <evorl.envs.gymnax.create_wrapped_gymnax_env>`
  - ```{autodoc2-docstring} evorl.envs.gymnax.create_wrapped_gymnax_env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`gymnax_space_to_evorl_space <evorl.envs.gymnax.gymnax_space_to_evorl_space>`
  - ```{autodoc2-docstring} evorl.envs.gymnax.gymnax_space_to_evorl_space
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} GymnaxAdapter(env: gymnax.environments.environment.Environment, env_params: chex.ArrayTree | None = None)
:canonical: evorl.envs.gymnax.GymnaxAdapter

Bases: {py:obj}`evorl.envs.env.EnvAdapter`

```{autodoc2-docstring} evorl.envs.gymnax.GymnaxAdapter
:parser: autodoc2_docstrings_parser
```

````{py:property} action_space
:canonical: evorl.envs.gymnax.GymnaxAdapter.action_space
:type: evorl.envs.space.Space

````

````{py:property} obs_space
:canonical: evorl.envs.gymnax.GymnaxAdapter.obs_space
:type: evorl.envs.space.Space

````

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

````

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

````

`````

````{py:function} create_gymnax_env(env_name: str, flatten_obs: bool = True, **kwargs) -> evorl.envs.gymnax.GymnaxAdapter
:canonical: evorl.envs.gymnax.create_gymnax_env

```{autodoc2-docstring} evorl.envs.gymnax.create_gymnax_env
:parser: autodoc2_docstrings_parser
```
````

````{py:function} create_wrapped_gymnax_env(env_name: str, flatten_obs: bool = True, episode_length: int = 1000, parallel: int = 1, autoreset_mode: evorl.envs.wrappers.training_wrapper.AutoresetMode = AutoresetMode.NORMAL, discount: float | None = 1.0, record_ori_obs: bool = False, **kwargs) -> evorl.envs.env.Env
:canonical: evorl.envs.gymnax.create_wrapped_gymnax_env

```{autodoc2-docstring} evorl.envs.gymnax.create_wrapped_gymnax_env
:parser: autodoc2_docstrings_parser
```
````

````{py:function} gymnax_space_to_evorl_space(space: gymnax.environments.spaces.Space)
:canonical: evorl.envs.gymnax.gymnax_space_to_evorl_space

```{autodoc2-docstring} evorl.envs.gymnax.gymnax_space_to_evorl_space
:parser: autodoc2_docstrings_parser
```
````