Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update doc to run Katib experiment without the goal #1983

Merged
merged 1 commit into from
Jun 9, 2020
Merged

Update doc to run Katib experiment without the goal #1983

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions content/en/docs/components/hyperparameter-tuning/experiment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,20 @@ These are the fields in the experiment configuration spec:
A common metric is the model's accuracy in the validation pass of the training
job (*validation-accuracy*). You also specify whether you want Katib to
maximize or minimize the metric.
Katib uses the `objectiveMetricName` and `additionalMetricNames` to monitor
how the hyperparameters work with the model.
Katib records the value of the best `objectiveMetricName` metric (maximized
or minimized based on `type`) and the corresponding hyperparameter set
in `Experiment.status`. If the `objectiveMetricName` metric for a set of
hyperparameters reaches the `goal`, Katib stops trying more hyperparameter
combinations. See the [`ObjectiveSpec`

Katib uses the `objectiveMetricName` and `additionalMetricNames` to monitor
how the hyperparameters work with the model.
Katib records the value of the best `objectiveMetricName` metric (maximized
or minimized based on `type`) and the corresponding hyperparameter set
in `Experiment.status`. If the `objectiveMetricName` metric for a set of
hyperparameters reaches the `goal`, Katib stops trying more hyperparameter
combinations.

You can run experiment without specifying the `goal`. In that case, Katib
runs experiment until corresponding succeeded trials reaches `maxTrialCount`.
`maxTrialCount` parameter is described bellow.

See the [`ObjectiveSpec`
type](https://github.com/kubeflow/katib/blob/master/pkg/apis/controller/common/v1alpha3/common_types.go#L47).

* **algorithm**: The search algorithm that you want Katib to use to find the
Expand Down