Cloud AI Platform v1 API - Class StudySpec.Types.MetricSpec.Types.SafetyMetricConfig (2.21.0) 

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

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

Used in safe optimization to specify threshold levels and risk tolerance.

Inheritance

object > StudySpec.Types.MetricSpec.Types.SafetyMetricConfig

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SafetyMetricConfig()

public SafetyMetricConfig()

SafetyMetricConfig(SafetyMetricConfig)

public SafetyMetricConfig(StudySpec.Types.MetricSpec.Types.SafetyMetricConfig other)
Parameter
NameDescription
otherStudySpecTypesMetricSpecTypesSafetyMetricConfig

Properties

DesiredMinSafeTrialsFraction

public double DesiredMinSafeTrialsFraction { get; set; }

Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.

Property Value
TypeDescription
double

HasDesiredMinSafeTrialsFraction

public bool HasDesiredMinSafeTrialsFraction { get; }

Gets whether the "desired_min_safe_trials_fraction" field is set

Property Value
TypeDescription
bool

SafetyThreshold

public double SafetyThreshold { get; set; }

Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.

Property Value
TypeDescription
double