# {py:mod}`evorl.ec.optimizers.ars`

```{py:module} evorl.ec.optimizers.ars
```

```{autodoc2-docstring} evorl.ec.optimizers.ars
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ARS <evorl.ec.optimizers.ars.ARS>`
  - ```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ARSState <evorl.ec.optimizers.ars.ARSState>`
  - ```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} ARS
:canonical: evorl.ec.optimizers.ars.ARS

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

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS
:parser: autodoc2_docstrings_parser
```

````{py:method} ask(state: evorl.ec.optimizers.ars.ARSState) -> tuple[evorl.types.Params, evorl.ec.optimizers.ec_optimizer.ECState]
:canonical: evorl.ec.optimizers.ars.ARS.ask

````

````{py:attribute} fitness_std_eps
:canonical: evorl.ec.optimizers.ars.ARS.fitness_std_eps
:type: float
:value: >
   1e-08

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.fitness_std_eps
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init(mean: evorl.types.Params, key: chex.PRNGKey) -> evorl.ec.optimizers.ars.ARSState
:canonical: evorl.ec.optimizers.ars.ARS.init

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.init
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} lr
:canonical: evorl.ec.optimizers.ars.ARS.lr
:type: float
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.lr
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} noise_std
:canonical: evorl.ec.optimizers.ars.ARS.noise_std
:type: float
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.noise_std
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} num_elites
:canonical: evorl.ec.optimizers.ars.ARS.num_elites
:type: int
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.num_elites
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} optimizer
:canonical: evorl.ec.optimizers.ars.ARS.optimizer
:type: optax.GradientTransformation
:value: >
   'pytree_field(...)'

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.optimizer
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} optimizer_name
:canonical: evorl.ec.optimizers.ars.ARS.optimizer_name
:type: str
:value: >
   'sgd'

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.optimizer_name
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} pop_size
:canonical: evorl.ec.optimizers.ars.ARS.pop_size
:type: int
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARS.pop_size
:parser: autodoc2_docstrings_parser
```

````

````{py:method} tell(state: evorl.ec.optimizers.ars.ARSState, fitnesses: chex.Array) -> tuple[evorl.types.PyTreeDict, evorl.ec.optimizers.ars.ARSState]
:canonical: evorl.ec.optimizers.ars.ARS.tell

````

`````

`````{py:class} ARSState
:canonical: evorl.ec.optimizers.ars.ARSState

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

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState
:parser: autodoc2_docstrings_parser
```

````{py:attribute} key
:canonical: evorl.ec.optimizers.ars.ARSState.key
:type: chex.PRNGKey
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState.key
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} mean
:canonical: evorl.ec.optimizers.ars.ARSState.mean
:type: chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState.mean
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} noise
:canonical: evorl.ec.optimizers.ars.ARSState.noise
:type: None | chex.ArrayTree
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState.noise
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} opt_state
:canonical: evorl.ec.optimizers.ars.ARSState.opt_state
:type: optax.OptState
:value: >
   None

```{autodoc2-docstring} evorl.ec.optimizers.ars.ARSState.opt_state
:parser: autodoc2_docstrings_parser
```

````

`````