Google Cloud Ai Platform V1 Client - Class Parameter (0.10.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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Generated from protobuf field string parameter_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setParameterId

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

Generated from protobuf field string parameter_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$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'.

Generated from protobuf field .google.protobuf.Value value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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'.

Generated from protobuf field .google.protobuf.Value value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Value
Returns
TypeDescription
$this