- 1.68.0 (latest)
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
StudySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents specification of a Study.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
decay_curve_stopping_spec |
google.cloud.aiplatform_v1.types.StudySpec.DecayCurveAutomatedStoppingSpec
The automated early stopping spec using decay curve rule. This field is a member of oneof _ automated_stopping_spec .
|
median_automated_stopping_spec |
google.cloud.aiplatform_v1.types.StudySpec.MedianAutomatedStoppingSpec
The automated early stopping spec using median rule. This field is a member of oneof _ automated_stopping_spec .
|
convex_automated_stopping_spec |
google.cloud.aiplatform_v1.types.StudySpec.ConvexAutomatedStoppingSpec
The automated early stopping spec using convex stopping rule. This field is a member of oneof _ automated_stopping_spec .
|
metrics |
MutableSequence[google.cloud.aiplatform_v1.types.StudySpec.MetricSpec]
Required. Metric specs for the Study. |
parameters |
MutableSequence[google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec]
Required. The set of parameters to tune. |
algorithm |
google.cloud.aiplatform_v1.types.StudySpec.Algorithm
The search algorithm specified for the Study. |
observation_noise |
google.cloud.aiplatform_v1.types.StudySpec.ObservationNoise
The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline. |
measurement_selection_type |
google.cloud.aiplatform_v1.types.StudySpec.MeasurementSelectionType
Describe which measurement selection type will be used |
study_stopping_config |
google.cloud.aiplatform_v1.types.StudySpec.StudyStoppingConfig
Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition. This field is a member of oneof _ _study_stopping_config .
|
Classes
Algorithm
Algorithm(value)
The available search algorithms for the Study.
Values:
ALGORITHM_UNSPECIFIED (0):
The default algorithm used by Vertex AI for hyperparameter
tuning <https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview>
and Vertex AI
Vizier <https://cloud.google.com/vertex-ai/docs/vizier>
.
GRID_SEARCH (2):
Simple grid search within the feasible space. To use grid
search, all parameters must be INTEGER
, CATEGORICAL
,
or DISCRETE
.
RANDOM_SEARCH (3):
Simple random search within the feasible
space.
ConvexAutomatedStoppingSpec
ConvexAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DecayCurveAutomatedStoppingSpec
DecayCurveAutomatedStoppingSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)
The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far.
MeasurementSelectionType
MeasurementSelectionType(value)
This indicates which measurement to use if/when the service automatically selects the final measurement from previously reported intermediate measurements. Choose this based on two considerations: A) Do you expect your measurements to monotonically improve? If so, choose LAST_MEASUREMENT. On the other hand, if you're in a situation where your system can "over-train" and you expect the performance to get better for a while but then start declining, choose BEST_MEASUREMENT. B) Are your measurements significantly noisy and/or irreproducible? If so, BEST_MEASUREMENT will tend to be over-optimistic, and it may be better to choose LAST_MEASUREMENT. If both or neither of (A) and (B) apply, it doesn't matter which selection type is chosen.
Values: MEASUREMENT_SELECTION_TYPE_UNSPECIFIED (0): Will be treated as LAST_MEASUREMENT. LAST_MEASUREMENT (1): Use the last measurement reported. BEST_MEASUREMENT (2): Use the best measurement reported.
MedianAutomatedStoppingSpec
MedianAutomatedStoppingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement.
MetricSpec
MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a metric to optimize.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ObservationNoise
ObservationNoise(value)
Describes the noise level of the repeated observations.
"Noisy" means that the repeated observations with the same Trial parameters may lead to different metric evaluations.
Values: OBSERVATION_NOISE_UNSPECIFIED (0): The default noise level chosen by Vertex AI. LOW (1): Vertex AI assumes that the objective function is (nearly) perfectly reproducible, and will never repeat the same Trial parameters. HIGH (2): Vertex AI will estimate the amount of noise in metric evaluations, it may repeat the same Trial parameters more than once.
ParameterSpec
ParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a single parameter to optimize.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StudyStoppingConfig
StudyStoppingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.
Methods
StudySpec
StudySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents specification of a Study.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields