# {py:mod}`evox.problems.hpo_wrapper`

```{py:module} evox.problems.hpo_wrapper
```

```{autodoc2-docstring} evox.problems.hpo_wrapper
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`HPOMonitor <evox.problems.hpo_wrapper.HPOMonitor>`
  - ```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOMonitor
    :summary:
    ```
* - {py:obj}`HPOFitnessMonitor <evox.problems.hpo_wrapper.HPOFitnessMonitor>`
  - ```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOFitnessMonitor
    :summary:
    ```
* - {py:obj}`HPOProblemWrapper <evox.problems.hpo_wrapper.HPOProblemWrapper>`
  - ```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper
    :summary:
    ```
* - {py:obj}`HPOData <evox.problems.hpo_wrapper.HPOData>`
  - ```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData
    :summary:
    ```
````

### API

`````{py:class} HPOMonitor(num_repeats: int = 1, fit_aggregation: typing.Optional[typing.Callable[[torch.Tensor, int], torch.Tensor]] = _mean_fit_aggregation)
:canonical: evox.problems.hpo_wrapper.HPOMonitor

Bases: {py:obj}`evox.core.Monitor`, {py:obj}`abc.ABC`

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOMonitor
```

```{rubric} Initialization
```

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOMonitor.__init__
```

````{py:method} tell_fitness() -> torch.Tensor
:canonical: evox.problems.hpo_wrapper.HPOMonitor.tell_fitness
:abstractmethod:

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOMonitor.tell_fitness
```

````

`````

`````{py:class} HPOFitnessMonitor(num_repeats: int = 1, fit_aggregation: typing.Optional[typing.Callable[[torch.Tensor, int], torch.Tensor]] = _mean_fit_aggregation, multi_obj_metric: typing.Optional[typing.Callable] = None)
:canonical: evox.problems.hpo_wrapper.HPOFitnessMonitor

Bases: {py:obj}`evox.problems.hpo_wrapper.HPOMonitor`

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOFitnessMonitor
```

```{rubric} Initialization
```

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOFitnessMonitor.__init__
```

````{py:method} pre_tell(fitness: torch.Tensor)
:canonical: evox.problems.hpo_wrapper.HPOFitnessMonitor.pre_tell

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOFitnessMonitor.pre_tell
```

````

````{py:method} tell_fitness() -> torch.Tensor
:canonical: evox.problems.hpo_wrapper.HPOFitnessMonitor.tell_fitness

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOFitnessMonitor.tell_fitness
```

````

`````

`````{py:class} HPOProblemWrapper(iterations: int, num_instances: int, workflow: evox.core.Workflow, num_repeats: int = 1, copy_init_state: bool = False)
:canonical: evox.problems.hpo_wrapper.HPOProblemWrapper

Bases: {py:obj}`evox.core.Problem`

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper
```

```{rubric} Initialization
```

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper.__init__
```

````{py:method} evaluate(hyper_parameters: typing.Dict[str, torch.nn.Parameter])
:canonical: evox.problems.hpo_wrapper.HPOProblemWrapper.evaluate

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper.evaluate
```

````

````{py:method} get_init_params()
:canonical: evox.problems.hpo_wrapper.HPOProblemWrapper.get_init_params

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper.get_init_params
```

````

````{py:method} get_params_keys()
:canonical: evox.problems.hpo_wrapper.HPOProblemWrapper.get_params_keys

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOProblemWrapper.get_params_keys
```

````

`````

`````{py:class} HPOData
:canonical: evox.problems.hpo_wrapper.HPOData

Bases: {py:obj}`typing.NamedTuple`

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData
```

````{py:attribute} workflow_step
:canonical: evox.problems.hpo_wrapper.HPOData.workflow_step
:type: typing.Callable[[typing.Dict[str, torch.Tensor]], typing.Tuple[typing.Dict[str, torch.Tensor]]]
:value: >
   None

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData.workflow_step
```

````

````{py:attribute} compiled_workflow_step
:canonical: evox.problems.hpo_wrapper.HPOData.compiled_workflow_step
:type: typing.Callable[[typing.Dict[str, torch.Tensor]], typing.Tuple[typing.Dict[str, torch.Tensor]]]
:value: >
   None

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData.compiled_workflow_step
```

````

````{py:attribute} state_keys
:canonical: evox.problems.hpo_wrapper.HPOData.state_keys
:type: typing.List[str]
:value: >
   None

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData.state_keys
```

````

````{py:attribute} buffer_keys
:canonical: evox.problems.hpo_wrapper.HPOData.buffer_keys
:type: typing.Optional[typing.List[str]]
:value: >
   None

```{autodoc2-docstring} evox.problems.hpo_wrapper.HPOData.buffer_keys
```

````

`````