# {py:mod}`evorl.types`

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

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

## Module Contents

### Classes

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

* - {py:obj}`PyTreeArrayMixin <evorl.types.PyTreeArrayMixin>`
  - ```{autodoc2-docstring} evorl.types.PyTreeArrayMixin
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`PyTreeData <evorl.types.PyTreeData>`
  - ```{autodoc2-docstring} evorl.types.PyTreeData
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`PyTreeDict <evorl.types.PyTreeDict>`
  - ```{autodoc2-docstring} evorl.types.PyTreeDict
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`PyTreeNode <evorl.types.PyTreeNode>`
  - ```{autodoc2-docstring} evorl.types.PyTreeNode
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`State <evorl.types.State>`
  - ```{autodoc2-docstring} evorl.types.State
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`dataclass <evorl.types.dataclass>`
  - ```{autodoc2-docstring} evorl.types.dataclass
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`pytree_field <evorl.types.pytree_field>`
  - ```{autodoc2-docstring} evorl.types.pytree_field
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`Action <evorl.types.Action>`
  - ```{autodoc2-docstring} evorl.types.Action
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ActionPostprocessorParams <evorl.types.ActionPostprocessorParams>`
  - ```{autodoc2-docstring} evorl.types.ActionPostprocessorParams
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`AgentID <evorl.types.AgentID>`
  - ```{autodoc2-docstring} evorl.types.AgentID
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Axis <evorl.types.Axis>`
  - ```{autodoc2-docstring} evorl.types.Axis
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Done <evorl.types.Done>`
  - ```{autodoc2-docstring} evorl.types.Done
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`EnvInternalState <evorl.types.EnvInternalState>`
  - ```{autodoc2-docstring} evorl.types.EnvInternalState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ExtraInfo <evorl.types.ExtraInfo>`
  - ```{autodoc2-docstring} evorl.types.ExtraInfo
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`LossDict <evorl.types.LossDict>`
  - ```{autodoc2-docstring} evorl.types.LossDict
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`MISSING_REWARD <evorl.types.MISSING_REWARD>`
  - ```{autodoc2-docstring} evorl.types.MISSING_REWARD
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Metrics <evorl.types.Metrics>`
  - ```{autodoc2-docstring} evorl.types.Metrics
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ObsPreprocessorParams <evorl.types.ObsPreprocessorParams>`
  - ```{autodoc2-docstring} evorl.types.ObsPreprocessorParams
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Observation <evorl.types.Observation>`
  - ```{autodoc2-docstring} evorl.types.Observation
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Params <evorl.types.Params>`
  - ```{autodoc2-docstring} evorl.types.Params
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`PolicyExtraInfo <evorl.types.PolicyExtraInfo>`
  - ```{autodoc2-docstring} evorl.types.PolicyExtraInfo
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ReplayBufferState <evorl.types.ReplayBufferState>`
  - ```{autodoc2-docstring} evorl.types.ReplayBufferState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Reward <evorl.types.Reward>`
  - ```{autodoc2-docstring} evorl.types.Reward
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`RewardDict <evorl.types.RewardDict>`
  - ```{autodoc2-docstring} evorl.types.RewardDict
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:data} Action
:canonical: evorl.types.Action
:value: >
   None

```{autodoc2-docstring} evorl.types.Action
:parser: autodoc2_docstrings_parser
```

````

````{py:data} ActionPostprocessorParams
:canonical: evorl.types.ActionPostprocessorParams
:value: >
   None

```{autodoc2-docstring} evorl.types.ActionPostprocessorParams
:parser: autodoc2_docstrings_parser
```

````

````{py:data} AgentID
:canonical: evorl.types.AgentID
:value: >
   None

```{autodoc2-docstring} evorl.types.AgentID
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Axis
:canonical: evorl.types.Axis
:value: >
   None

```{autodoc2-docstring} evorl.types.Axis
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Done
:canonical: evorl.types.Done
:value: >
   None

```{autodoc2-docstring} evorl.types.Done
:parser: autodoc2_docstrings_parser
```

````

````{py:data} EnvInternalState
:canonical: evorl.types.EnvInternalState
:value: >
   None

```{autodoc2-docstring} evorl.types.EnvInternalState
:parser: autodoc2_docstrings_parser
```

````

````{py:data} ExtraInfo
:canonical: evorl.types.ExtraInfo
:value: >
   None

```{autodoc2-docstring} evorl.types.ExtraInfo
:parser: autodoc2_docstrings_parser
```

````

````{py:data} LossDict
:canonical: evorl.types.LossDict
:value: >
   None

```{autodoc2-docstring} evorl.types.LossDict
:parser: autodoc2_docstrings_parser
```

````

````{py:data} MISSING_REWARD
:canonical: evorl.types.MISSING_REWARD
:value: >
   None

```{autodoc2-docstring} evorl.types.MISSING_REWARD
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Metrics
:canonical: evorl.types.Metrics
:value: >
   None

```{autodoc2-docstring} evorl.types.Metrics
:parser: autodoc2_docstrings_parser
```

````

````{py:data} ObsPreprocessorParams
:canonical: evorl.types.ObsPreprocessorParams
:value: >
   None

```{autodoc2-docstring} evorl.types.ObsPreprocessorParams
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Observation
:canonical: evorl.types.Observation
:value: >
   None

