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

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

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

## Module Contents

### Classes

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

* - {py:obj}`Env <evorl.envs.env.Env>`
  - ```{autodoc2-docstring} evorl.envs.env.Env
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`EnvAdapter <evorl.envs.env.EnvAdapter>`
  - ```{autodoc2-docstring} evorl.envs.env.EnvAdapter
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`EnvState <evorl.envs.env.EnvState>`
  - ```{autodoc2-docstring} evorl.envs.env.EnvState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`EnvResetFn <evorl.envs.env.EnvResetFn>`
  - ```{autodoc2-docstring} evorl.envs.env.EnvResetFn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`EnvStepFn <evorl.envs.env.EnvStepFn>`
  - ```{autodoc2-docstring} evorl.envs.env.EnvStepFn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} Env
:canonical: evorl.envs.env.Env

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} evorl.envs.env.Env
:parser: autodoc2_docstrings_parser
```

````{py:property} action_space
:canonical: evorl.envs.env.Env.action_space
:abstractmethod:
:type: evorl.envs.space.Space

```{autodoc2-docstring} evorl.envs.env.Env.action_space
:parser: autodoc2_docstrings_parser
```

````

````{py:property} obs_space
:canonical: evorl.envs.env.Env.obs_space
:abstractmethod:
:type: evorl.envs.space.Space

```{autodoc2-docstring} evorl.envs.env.Env.obs_space
:parser: autodoc2_docstrings_parser
```

````

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

```{autodoc2-docstring} evorl.envs.env.Env.reset
:parser: autodoc2_docstrings_parser
```

````

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

```{autodoc2-docstring} evorl.envs.env.Env.step
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} EnvAdapter(env: typing.Any)
:canonical: evorl.envs.env.EnvAdapter

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

```{autodoc2-docstring} evorl.envs.env.EnvAdapter
:parser: autodoc2_docstrings_parser
```

````{py:property} unwrapped
:canonical: evorl.envs.env.EnvAdapter.unwrapped
:type: typing.Any

```{autodoc2-docstring} evorl.envs.env.EnvAdapter.unwrapped
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:data} EnvResetFn
:canonical: evorl.envs.env.EnvResetFn
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvResetFn
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} EnvState
:canonical: evorl.envs.env.EnvState

Bases: {py:obj}`evorl.types.PyTreeData`

```{autodoc2-docstring} evorl.envs.env.EnvState
:parser: autodoc2_docstrings_parser
```

````{py:attribute} done
:canonical: evorl.envs.env.EnvState.done
:type: evorl.types.Done
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvState.done
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} env_state
:canonical: evorl.envs.env.EnvState.env_state
:type: evorl.types.EnvInternalState
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvState.env_state
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} info
:canonical: evorl.envs.env.EnvState.info
:type: evorl.types.PyTreeDict
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.envs.env.EnvState.info
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} obs
:canonical: evorl.envs.env.EnvState.obs
:type: evorl.types.Observation
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvState.obs
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} reward
:canonical: evorl.envs.env.EnvState.reward
:type: evorl.types.Reward
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvState.reward
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:data} EnvStepFn
:canonical: evorl.envs.env.EnvStepFn
:value: >
   None

```{autodoc2-docstring} evorl.envs.env.EnvStepFn
:parser: autodoc2_docstrings_parser
```

````