# {py:mod}`evorl.rollout`

```{py:module} evorl.rollout
```

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

## Module Contents

### Classes

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

* - {py:obj}`RolloutFn <evorl.rollout.RolloutFn>`
  -
````

### Functions

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

* - {py:obj}`env_step <evorl.rollout.env_step>`
  - ```{autodoc2-docstring} evorl.rollout.env_step
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`eval_env_step <evorl.rollout.eval_env_step>`
  - ```{autodoc2-docstring} evorl.rollout.eval_env_step
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`eval_rollout_episode <evorl.rollout.eval_rollout_episode>`
  - ```{autodoc2-docstring} evorl.rollout.eval_rollout_episode
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`fast_eval_rollout_episode <evorl.rollout.fast_eval_rollout_episode>`
  - ```{autodoc2-docstring} evorl.rollout.fast_eval_rollout_episode
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`rollout <evorl.rollout.rollout>`
  - ```{autodoc2-docstring} evorl.rollout.rollout
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

```{py:class} RolloutFn
:canonical: evorl.rollout.RolloutFn

Bases: {py:obj}`typing.Protocol`

```

````{py:function} env_step(env_fn: evorl.envs.EnvStepFn, action_fn: evorl.agent.AgentActionFn, env_state: evorl.envs.EnvState, agent_state: evorl.agent.AgentState, key: chex.PRNGKey, env_extra_fields: collections.abc.Sequence[str] = ()) -> tuple[evorl.sample_batch.SampleBatch, evorl.envs.EnvState]
:canonical: evorl.rollout.env_step

```{autodoc2-docstring} evorl.rollout.env_step
:parser: autodoc2_docstrings_parser
```
````

````{py:function} eval_env_step(env_fn: evorl.envs.EnvStepFn, action_fn: evorl.agent.AgentActionFn, env_state: evorl.envs.EnvState, agent_state: evorl.agent.AgentState, key: chex.PRNGKey) -> tuple[evorl.sample_batch.SampleBatch, evorl.envs.EnvState]
:canonical: evorl.rollout.eval_env_step

```{autodoc2-docstring} evorl.rollout.eval_env_step
:parser: autodoc2_docstrings_parser
```
````

````{py:function} eval_rollout_episode(env_fn: evorl.envs.EnvStepFn, action_fn: evorl.agent.AgentActionFn, env_state: evorl.envs.EnvState, agent_state: evorl.agent.AgentState, key: chex.PRNGKey, rollout_length: int) -> tuple[evorl.sample_batch.SampleBatch, evorl.envs.EnvState]
:canonical: evorl.rollout.eval_rollout_episode

```{autodoc2-docstring} evorl.rollout.eval_rollout_episode
:parser: autodoc2_docstrings_parser
```
````

````{py:function} fast_eval_rollout_episode(env_fn: evorl.envs.EnvStepFn, action_fn: evorl.agent.AgentActionFn, env_state: evorl.envs.EnvState, agent_state: evorl.agent.AgentState, key: chex.PRNGKey, rollout_length: int) -> tuple[evorl.types.PyTreeDict, evorl.envs.EnvState]
:canonical: evorl.rollout.fast_eval_rollout_episode

```{autodoc2-docstring} evorl.rollout.fast_eval_rollout_episode
:parser: autodoc2_docstrings_parser
```
````

````{py:function} rollout(env_fn: evorl.envs.EnvStepFn, action_fn: evorl.agent.AgentActionFn, env_state: evorl.envs.EnvState, agent_state: evorl.agent.AgentState, key: chex.PRNGKey, rollout_length: int, env_extra_fields: collections.abc.Sequence[str] = ()) -> tuple[evorl.sample_batch.SampleBatch, evorl.envs.EnvState]
:canonical: evorl.rollout.rollout

```{autodoc2-docstring} evorl.rollout.rollout
:parser: autodoc2_docstrings_parser
```
````