# {py:mod}`evorl.evaluators.evaluator`

```{py:module} evorl.evaluators.evaluator
```

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

## Module Contents

### Classes

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

* - {py:obj}`Evaluator <evorl.evaluators.evaluator.Evaluator>`
  - ```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} Evaluator
:canonical: evorl.evaluators.evaluator.Evaluator

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

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator
:parser: autodoc2_docstrings_parser
```

````{py:attribute} action_fn
:canonical: evorl.evaluators.evaluator.Evaluator.action_fn
:type: evorl.agent.AgentActionFn
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator.action_fn
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} discount
:canonical: evorl.evaluators.evaluator.Evaluator.discount
:type: float
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator.discount
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} env
:canonical: evorl.evaluators.evaluator.Evaluator.env
:type: evorl.envs.Env
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator.env
:parser: autodoc2_docstrings_parser
```

````

````{py:method} evaluate(agent_state: evorl.agent.AgentState, key: chex.PRNGKey, num_episodes: int) -> evorl.metrics.EvaluateMetric
:canonical: evorl.evaluators.evaluator.Evaluator.evaluate

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator.evaluate
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} max_episode_steps
:canonical: evorl.evaluators.evaluator.Evaluator.max_episode_steps
:type: int
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.evaluators.evaluator.Evaluator.max_episode_steps
:parser: autodoc2_docstrings_parser
```

````

`````