Interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder (3.29.0) 

public static interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDesiredMinSafeTrialsFraction()

public abstract double 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.

optional double desired_min_safe_trials_fraction = 2;

Returns
TypeDescription
double

The desiredMinSafeTrialsFraction.

getSafetyThreshold()

public abstract double getSafetyThreshold()

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

double safety_threshold = 1;

Returns
TypeDescription
double

The safetyThreshold.

hasDesiredMinSafeTrialsFraction()

public abstract boolean hasDesiredMinSafeTrialsFraction()

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.

optional double desired_min_safe_trials_fraction = 2;

Returns
TypeDescription
boolean

Whether the desiredMinSafeTrialsFraction field is set.