Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::StudySpec (v0.55.0)

Version 0.55.0

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::StudySpec.

Represents specification of a Study.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#algorithm

def algorithm() -> ::Google::Cloud::AIPlatform::V1::StudySpec::Algorithm

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::Algorithm) — The search algorithm specified for the Study.

#algorithm=

def algorithm=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::Algorithm

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::Algorithm) — The search algorithm specified for the Study.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::Algorithm) — The search algorithm specified for the Study.

#convex_automated_stopping_spec

def convex_automated_stopping_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ConvexAutomatedStoppingSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ConvexAutomatedStoppingSpec) — The automated early stopping spec using convex stopping rule.

#convex_automated_stopping_spec=

def convex_automated_stopping_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ConvexAutomatedStoppingSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ConvexAutomatedStoppingSpec) — The automated early stopping spec using convex stopping rule.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ConvexAutomatedStoppingSpec) — The automated early stopping spec using convex stopping rule.

#decay_curve_stopping_spec

def decay_curve_stopping_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec) — The automated early stopping spec using decay curve rule.

#decay_curve_stopping_spec=

def decay_curve_stopping_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec) — The automated early stopping spec using decay curve rule.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec) — The automated early stopping spec using decay curve rule.

#measurement_selection_type

def measurement_selection_type() -> ::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType) — Describe which measurement selection type will be used

#measurement_selection_type=

def measurement_selection_type=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType) — Describe which measurement selection type will be used

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType) — Describe which measurement selection type will be used

#median_automated_stopping_spec

def median_automated_stopping_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::MedianAutomatedStoppingSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MedianAutomatedStoppingSpec) — The automated early stopping spec using median rule.

#median_automated_stopping_spec=

def median_automated_stopping_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::MedianAutomatedStoppingSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::MedianAutomatedStoppingSpec) — The automated early stopping spec using median rule.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MedianAutomatedStoppingSpec) — The automated early stopping spec using median rule.

#metrics

def metrics() -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec>) — Required. Metric specs for the Study.

#metrics=

def metrics=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec>

Parameter

• value (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec>) — Required. Metric specs for the Study.

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec>) — Required. Metric specs for the Study.

#observation_noise

def observation_noise() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ObservationNoise

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ObservationNoise) — The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

#observation_noise=

def observation_noise=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ObservationNoise

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ObservationNoise) — The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ObservationNoise) — The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

#parameters

def parameters() -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec>) — Required. The set of parameters to tune.

#parameters=

def parameters=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec>

Parameter

• value (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec>) — Required. The set of parameters to tune.

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec>) — Required. The set of parameters to tune.

#study_stopping_config

def study_stopping_config() -> ::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig) — Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

#study_stopping_config=

def study_stopping_config=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig) — Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig) — Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.