From 74e66983d7121d0c0aa1138290e43143b2a89e89 Mon Sep 17 00:00:00 2001 From: avelichk Date: Tue, 9 Jun 2020 00:17:38 +0100 Subject: [PATCH] Update doc to run Experiment without the goal --- .../hyperparameter-tuning/experiment.md | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/content/en/docs/components/hyperparameter-tuning/experiment.md b/content/en/docs/components/hyperparameter-tuning/experiment.md index d4fc497a15..c2f48b40b6 100644 --- a/content/en/docs/components/hyperparameter-tuning/experiment.md +++ b/content/en/docs/components/hyperparameter-tuning/experiment.md @@ -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