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.