```{autodoc2-docstring} evorl.types.Observation
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Params
:canonical: evorl.types.Params
:value: >
   None

```{autodoc2-docstring} evorl.types.Params
:parser: autodoc2_docstrings_parser
```

````

````{py:data} PolicyExtraInfo
:canonical: evorl.types.PolicyExtraInfo
:value: >
   None

```{autodoc2-docstring} evorl.types.PolicyExtraInfo
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} PyTreeArrayMixin
:canonical: evorl.types.PyTreeArrayMixin

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin
:parser: autodoc2_docstrings_parser
```

````{py:property} T
:canonical: evorl.types.PyTreeArrayMixin.T

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.T
:parser: autodoc2_docstrings_parser
```

````

````{py:method} concatenate(*others: chex.ArrayTree, axis: int = 0) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.concatenate

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.concatenate
:parser: autodoc2_docstrings_parser
```

````

````{py:method} index_set(idx: jax.Array | collections.abc.Sequence[jax.Array], o: chex.ArrayTree) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.index_set

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.index_set
:parser: autodoc2_docstrings_parser
```

````

````{py:method} index_sum(idx: jax.Array | collections.abc.Sequence[jax.Array], o: chex.ArrayTree) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.index_sum

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.index_sum
:parser: autodoc2_docstrings_parser
```

````

````{py:method} reshape(shape: collections.abc.Sequence[int]) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.reshape

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.reshape
:parser: autodoc2_docstrings_parser
```

````

````{py:method} slice(beg: int, end: int, strides=None) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.slice

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.slice
:parser: autodoc2_docstrings_parser
```

````

````{py:method} take(i, axis=0) -> chex.ArrayTree
:canonical: evorl.types.PyTreeArrayMixin.take

```{autodoc2-docstring} evorl.types.PyTreeArrayMixin.take
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:class} PyTreeData
:canonical: evorl.types.PyTreeData

```{autodoc2-docstring} evorl.types.PyTreeData
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} PyTreeDict(*args, **kwargs)
:canonical: evorl.types.PyTreeDict

Bases: {py:obj}`dict`

```{autodoc2-docstring} evorl.types.PyTreeDict
:parser: autodoc2_docstrings_parser
```

````{py:method} copy()
:canonical: evorl.types.PyTreeDict.copy

````

````{py:method} pop(k, d=None)
:canonical: evorl.types.PyTreeDict.pop

````

````{py:method} replace(**d)
:canonical: evorl.types.PyTreeDict.replace

```{autodoc2-docstring} evorl.types.PyTreeDict.replace
:parser: autodoc2_docstrings_parser
```

````

````{py:method} tree_flatten()
:canonical: evorl.types.PyTreeDict.tree_flatten

```{autodoc2-docstring} evorl.types.PyTreeDict.tree_flatten
:parser: autodoc2_docstrings_parser
```

````

````{py:method} tree_unflatten(aux_data, children)
:canonical: evorl.types.PyTreeDict.tree_unflatten
:classmethod:

```{autodoc2-docstring} evorl.types.PyTreeDict.tree_unflatten
:parser: autodoc2_docstrings_parser
```

````

````{py:method} update(e=None, **f)
:canonical: evorl.types.PyTreeDict.update

````

`````

`````{py:class} PyTreeNode
:canonical: evorl.types.PyTreeNode

```{autodoc2-docstring} evorl.types.PyTreeNode
:parser: autodoc2_docstrings_parser
```

````{py:method} set_frozen_attr(name, value)
:canonical: evorl.types.PyTreeNode.set_frozen_attr

```{autodoc2-docstring} evorl.types.PyTreeNode.set_frozen_attr
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:data} ReplayBufferState
:canonical: evorl.types.ReplayBufferState
:value: >
   None

```{autodoc2-docstring} evorl.types.ReplayBufferState
:parser: autodoc2_docstrings_parser
```

````

````{py:data} Reward
:canonical: evorl.types.Reward
:value: >
   None

```{autodoc2-docstring} evorl.types.Reward
:parser: autodoc2_docstrings_parser
```

````

````{py:data} RewardDict
:canonical: evorl.types.RewardDict
:value: >
   None

```{autodoc2-docstring} evorl.types.RewardDict
:parser: autodoc2_docstrings_parser
```

````

````{py:class} State(*args, **kwargs)
:canonical: evorl.types.State

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

```{autodoc2-docstring} evorl.types.State
:parser: autodoc2_docstrings_parser
```

````

````{py:function} dataclass(clz: evorl.types._T, *, pure_data=False, **kwargs) -> evorl.types._T
:canonical: evorl.types.dataclass

```{autodoc2-docstring} evorl.types.dataclass
:parser: autodoc2_docstrings_parser
```
````

````{py:function} pytree_field(*, static=False, **kwargs)
:canonical: evorl.types.pytree_field

```{autodoc2-docstring} evorl.types.pytree_field
:parser: autodoc2_docstrings_parser
```
````