Google Cloud Ai Platform V1 Client - Class ParameterSpec (1.3.0)

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

Namespace

Google \ Cloud \ AIPlatform \ V1 \ StudySpec

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 CATEGORICAL parameters.

↳ 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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DoubleValueSpec|null

hasDoubleValueSpec

setDoubleValueSpec

The value spec for a 'DOUBLE' parameter.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DoubleValueSpec
Returns
Type Description
$this

getIntegerValueSpec

The value spec for an 'INTEGER' parameter.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\IntegerValueSpec|null

hasIntegerValueSpec

setIntegerValueSpec

The value spec for an 'INTEGER' parameter.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\IntegerValueSpec
Returns
Type Description
$this

getCategoricalValueSpec

The value spec for a 'CATEGORICAL' parameter.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\CategoricalValueSpec|null

hasCategoricalValueSpec

setCategoricalValueSpec

The value spec for a 'CATEGORICAL' parameter.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\CategoricalValueSpec
Returns
Type Description
$this

getDiscreteValueSpec

The value spec for a 'DISCRETE' parameter.

Returns
Type Description
Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\DiscreteValueSpec|null

hasDiscreteValueSpec

setDiscreteValueSpec

The value spec for a 'DISCRETE' parameter.

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.

Returns
Type Description
string

setParameterId

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

Parameter
Name Description
var string
Returns
Type Description
$this

getScaleType

How the parameter should be scaled.

Leave unset for CATEGORICAL parameters.

Returns
Type Description
int

setScaleType

How the parameter should be scaled.

Leave unset for CATEGORICAL parameters.

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.

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.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec\ConditionalParameterSpec>
Returns
Type Description
$this

getParameterValueSpec

Returns
Type Description
string