# {py:mod}`evorl.recorders`

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

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

## Package Contents

### Classes

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

* - {py:obj}`ChainRecorder <evorl.recorders.recorder.ChainRecorder>`
  - ```{autodoc2-docstring} evorl.recorders.recorder.ChainRecorder
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`LogRecorder <evorl.recorders.log_recorder.LogRecorder>`
  - ```{autodoc2-docstring} evorl.recorders.log_recorder.LogRecorder
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Recorder <evorl.recorders.recorder.Recorder>`
  - ```{autodoc2-docstring} evorl.recorders.recorder.Recorder
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`WandbRecorder <evorl.recorders.wandb_recorder.WandbRecorder>`
  - ```{autodoc2-docstring} evorl.recorders.wandb_recorder.WandbRecorder
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`add_prefix <evorl.recorders.wandb_recorder.add_prefix>`
  - ```{autodoc2-docstring} evorl.recorders.wandb_recorder.add_prefix
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_1d_array <evorl.recorders.wandb_recorder.get_1d_array>`
  - ```{autodoc2-docstring} evorl.recorders.wandb_recorder.get_1d_array
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_1d_array_statistics <evorl.recorders.wandb_recorder.get_1d_array_statistics>`
  - ```{autodoc2-docstring} evorl.recorders.wandb_recorder.get_1d_array_statistics
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} ChainRecorder(recorders: collections.abc.Sequence[evorl.recorders.recorder.Recorder])
:canonical: evorl.recorders.recorder.ChainRecorder

Bases: {py:obj}`evorl.recorders.recorder.Recorder`

```{autodoc2-docstring} evorl.recorders.recorder.ChainRecorder
:parser: autodoc2_docstrings_parser
```

````{py:method} add_recorder(recorder: evorl.recorders.recorder.Recorder) -> None
:canonical: evorl.recorders.recorder.ChainRecorder.add_recorder

```{autodoc2-docstring} evorl.recorders.recorder.ChainRecorder.add_recorder
:parser: autodoc2_docstrings_parser
```

````

````{py:method} close() -> None
:canonical: evorl.recorders.recorder.ChainRecorder.close

````

````{py:method} init() -> None
:canonical: evorl.recorders.recorder.ChainRecorder.init

````

````{py:method} write(data: collections.abc.Mapping[str, typing.Any], step: int | None = None) -> None
:canonical: evorl.recorders.recorder.ChainRecorder.write

````

`````

`````{py:class} LogRecorder(log_path: str, console: bool = True)
:canonical: evorl.recorders.log_recorder.LogRecorder

Bases: {py:obj}`evorl.recorders.recorder.Recorder`

```{autodoc2-docstring} evorl.recorders.log_recorder.LogRecorder
:parser: autodoc2_docstrings_parser
```

````{py:method} close() -> None
:canonical: evorl.recorders.log_recorder.LogRecorder.close

````

````{py:method} init() -> None
:canonical: evorl.recorders.log_recorder.LogRecorder.init

````

````{py:method} write(data: collections.abc.Mapping[str, typing.Any], step: int | None = None) -> None
:canonical: evorl.recorders.log_recorder.LogRecorder.write

````

`````

`````{py:class} Recorder
:canonical: evorl.recorders.recorder.Recorder

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} evorl.recorders.recorder.Recorder
:parser: autodoc2_docstrings_parser
```

````{py:method} close() -> None
:canonical: evorl.recorders.recorder.Recorder.close
:abstractmethod:

```{autodoc2-docstring} evorl.recorders.recorder.Recorder.close
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init() -> None
:canonical: evorl.recorders.recorder.Recorder.init
:abstractmethod:

```{autodoc2-docstring} evorl.recorders.recorder.Recorder.init
:parser: autodoc2_docstrings_parser
```

````

````{py:method} write(data: collections.abc.Mapping[str, typing.Any], step: int | None = None) -> None
:canonical: evorl.recorders.recorder.Recorder.write
:abstractmethod:

```{autodoc2-docstring} evorl.recorders.recorder.Recorder.write
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} WandbRecorder(*, project, name, config, tags, path, **wandb_kwargs)
:canonical: evorl.recorders.wandb_recorder.WandbRecorder

Bases: {py:obj}`evorl.recorders.recorder.Recorder`

```{autodoc2-docstring} evorl.recorders.wandb_recorder.WandbRecorder
:parser: autodoc2_docstrings_parser
```

````{py:method} close()
:canonical: evorl.recorders.wandb_recorder.WandbRecorder.close

````

````{py:method} init() -> None
:canonical: evorl.recorders.wandb_recorder.WandbRecorder.init

````

````{py:method} write(data: collections.abc.Mapping[str, typing.Any], step: int | None = None) -> None
:canonical: evorl.recorders.wandb_recorder.WandbRecorder.write

````

`````

````{py:function} add_prefix(data: dict, prefix: str)
:canonical: evorl.recorders.wandb_recorder.add_prefix

```{autodoc2-docstring} evorl.recorders.wandb_recorder.add_prefix
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_1d_array(data)
:canonical: evorl.recorders.wandb_recorder.get_1d_array

```{autodoc2-docstring} evorl.recorders.wandb_recorder.get_1d_array
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_1d_array_statistics(data, histogram=False)
:canonical: evorl.recorders.wandb_recorder.get_1d_array_statistics

```{autodoc2-docstring} evorl.recorders.wandb_recorder.get_1d_array_statistics
:parser: autodoc2_docstrings_parser
```
````