Add note describing how to use HPO app with Hydra (#446)

This commit is contained in:
pollfly 2023-01-19 17:30:41 +02:00 committed by GitHub
parent a51ddbd674
commit e2a0189b0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -39,7 +39,21 @@ limits.
* Step Size - Step size between samples * Step Size - Step size between samples
* Discrete Parameters - A set of values to sample * Discrete Parameters - A set of values to sample
* Values - Comma separated list of values to sample * Values - Comma separated list of values to sample
* Name - The original tasks configuration parameter name (including section name e.g. `Args/lr`) * Name - The original tasks configuration parameter name (including section name e.g. `Args/lr`) <br/>
:::tip Hydra Parameters
For experiments using Hydra, input parameters from the OmegaConf in the following format:
`Hydra/<param>`. Specify `<param>` using dot notation. For example, if your OmegaConf looks like this:
```
dataset:
user: root
main:
number: 80
```
Specify the `number` parameter with `Hydra/dataset.main.number`.
Additionally, make sure that the initial experiment's `_allow_omegaconf_edit_` parameter is set to `False` (in experiment's
**CONFIGURATION > HYPERPARAMETERS > Hydra**).
:::
* **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list * **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list
* **Optimization Experiments Destination Project** (Optional) - The project where optimization tasks will be saved. * **Optimization Experiments Destination Project** (Optional) - The project where optimization tasks will be saved.
Leave empty to use the same project as the Initial task. Leave empty to use the same project as the Initial task.