Skip to content

Commit ee11af0

Browse files
authored
missing documentation for exclude_finished_job
1 parent c42bc81 commit ee11af0

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

articles/machine-learning/how-to-tune-hyperparameters.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,6 @@ You can configure the following parameters that control when a policy is applied
190190

191191
* `evaluation_interval`: the frequency of applying the policy. Each time the training script logs the primary metric counts as one interval. An `evaluation_interval` of 1 will apply the policy every time the training script reports the primary metric. An `evaluation_interval` of 2 will apply the policy every other time. If not specified, `evaluation_interval` is set to 1 by default.
192192
* `delay_evaluation`: delays the first policy evaluation for a specified number of intervals. This is an optional parameter that avoids premature termination of training runs by allowing all configurations to run for a minimum number of intervals. If specified, the policy applies every multiple of evaluation_interval that is greater than or equal to delay_evaluation.
193-
* `exclude_finished_jobs`: specifies whether to exclude finished jobs as part of the early termination policy. This is an optional parameter that ______. If specified, the policy _____.
194193

195194
Azure Machine Learning supports the following early termination policies:
196195
* [Bandit policy](#bandit-policy)
@@ -213,7 +212,6 @@ Specify the following configuration parameters:
213212
For example, consider a Bandit policy applied at interval 10. Assume that the best performing run at interval 10 reported a primary metric is 0.8 with a goal to maximize the primary metric. If the policy specifies a `slack_factor` of 0.2, any training runs whose best metric at interval 10 is less than 0.66 (0.8/(1+`slack_factor`)) will be terminated.
214213
* `evaluation_interval`: (optional) the frequency for applying the policy
215214
* `delay_evaluation`: (optional) delays the first policy evaluation for a specified number of intervals
216-
* `exclude_finished_jobs`: (optional) specifies whether to exclude finished jobs as part of the early termination policy
217215

218216

219217

@@ -231,7 +229,6 @@ In this example, the early termination policy is applied at every interval when
231229
This policy takes the following configuration parameters:
232230
* `evaluation_interval`: the frequency for applying the policy (optional parameter).
233231
* `delay_evaluation`: delays the first policy evaluation for a specified number of intervals (optional parameter).
234-
* `exclude_finished_jobs`: (optional) specifies whether to exclude finished jobs as part of the early termination policy
235232

236233

237234
```Python
@@ -250,15 +247,15 @@ This policy takes the following configuration parameters:
250247
* `truncation_percentage`: the percentage of lowest performing runs to terminate at each evaluation interval. An integer value between 1 and 99.
251248
* `evaluation_interval`: (optional) the frequency for applying the policy
252249
* `delay_evaluation`: (optional) delays the first policy evaluation for a specified number of intervals
253-
* `exclude_finished_jobs`: (optional) specifies whether to exclude finished jobs as part of the early termination policy
250+
* `exclude_finished_jobs`: specifies whether to exclude finished jobs when applying the policy
254251

255252

256253
```Python
257254
from azureml.train.hyperdrive import TruncationSelectionPolicy
258-
early_termination_policy = TruncationSelectionPolicy(evaluation_interval=1, truncation_percentage=20, delay_evaluation=5)
255+
early_termination_policy = TruncationSelectionPolicy(evaluation_interval=1, truncation_percentage=20, delay_evaluation=5, exclude_finished_jobs=true)
259256
```
260257

261-
In this example, the early termination policy is applied at every interval starting at evaluation interval 5. A run terminates at interval 5 if its performance at interval 5 is in the lowest 20% of performance of all runs at interval 5.
258+
In this example, the early termination policy is applied at every interval starting at evaluation interval 5. A run terminates at interval 5 if its performance at interval 5 is in the lowest 20% of performance of all runs at interval 5 and will exclude finished jobs when applying the policy.
262259

263260
### No termination policy (default)
264261

0 commit comments

Comments
 (0)