Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ParameterSpec.
Represents a single parameter to optimize.
Generated from protobuf message google.cloud.aiplatform.v1.StudySpec.ParameterSpec
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ double_value_spec |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DoubleValueSpec
The value spec for a 'DOUBLE' parameter. |
↳ integer_value_spec |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\IntegerValueSpec
The value spec for an 'INTEGER' parameter. |
↳ categorical_value_spec |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\CategoricalValueSpec
The value spec for a 'CATEGORICAL' parameter. |
↳ discrete_value_spec |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DiscreteValueSpec
The value spec for a 'DISCRETE' parameter. |
↳ parameter_id |
string
Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs. |
↳ scale_type |
int
How the parameter should be scaled. Leave unset for |
↳ conditional_parameter_specs |
array<Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\ConditionalParameterSpec>
A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition. |
getDoubleValueSpec
The value spec for a 'DOUBLE' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DoubleValueSpec|null | |
hasDoubleValueSpec
setDoubleValueSpec
The value spec for a 'DOUBLE' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DoubleValueSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntegerValueSpec
The value spec for an 'INTEGER' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\IntegerValueSpec|null | |
hasIntegerValueSpec
setIntegerValueSpec
The value spec for an 'INTEGER' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\IntegerValueSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategoricalValueSpec
The value spec for a 'CATEGORICAL' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\CategoricalValueSpec|null | |
hasCategoricalValueSpec
setCategoricalValueSpec
The value spec for a 'CATEGORICAL' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\CategoricalValueSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiscreteValueSpec
The value spec for a 'DISCRETE' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DiscreteValueSpec|null | |
hasDiscreteValueSpec
setDiscreteValueSpec
The value spec for a 'DISCRETE' parameter.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DiscreteValueSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameterId
Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
Generated from protobuf field string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setParameterId
Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
Generated from protobuf field string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScaleType
How the parameter should be scaled.
Leave unset for CATEGORICAL parameters.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType scale_type = 6;
| Returns | |
|---|---|
| Type | Description |
int | |
setScaleType
How the parameter should be scaled.
Leave unset for CATEGORICAL parameters.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType scale_type = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConditionalParameterSpecs
A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition.
If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setConditionalParameterSpecs
A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition.
If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\ConditionalParameterSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameterValueSpec
| Returns | |
|---|---|
| Type | Description |
string | |