Google Cloud Ai Platform V1 Client - Class SafetyMetricConfig (0.39.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SafetyMetricConfig.

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

Generated from protobuf message google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig

Namespace

Google \ Cloud \ AIPlatform \ V1 \ StudySpec \ MetricSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ safety_threshold float

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

↳ desired_min_safe_trials_fraction float

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.

getSafetyThreshold

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

Returns
Type Description
float

setSafetyThreshold

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

Parameter
Name Description
var float
Returns
Type Description
$this

getDesiredMinSafeTrialsFraction

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.

Returns
Type Description
float

hasDesiredMinSafeTrialsFraction

clearDesiredMinSafeTrialsFraction

setDesiredMinSafeTrialsFraction

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.

Parameter
Name Description
var float
Returns
Type Description
$this