# {py:mod}`evorl.workflows.workflow`

```{py:module} evorl.workflows.workflow
```

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

## Module Contents

### Classes

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

* - {py:obj}`AbstractWorkflow <evorl.workflows.workflow.AbstractWorkflow>`
  - ```{autodoc2-docstring} evorl.workflows.workflow.AbstractWorkflow
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`Workflow <evorl.workflows.workflow.Workflow>`
  - ```{autodoc2-docstring} evorl.workflows.workflow.Workflow
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} AbstractWorkflow
:canonical: evorl.workflows.workflow.AbstractWorkflow

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

```{autodoc2-docstring} evorl.workflows.workflow.AbstractWorkflow
:parser: autodoc2_docstrings_parser
```

````{py:method} init(key: chex.PRNGKey) -> evorl.types.State
:canonical: evorl.workflows.workflow.AbstractWorkflow.init
:abstractmethod:

```{autodoc2-docstring} evorl.workflows.workflow.AbstractWorkflow.init
:parser: autodoc2_docstrings_parser
```

````

````{py:method} name() -> str
:canonical: evorl.workflows.workflow.AbstractWorkflow.name
:classmethod:

```{autodoc2-docstring} evorl.workflows.workflow.AbstractWorkflow.name
:parser: autodoc2_docstrings_parser
```

````

````{py:method} step(state: evorl.types.State) -> tuple[typing.Any, evorl.types.State]
:canonical: evorl.workflows.workflow.AbstractWorkflow.step
:abstractmethod:

```{autodoc2-docstring} evorl.workflows.workflow.AbstractWorkflow.step
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} Workflow(config: omegaconf.DictConfig)
:canonical: evorl.workflows.workflow.Workflow

Bases: {py:obj}`evorl.workflows.workflow.AbstractWorkflow`

```{autodoc2-docstring} evorl.workflows.workflow.Workflow
:parser: autodoc2_docstrings_parser
```

````{py:method} add_recorders(recorders: evorl.recorders.Recorder) -> None
:canonical: evorl.workflows.workflow.Workflow.add_recorders

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.add_recorders
:parser: autodoc2_docstrings_parser
```

````

````{py:method} build_from_config(config: omegaconf.DictConfig, *args, **kwargs) -> typing_extensions.Self
:canonical: evorl.workflows.workflow.Workflow.build_from_config
:abstractmethod:
:classmethod:

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.build_from_config
:parser: autodoc2_docstrings_parser
```

````

````{py:method} close() -> None
:canonical: evorl.workflows.workflow.Workflow.close

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.close
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init(key: chex.PRNGKey) -> evorl.types.State
:canonical: evorl.workflows.workflow.Workflow.init

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.init
:parser: autodoc2_docstrings_parser
```

````

````{py:method} learn(state: evorl.types.State) -> evorl.types.State
:canonical: evorl.workflows.workflow.Workflow.learn
:abstractmethod:

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.learn
:parser: autodoc2_docstrings_parser
```

````

````{py:method} setup(key: chex.PRNGKey) -> evorl.types.State
:canonical: evorl.workflows.workflow.Workflow.setup
:abstractmethod:

```{autodoc2-docstring} evorl.workflows.workflow.Workflow.setup
:parser: autodoc2_docstrings_parser
```

````

`````