Google Cloud Ai Platform V1 Client - Class Parameter (0.18.0)

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

A message representing a parameter to be tuned.

Generated from protobuf message google.cloud.aiplatform.v1.Trial.Parameter

Namespace

Google \ Cloud \ AIPlatform \ V1 \ Trial

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parameter_id`	`string` Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
`↳ value`	`Google\Protobuf\Value` Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.

getParameterId

Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.

Returns
Type	Description
`string`

setParameterId

Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValue

Output only. The value of the parameter.

number_value will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. string_value will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasValue

clearValue

setValue

Output only. The value of the parameter.

number_value will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. string_value will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'.

Parameter
Name	Description
`var`	`Google\Protobuf\Value`

Returns
Type	Description
`$this`