Cloud AI Platform v1 API - Class StudySpec.Types.StudyStoppingConfig (2.21.0) 

public sealed class StudySpec.Types.StudyStoppingConfig : IMessage<StudySpec.Types.StudyStoppingConfig>, IEquatable<StudySpec.Types.StudyStoppingConfig>, IDeepCloneable<StudySpec.Types.StudyStoppingConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class StudySpec.Types.StudyStoppingConfig.

The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.

Inheritance

object > StudySpec.Types.StudyStoppingConfig

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

StudyStoppingConfig()

public StudyStoppingConfig()

StudyStoppingConfig(StudyStoppingConfig)

public StudyStoppingConfig(StudySpec.Types.StudyStoppingConfig other)
Parameter
NameDescription
otherStudySpecTypesStudyStoppingConfig

Properties

MaxDurationNoProgress

public Duration MaxDurationNoProgress { get; set; }

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

WARNING: Effective only for single-objective studies.

Property Value
TypeDescription
Duration

MaxNumTrials

public int? MaxNumTrials { get; set; }

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

Property Value
TypeDescription
int

MaxNumTrialsNoProgress

public int? MaxNumTrialsNoProgress { get; set; }

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

WARNING: Effective only for single-objective studies.

Property Value
TypeDescription
int

MaximumRuntimeConstraint

public StudyTimeConstraint MaximumRuntimeConstraint { get; set; }

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

Property Value
TypeDescription
StudyTimeConstraint

MinNumTrials

public int? MinNumTrials { get; set; }

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

Property Value
TypeDescription
int

MinimumRuntimeConstraint

public StudyTimeConstraint MinimumRuntimeConstraint { get; set; }

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.

Property Value
TypeDescription
StudyTimeConstraint

ShouldStopAsap

public bool? ShouldStopAsap { get; set; }

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).

Property Value
TypeDescription
bool