# {py:mod}`evorl.agent`

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

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

## Module Contents

### Classes

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

* - {py:obj}`Agent <evorl.agent.Agent>`
  - ```{autodoc2-docstring} evorl.agent.Agent
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`AgentActionFn <evorl.agent.AgentActionFn>`
  - ```{autodoc2-docstring} evorl.agent.AgentActionFn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`AgentState <evorl.agent.AgentState>`
  - ```{autodoc2-docstring} evorl.agent.AgentState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`LossFn <evorl.agent.LossFn>`
  - ```{autodoc2-docstring} evorl.agent.LossFn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ObsPreprocessorFn <evorl.agent.ObsPreprocessorFn>`
  - ```{autodoc2-docstring} evorl.agent.ObsPreprocessorFn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`RandomAgent <evorl.agent.RandomAgent>`
  - ```{autodoc2-docstring} evorl.agent.RandomAgent
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`AgentStateAxis <evorl.agent.AgentStateAxis>`
  - ```{autodoc2-docstring} evorl.agent.AgentStateAxis
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} Agent
:canonical: evorl.agent.Agent

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

```{autodoc2-docstring} evorl.agent.Agent
:parser: autodoc2_docstrings_parser
```

````{py:method} compute_actions(agent_state: evorl.agent.AgentState, sample_batch: evorl.sample_batch.SampleBatch, key: chex.PRNGKey) -> tuple[evorl.types.Action, evorl.types.PolicyExtraInfo]
:canonical: evorl.agent.Agent.compute_actions
:abstractmethod:

```{autodoc2-docstring} evorl.agent.Agent.compute_actions
:parser: autodoc2_docstrings_parser
```

````

````{py:method} evaluate_actions(agent_state: evorl.agent.AgentState, sample_batch: evorl.sample_batch.SampleBatch, key: chex.PRNGKey) -> tuple[evorl.types.Action, evorl.types.PolicyExtraInfo]
:canonical: evorl.agent.Agent.evaluate_actions
:abstractmethod:

```{autodoc2-docstring} evorl.agent.Agent.evaluate_actions
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init(obs_space: evorl.envs.Space, action_space: evorl.envs.Space, key: chex.PRNGKey) -> evorl.agent.AgentState
:canonical: evorl.agent.Agent.init
:abstractmethod:

```{autodoc2-docstring} evorl.agent.Agent.init
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:class} AgentActionFn
:canonical: evorl.agent.AgentActionFn

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

```{autodoc2-docstring} evorl.agent.AgentActionFn
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} AgentState
:canonical: evorl.agent.AgentState

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

```{autodoc2-docstring} evorl.agent.AgentState
:parser: autodoc2_docstrings_parser
```

````{py:attribute} action_postprocessor_state
:canonical: evorl.agent.AgentState.action_postprocessor_state
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} evorl.agent.AgentState.action_postprocessor_state
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} extra_state
:canonical: evorl.agent.AgentState.extra_state
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} evorl.agent.AgentState.extra_state
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} obs_preprocessor_state
:canonical: evorl.agent.AgentState.obs_preprocessor_state
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} evorl.agent.AgentState.obs_preprocessor_state
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} params
:canonical: evorl.agent.AgentState.params
:type: collections.abc.Mapping[str, evorl.types.Params]
:value: >
   None

```{autodoc2-docstring} evorl.agent.AgentState.params
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:data} AgentStateAxis
:canonical: evorl.agent.AgentStateAxis
:value: >
   None

```{autodoc2-docstring} evorl.agent.AgentStateAxis
:parser: autodoc2_docstrings_parser
```

````

````{py:class} LossFn
:canonical: evorl.agent.LossFn

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

```{autodoc2-docstring} evorl.agent.LossFn
:parser: autodoc2_docstrings_parser
```

````

````{py:class} ObsPreprocessorFn
:canonical: evorl.agent.ObsPreprocessorFn

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

```{autodoc2-docstring} evorl.agent.ObsPreprocessorFn
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} RandomAgent
:canonical: evorl.agent.RandomAgent

Bases: {py:obj}`evorl.agent.Agent`

```{autodoc2-docstring} evorl.agent.RandomAgent
:parser: autodoc2_docstrings_parser
```

````{py:method} compute_actions(agent_state: evorl.agent.AgentState, sample_batch: evorl.sample_batch.SampleBatch, key: chex.PRNGKey) -> tuple[evorl.types.Action, evorl.types.PolicyExtraInfo]
:canonical: evorl.agent.RandomAgent.compute_actions

````

````{py:method} evaluate_actions(agent_state: evorl.agent.AgentState, sample_batch: evorl.sample_batch.SampleBatch, key: chex.PRNGKey) -> tuple[evorl.types.Action, evorl.types.PolicyExtraInfo]
:canonical: evorl.agent.RandomAgent.evaluate_actions

````

````{py:method} init(obs_space: evorl.envs.Space, action_space: evorl.envs.Space, key: chex.PRNGKey) -> evorl.agent.AgentState
:canonical: evorl.agent.RandomAgent.init

```{autodoc2-docstring} evorl.agent.RandomAgent.init
:parser: autodoc2_docstrings_parser
```

````

`````