Cloud AI Platform v1 API - Class StudySpec (3.3.0)

public sealed class StudySpec : IMessage<StudySpec>, IEquatable<StudySpec>, IDeepCloneable<StudySpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class StudySpec.

Represents specification of a Study.

Inheritance

object > StudySpec

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

StudySpec()

public StudySpec()

StudySpec(StudySpec)

public StudySpec(StudySpec other)
Parameter
Name Description
other StudySpec

Properties

Algorithm

public StudySpec.Types.Algorithm Algorithm { get; set; }

The search algorithm specified for the Study.

Property Value
Type Description
StudySpecTypesAlgorithm

AutomatedStoppingSpecCase

public StudySpec.AutomatedStoppingSpecOneofCase AutomatedStoppingSpecCase { get; }
Property Value
Type Description
StudySpecAutomatedStoppingSpecOneofCase

ConvexAutomatedStoppingSpec

public StudySpec.Types.ConvexAutomatedStoppingSpec ConvexAutomatedStoppingSpec { get; set; }

The automated early stopping spec using convex stopping rule.

Property Value
Type Description
StudySpecTypesConvexAutomatedStoppingSpec

DecayCurveStoppingSpec

public StudySpec.Types.DecayCurveAutomatedStoppingSpec DecayCurveStoppingSpec { get; set; }

The automated early stopping spec using decay curve rule.

Property Value
Type Description
StudySpecTypesDecayCurveAutomatedStoppingSpec

MeasurementSelectionType

public StudySpec.Types.MeasurementSelectionType MeasurementSelectionType { get; set; }

Describe which measurement selection type will be used

Property Value
Type Description
StudySpecTypesMeasurementSelectionType

MedianAutomatedStoppingSpec

public StudySpec.Types.MedianAutomatedStoppingSpec MedianAutomatedStoppingSpec { get; set; }

The automated early stopping spec using median rule.

Property Value
Type Description
StudySpecTypesMedianAutomatedStoppingSpec

Metrics

public RepeatedField<StudySpec.Types.MetricSpec> Metrics { get; }

Required. Metric specs for the Study.

Property Value
Type Description
RepeatedFieldStudySpecTypesMetricSpec

ObservationNoise

public StudySpec.Types.ObservationNoise ObservationNoise { get; set; }

The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Property Value
Type Description
StudySpecTypesObservationNoise

Parameters

public RepeatedField<StudySpec.Types.ParameterSpec> Parameters { get; }

Required. The set of parameters to tune.

Property Value
Type Description
RepeatedFieldStudySpecTypesParameterSpec

StudyStoppingConfig

public StudySpec.Types.StudyStoppingConfig StudyStoppingConfig { get; set; }

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

Property Value
Type Description
StudySpecTypesStudyStoppingConfig