Google Cloud Ai Platform V1 Client - Class StudySpec (1.22.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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ decay_curve_stopping_spec
StudySpec\DecayCurveAutomatedStoppingSpec

The automated early stopping spec using decay curve rule.

↳ median_automated_stopping_spec
StudySpec\MedianAutomatedStoppingSpec

The automated early stopping spec using median rule.

↳ convex_automated_stopping_spec
StudySpec\ConvexAutomatedStoppingSpec

The automated early stopping spec using convex stopping rule.

↳ metrics
array< StudySpec\MetricSpec >

Required. Metric specs for the Study.

↳ parameters
array< 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

↳ study_stopping_config
StudySpec\StudyStoppingConfig

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

getDecayCurveStoppingSpec

The automated early stopping spec using decay curve rule.

Returns
Type
Description

hasDecayCurveStoppingSpec

setDecayCurveStoppingSpec

The automated early stopping spec using decay curve rule.

Parameter
Name
Description
Returns
Type
Description
$this

getMedianAutomatedStoppingSpec

The automated early stopping spec using median rule.

Returns
Type
Description

hasMedianAutomatedStoppingSpec

setMedianAutomatedStoppingSpec

The automated early stopping spec using median rule.

Parameter
Name
Description
Returns
Type
Description
$this

getConvexAutomatedStoppingSpec

The automated early stopping spec using convex stopping rule.

Returns
Type
Description

hasConvexAutomatedStoppingSpec

setConvexAutomatedStoppingSpec

The automated early stopping spec using convex stopping rule.

Parameter
Name
Description
Returns
Type
Description
$this

getMetrics

Required. Metric specs for the Study.

Returns
Type
Description

setMetrics

Required. Metric specs for the Study.

Parameter
Name
Description
var
Returns
Type
Description
$this

getParameters

Required. The set of parameters to tune.

Returns
Type
Description

setParameters

Required. The set of parameters to tune.

Parameter
Name
Description
Returns
Type
Description
$this

getAlgorithm

The search algorithm specified for the Study.

Returns
Type
Description
int

setAlgorithm

The search algorithm specified for the Study.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getObservationNoise

The observation noise level of the study.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Returns
Type
Description
int

setObservationNoise

The observation noise level of the study.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getMeasurementSelectionType

Describe which measurement selection type will be used

Returns
Type
Description
int

setMeasurementSelectionType

Describe which measurement selection type will be used

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getStudyStoppingConfig

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

Returns
Type
Description

hasStudyStoppingConfig

clearStudyStoppingConfig

setStudyStoppingConfig

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

Parameter
Name
Description
Returns
Type
Description
$this

getAutomatedStoppingSpec

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: