# {py:mod}`evorl.algorithms.meta.pbt_openes.param_openes`

```{py:module} evorl.algorithms.meta.pbt_openes.param_openes
```

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`OpenES <evorl.algorithms.meta.pbt_openes.param_openes.OpenES>`
  -
* - {py:obj}`ParamOpenESWorkflow <evorl.algorithms.meta.pbt_openes.param_openes.ParamOpenESWorkflow>`
  -
````

### API

`````{py:class} OpenES
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES

Bases: {py:obj}`evorl.ec.optimizers.EvoOptimizer`

````{py:method} ask(state: evorl.ec.optimizers.ECState) -> tuple[chex.ArrayTree, evorl.ec.optimizers.ECState]
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.ask

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.ask
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} fitness_shaping_fn
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.fitness_shaping_fn
:type: collections.abc.Callable[[chex.Array], chex.Array]
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.fitness_shaping_fn
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init(mean: evorl.types.Params, key: chex.PRNGKey) -> evorl.ec.optimizers.ECState
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.init

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.init
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} lr
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.lr
:type: float
:value: >
   None

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.lr
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} mirror_sampling
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.mirror_sampling
:type: bool
:value: >
   True

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.mirror_sampling
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} noise_std
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.noise_std
:type: float
:value: >
   None

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.noise_std
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} optimizer
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.optimizer
:type: optax.GradientTransformation
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.optimizer
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} pop_size
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.pop_size
:type: int
:value: >
   None

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.pop_size
:parser: autodoc2_docstrings_parser
```

````

````{py:method} tell(state: evorl.ec.optimizers.ECState, fitnesses: chex.Array) -> tuple[evorl.types.PyTreeDict, evorl.ec.optimizers.openes.OpenESState]
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.tell

````

````{py:attribute} weight_decay
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.OpenES.weight_decay
:type: float | None
:value: >
   None

```{autodoc2-docstring} evorl.algorithms.meta.pbt_openes.param_openes.OpenES.weight_decay
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ParamOpenESWorkflow(*, env: evorl.envs.Env, agent: evorl.agent.Agent, ec_optimizer: evorl.ec.optimizers.EvoOptimizer, ec_evaluator: evorl.evaluators.Evaluator, evaluator: evorl.evaluators.Evaluator, agent_state_vmap_axes: evorl.agent.AgentStateAxis = 0, config: omegaconf.DictConfig)
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.ParamOpenESWorkflow

Bases: {py:obj}`evorl.algorithms.ec.so.openes.OpenESWorkflow`

````{py:method} name()
:canonical: evorl.algorithms.meta.pbt_openes.param_openes.ParamOpenESWorkflow.name
:classmethod:

````

`````