# {py:mod}`evorl.algorithms.erl.erl_td3.erl_td3_workflow`

```{py:module} evorl.algorithms.erl.erl_td3.erl_td3_workflow
```

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ERLTD3WorkflowTemplate <evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`build_erl_rl_update_fn <evorl.algorithms.erl.erl_td3.erl_td3_workflow.build_erl_rl_update_fn>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.build_erl_rl_update_fn
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`create_dummy_td3_trainmetric <evorl.algorithms.erl.erl_td3.erl_td3_workflow.create_dummy_td3_trainmetric>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.create_dummy_td3_trainmetric
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`erl_replace_td3_actor_params <evorl.algorithms.erl.erl_td3.erl_td3_workflow.erl_replace_td3_actor_params>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.erl_replace_td3_actor_params
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`rollout_episode <evorl.algorithms.erl.erl_td3.erl_td3_workflow.rollout_episode>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.rollout_episode
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`DUMMY_TD3_TRAINMETRIC <evorl.algorithms.erl.erl_td3.erl_td3_workflow.DUMMY_TD3_TRAINMETRIC>`
  - ```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.DUMMY_TD3_TRAINMETRIC
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:data} DUMMY_TD3_TRAINMETRIC
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.DUMMY_TD3_TRAINMETRIC
:value: >
   'TD3TrainMetric(...)'

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.DUMMY_TD3_TRAINMETRIC
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} ERLTD3WorkflowTemplate(**kwargs)
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate

Bases: {py:obj}`evorl.algorithms.erl.erl_workflow.ERLWorkflowBase`

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate
:parser: autodoc2_docstrings_parser
```

````{py:attribute} LOGGING_WARMUP_FLAG
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.LOGGING_WARMUP_FLAG
:value: >
   True

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.LOGGING_WARMUP_FLAG
:parser: autodoc2_docstrings_parser
```

````

````{py:method} setup(key: chex.PRNGKey) -> evorl.types.State
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.setup

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.setup
:parser: autodoc2_docstrings_parser
```

````

````{py:method} warmup_step(state: evorl.types.State) -> tuple[evorl.algorithms.erl.erl_workflow.ERLTrainMetric, evorl.types.State]
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.warmup_step

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.ERLTD3WorkflowTemplate.warmup_step
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:function} build_erl_rl_update_fn(agent: evorl.agent.Agent, optimizer: optax.GradientTransformation, config: omegaconf.DictConfig, agent_state_vmap_axes: evorl.agent.AgentState)
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.build_erl_rl_update_fn

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.build_erl_rl_update_fn
:parser: autodoc2_docstrings_parser
```
````

````{py:function} create_dummy_td3_trainmetric(num: int) -> evorl.algorithms.td3.TD3TrainMetric
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.create_dummy_td3_trainmetric

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.create_dummy_td3_trainmetric
:parser: autodoc2_docstrings_parser
```
````

````{py:function} erl_replace_td3_actor_params(agent_state: evorl.agent.AgentState, pop_actor_params: evorl.algorithms.td3.TD3NetworkParams) -> evorl.agent.AgentState
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.erl_replace_td3_actor_params

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.erl_replace_td3_actor_params
:parser: autodoc2_docstrings_parser
```
````

````{py:function} rollout_episode(agent_state: evorl.agent.AgentState, replay_buffer_state, key, *, collector, replay_buffer, agent_state_vmap_axes, num_episodes, num_agents)
:canonical: evorl.algorithms.erl.erl_td3.erl_td3_workflow.rollout_episode

```{autodoc2-docstring} evorl.algorithms.erl.erl_td3.erl_td3_workflow.rollout_episode
:parser: autodoc2_docstrings_parser
```
````