Interface StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder (2.4.0)

public static interface StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultValue()

public abstract double getDefaultValue()

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vizier service. Not supported by HyperparamterTuningJob or TrainingPipeline.

optional double default_value = 3;

Returns
TypeDescription
double

The defaultValue.

getValues(int index)

public abstract double getValues(int index)

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
double

The values at the given index.

getValuesCount()

public abstract int getValuesCount()

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of values.

getValuesList()

public abstract List<Double> getValuesList()

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

repeated double values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Double>

A list containing the values.

hasDefaultValue()

public abstract boolean hasDefaultValue()

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vizier service. Not supported by HyperparamterTuningJob or TrainingPipeline.

optional double default_value = 3;

Returns
TypeDescription
boolean

Whether the defaultValue field is set.