Google Cloud Ai Platform V1 Client - Class CategoricalValueSpec (0.27.0)

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

Value specification for a parameter in CATEGORICAL type.

Generated from protobuf message google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec

Namespace

Google \ Cloud \ AIPlatform \ V1 \ StudySpec \ ParameterSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ values array

Required. The list of possible categories.

↳ default_value string

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

getValues

Required. The list of possible categories.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setValues

Required. The list of possible categories.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDefaultValue

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Returns
TypeDescription
string

hasDefaultValue

clearDefaultValue

setDefaultValue

A default value for a CATEGORICAL parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Parameter
NameDescription
var string
Returns
TypeDescription
$this