Google Cloud Ai Platform V1 Client - Class StudyStoppingConfig (1.13.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class StudyStoppingConfig.

The configuration (stopping conditions) for automated stopping of a Study.

Conditions include trial budgets, time budgets, and convergence detection.

Generated from protobuf message google.cloud.aiplatform.v1.StudySpec.StudyStoppingConfig

Namespace

Google \ Cloud \ AIPlatform \ V1 \ StudySpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ should_stop_asap Google\Protobuf\BoolValue

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
↳ minimum_runtime_constraint Google\Cloud\AIPlatform\V1\StudyTimeConstraint

Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting min_num_trials=5 and always_stop_after= 1 hour means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.
↳ maximum_runtime_constraint Google\Cloud\AIPlatform\V1\StudyTimeConstraint

If the specified time or duration has passed, stop the study.
↳ min_num_trials Google\Protobuf\Int32Value

If there are fewer than this many COMPLETED trials, do not stop the study.
↳ max_num_trials Google\Protobuf\Int32Value

If there are more than this many trials, stop the study.
↳ max_num_trials_no_progress Google\Protobuf\Int32Value

If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.
↳ max_duration_no_progress Google\Protobuf\Duration

If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.

getShouldStopAsap

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.

The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).

Returns
Type Description
Google\Protobuf\BoolValue|null

hasShouldStopAsap

clearShouldStopAsap

getShouldStopAsapUnwrapped

Returns the unboxed value from getShouldStopAsap()

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).

Returns
Type Description
bool|null

setShouldStopAsap

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state.

The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setShouldStopAsapUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).

Parameter
Name Description
var bool|null
Returns
Type Description
$this

getMinimumRuntimeConstraint

Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list.

Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting min_num_trials=5 and always_stop_after= 1 hour means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudyTimeConstraint|null

hasMinimumRuntimeConstraint

clearMinimumRuntimeConstraint

setMinimumRuntimeConstraint

Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list.

Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting min_num_trials=5 and always_stop_after= 1 hour means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to resume a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\StudyTimeConstraint
Returns
Type Description
$this

getMaximumRuntimeConstraint

If the specified time or duration has passed, stop the study.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudyTimeConstraint|null

hasMaximumRuntimeConstraint

clearMaximumRuntimeConstraint

setMaximumRuntimeConstraint

If the specified time or duration has passed, stop the study.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\StudyTimeConstraint
Returns
Type Description
$this

getMinNumTrials

If there are fewer than this many COMPLETED trials, do not stop the study.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasMinNumTrials

clearMinNumTrials

getMinNumTrialsUnwrapped

Returns the unboxed value from getMinNumTrials()

If there are fewer than this many COMPLETED trials, do not stop the study.

Returns
Type Description
int|null

setMinNumTrials

If there are fewer than this many COMPLETED trials, do not stop the study.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setMinNumTrialsUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

If there are fewer than this many COMPLETED trials, do not stop the study.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getMaxNumTrials

If there are more than this many trials, stop the study.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasMaxNumTrials

clearMaxNumTrials

getMaxNumTrialsUnwrapped

Returns the unboxed value from getMaxNumTrials()

If there are more than this many trials, stop the study.

Returns
Type Description
int|null

setMaxNumTrials

If there are more than this many trials, stop the study.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setMaxNumTrialsUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

If there are more than this many trials, stop the study.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getMaxNumTrialsNoProgress

If the objective value has not improved for this many consecutive trials, stop the study.

WARNING: Effective only for single-objective studies.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasMaxNumTrialsNoProgress

clearMaxNumTrialsNoProgress

getMaxNumTrialsNoProgressUnwrapped

Returns the unboxed value from getMaxNumTrialsNoProgress()

If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.

Returns
Type Description
int|null

setMaxNumTrialsNoProgress

If the objective value has not improved for this many consecutive trials, stop the study.

WARNING: Effective only for single-objective studies.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setMaxNumTrialsNoProgressUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getMaxDurationNoProgress

If the objective value has not improved for this much time, stop the study.

WARNING: Effective only for single-objective studies.

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxDurationNoProgress

clearMaxDurationNoProgress

setMaxDurationNoProgress

If the objective value has not improved for this much time, stop the study.

WARNING: Effective only for single-objective studies.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this