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

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

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

## Module Contents

### Classes

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

* - {py:obj}`EnvPoolGymAdapter <evorl.envs.envpool.EnvPoolGymAdapter>`
  - ```{autodoc2-docstring} evorl.envs.envpool.EnvPoolGymAdapter
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`OneEpisodeWrapper <evorl.envs.envpool.OneEpisodeWrapper>`
  - ```{autodoc2-docstring} evorl.envs.envpool.OneEpisodeWrapper
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`create_envpool_env <evorl.envs.envpool.create_envpool_env>`
  - ```{autodoc2-docstring} evorl.envs.envpool.create_envpool_env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`gym_space_to_evorl_space <evorl.envs.envpool.gym_space_to_evorl_space>`
  - ```{autodoc2-docstring} evorl.envs.envpool.gym_space_to_evorl_space
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} EnvPoolGymAdapter(env_name: str, max_episode_steps: int, num_envs: int, discount: float | None = None, **env_kwargs)
:canonical: evorl.envs.envpool.EnvPoolGymAdapter

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

```{autodoc2-docstring} evorl.envs.envpool.EnvPoolGymAdapter
:parser: autodoc2_docstrings_parser
```

````{py:property} action_space
:canonical: evorl.envs.envpool.EnvPoolGymAdapter.action_space
:type: evorl.envs.space.Space

````

````{py:property} obs_space
:canonical: evorl.envs.envpool.EnvPoolGymAdapter.obs_space
:type: evorl.envs.space.Space

````

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

````

````{py:method} setup_env_callback()
:canonical: evorl.envs.envpool.EnvPoolGymAdapter.setup_env_callback

```{autodoc2-docstring} evorl.envs.envpool.EnvPoolGymAdapter.setup_env_callback
:parser: autodoc2_docstrings_parser
```

````

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

````

`````

`````{py:class} OneEpisodeWrapper(env: evorl.envs.env.Env)
:canonical: evorl.envs.envpool.OneEpisodeWrapper

Bases: {py:obj}`evorl.envs.wrappers.Wrapper`

```{autodoc2-docstring} evorl.envs.envpool.OneEpisodeWrapper
:parser: autodoc2_docstrings_parser
```

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

````

`````

````{py:function} create_envpool_env(env_name, episode_length: int = 1000, parallel: int = 1, autoreset_mode: evorl.envs.wrappers.AutoresetMode = AutoresetMode.ENVPOOL, discount: float | None = 1.0, **kwargs) -> evorl.envs.envpool.EnvPoolGymAdapter
:canonical: evorl.envs.envpool.create_envpool_env

```{autodoc2-docstring} evorl.envs.envpool.create_envpool_env
:parser: autodoc2_docstrings_parser
```
````

````{py:function} gym_space_to_evorl_space(space: gymnasium.Space) -> evorl.envs.space.Space
:canonical: evorl.envs.envpool.gym_space_to_evorl_space

```{autodoc2-docstring} evorl.envs.envpool.gym_space_to_evorl_space
:parser: autodoc2_docstrings_parser
```
````