Vertex AI v1beta1 API - Class StudySpec.Types.MetricSpec (1.0.0-beta62)

Version latest

• 1.0.0-beta61 (latest)
• 1.0.0-beta60

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

Reference documentation and code samples for the Vertex AI v1beta1 API class StudySpec.Types.MetricSpec.

Represents a metric to optimize.

Inheritance

object > StudySpec.Types.MetricSpec

Implements

IMessageStudySpecTypesMetricSpec, IEquatableStudySpecTypesMetricSpec, IDeepCloneableStudySpecTypesMetricSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

MetricSpec()

public MetricSpec()

MetricSpec(MetricSpec)

public MetricSpec(StudySpec.Types.MetricSpec other)

Parameter
Name	Description
other	StudySpecTypesMetricSpec

Properties

Goal

public StudySpec.Types.MetricSpec.Types.GoalType Goal { get; set; }

Required. The optimization goal of the metric.

Property Value
Type	Description
StudySpecTypesMetricSpecTypesGoalType

MetricId

public string MetricId { get; set; }

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

Property Value
Type	Description
string

SafetyConfig

public StudySpec.Types.MetricSpec.Types.SafetyMetricConfig SafetyConfig { get; set; }

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Property Value
Type	Description
StudySpecTypesMetricSpecTypesSafetyMetricConfig