# {py:mod}`evorl.utils.running_statistics`

```{py:module} evorl.utils.running_statistics
```

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

## Module Contents

### Classes

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

* - {py:obj}`NestedMeanStd <evorl.utils.running_statistics.NestedMeanStd>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.NestedMeanStd
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`RunningStatisticsState <evorl.utils.running_statistics.RunningStatisticsState>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.RunningStatisticsState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`denormalize <evorl.utils.running_statistics.denormalize>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.denormalize
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`init_state <evorl.utils.running_statistics.init_state>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.init_state
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`normalize <evorl.utils.running_statistics.normalize>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.normalize
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`update <evorl.utils.running_statistics.update>`
  - ```{autodoc2-docstring} evorl.utils.running_statistics.update
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} NestedMeanStd
:canonical: evorl.utils.running_statistics.NestedMeanStd

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

```{autodoc2-docstring} evorl.utils.running_statistics.NestedMeanStd
:parser: autodoc2_docstrings_parser
```

````{py:attribute} mean
:canonical: evorl.utils.running_statistics.NestedMeanStd.mean
:type: chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.utils.running_statistics.NestedMeanStd.mean
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} std
:canonical: evorl.utils.running_statistics.NestedMeanStd.std
:type: chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.utils.running_statistics.NestedMeanStd.std
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} RunningStatisticsState
:canonical: evorl.utils.running_statistics.RunningStatisticsState

Bases: {py:obj}`evorl.utils.running_statistics.NestedMeanStd`

```{autodoc2-docstring} evorl.utils.running_statistics.RunningStatisticsState
:parser: autodoc2_docstrings_parser
```

````{py:attribute} count
:canonical: evorl.utils.running_statistics.RunningStatisticsState.count
:type: chex.Array
:value: >
   None

```{autodoc2-docstring} evorl.utils.running_statistics.RunningStatisticsState.count
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} summed_variance
:canonical: evorl.utils.running_statistics.RunningStatisticsState.summed_variance
:type: chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.utils.running_statistics.RunningStatisticsState.summed_variance
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:function} denormalize(batch: chex.Array, mean_std: evorl.utils.running_statistics.NestedMeanStd) -> chex.Array
:canonical: evorl.utils.running_statistics.denormalize

```{autodoc2-docstring} evorl.utils.running_statistics.denormalize
:parser: autodoc2_docstrings_parser
```
````

````{py:function} init_state(nest: chex.ArrayTree, int_counter: bool = False) -> evorl.utils.running_statistics.RunningStatisticsState
:canonical: evorl.utils.running_statistics.init_state

```{autodoc2-docstring} evorl.utils.running_statistics.init_state
:parser: autodoc2_docstrings_parser
```
````

````{py:function} normalize(batch: chex.Array, mean_std: evorl.utils.running_statistics.NestedMeanStd, eps: float = 1e-08, max_abs_value: float | None = None) -> chex.Array
:canonical: evorl.utils.running_statistics.normalize

```{autodoc2-docstring} evorl.utils.running_statistics.normalize
:parser: autodoc2_docstrings_parser
```
````

````{py:function} update(state: evorl.utils.running_statistics.RunningStatisticsState, batch: chex.ArrayTree, *, weights: chex.Array | None = None, std_min_value: float = 1e-06, std_max_value: float = 1000000.0, dp_axis_name: str | None = None, validate_shapes: bool = True) -> evorl.utils.running_statistics.RunningStatisticsState
:canonical: evorl.utils.running_statistics.update

```{autodoc2-docstring} evorl.utils.running_statistics.update
:parser: autodoc2_docstrings_parser
```
````