Cloud AI Platform v1 API - Class StudySpec (2.5.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

Implements

IMessage<StudySpec>, IEquatable<StudySpec>, IDeepCloneable<StudySpec>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
`StudySpec.Types.Algorithm`

AutomatedStoppingSpecCase

public StudySpec.AutomatedStoppingSpecOneofCase AutomatedStoppingSpecCase { get; }

Property Value
Type	Description
`StudySpec.AutomatedStoppingSpecOneofCase`

ConvexAutomatedStoppingSpec

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

The automated early stopping spec using convex stopping rule.

Property Value
Type	Description
`StudySpec.Types.ConvexAutomatedStoppingSpec`

DecayCurveStoppingSpec

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

The automated early stopping spec using decay curve rule.

Property Value
Type	Description
`StudySpec.Types.DecayCurveAutomatedStoppingSpec`

MeasurementSelectionType

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

Describe which measurement selection type will be used

Property Value
Type	Description
`StudySpec.Types.MeasurementSelectionType`

MedianAutomatedStoppingSpec

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

The automated early stopping spec using median rule.

Property Value
Type	Description
`StudySpec.Types.MedianAutomatedStoppingSpec`

Metrics

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

Required. Metric specs for the Study.

Property Value
Type	Description
`RepeatedField<StudySpec.Types.MetricSpec>`

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
`StudySpec.Types.ObservationNoise`

Parameters

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

Required. The set of parameters to tune.

Property Value
Type	Description
`RepeatedField<StudySpec.Types.ParameterSpec>`