Google Cloud Ai Platform V1 Client - Class StudySpec (0.10.0)

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

Represents specification of a Study.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ decay_curve_stopping_spec`	`Google\Cloud\AIPlatform\V1\StudySpec\DecayCurveAutomatedStoppingSpec` The automated early stopping spec using decay curve rule.
`↳ median_automated_stopping_spec`	`Google\Cloud\AIPlatform\V1\StudySpec\MedianAutomatedStoppingSpec` The automated early stopping spec using median rule.
`↳ convex_automated_stopping_spec`	`Google\Cloud\AIPlatform\V1\StudySpec\ConvexAutomatedStoppingSpec` The automated early stopping spec using convex stopping rule.
`↳ metrics`	`array<Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec>` Required. Metric specs for the Study.
`↳ parameters`	`array<Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec>` Required. The set of parameters to tune.
`↳ algorithm`	`int` The search algorithm specified for the Study.
`↳ observation_noise`	`int` 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`	`int` Describe which measurement selection type will be used

getDecayCurveStoppingSpec

The automated early stopping spec using decay curve rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\StudySpec\DecayCurveAutomatedStoppingSpec\|null`

hasDecayCurveStoppingSpec

setDecayCurveStoppingSpec

The automated early stopping spec using decay curve rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.DecayCurveAutomatedStoppingSpec decay_curve_stopping_spec = 4;

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\StudySpec\DecayCurveAutomatedStoppingSpec`

Returns
Type	Description
`$this`

getMedianAutomatedStoppingSpec

The automated early stopping spec using median rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\StudySpec\MedianAutomatedStoppingSpec\|null`

hasMedianAutomatedStoppingSpec

setMedianAutomatedStoppingSpec

The automated early stopping spec using median rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.MedianAutomatedStoppingSpec median_automated_stopping_spec = 5;

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\StudySpec\MedianAutomatedStoppingSpec`

Returns
Type	Description
`$this`

getConvexAutomatedStoppingSpec

The automated early stopping spec using convex stopping rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\StudySpec\ConvexAutomatedStoppingSpec\|null`

hasConvexAutomatedStoppingSpec

setConvexAutomatedStoppingSpec

The automated early stopping spec using convex stopping rule.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec convex_automated_stopping_spec = 9;

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\StudySpec\ConvexAutomatedStoppingSpec`

Returns
Type	Description
`$this`

getMetrics

Required. Metric specs for the Study.

Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMetrics

Required. Metric specs for the Study.

Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.MetricSpec metrics = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`array<Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec>`

Returns
Type	Description
`$this`

getParameters

Required. The set of parameters to tune.

Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setParameters

Required. The set of parameters to tune.

Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec parameters = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`array<Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec>`

Returns
Type	Description
`$this`

getAlgorithm

The search algorithm specified for the Study.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.Algorithm algorithm = 3;

Returns
Type	Description
`int`

setAlgorithm