Class ParameterSpec (1.18.0)

Version 1.18.0

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

ParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a single parameter to optimize.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
double_value_spec	google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DoubleValueSpec The value spec for a 'DOUBLE' parameter. This field is a member of `oneof`_ ``parameter_value_spec``.
integer_value_spec	google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.IntegerValueSpec The value spec for an 'INTEGER' parameter. This field is a member of `oneof`_ ``parameter_value_spec``.
categorical_value_spec	google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.CategoricalValueSpec The value spec for a 'CATEGORICAL' parameter. This field is a member of `oneof`_ ``parameter_value_spec``.
discrete_value_spec	google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DiscreteValueSpec The value spec for a 'DISCRETE' parameter. This field is a member of `oneof`_ ``parameter_value_spec``.
parameter_id	str Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.
scale_type	google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.ScaleType How the parameter should be scaled. Leave unset for ``CATEGORICAL`` parameters.
conditional_parameter_specs	Sequence[google.cloud.aiplatform_v1.types.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.

Inheritance

builtins.object > proto.message.Message > ParameterSpec

Classes

CategoricalValueSpec

CategoricalValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Value specification for a parameter in CATEGORICAL type.

ConditionalParameterSpec

ConditionalParameterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a parameter spec with condition from its parent parameter.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DiscreteValueSpec

DiscreteValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Value specification for a parameter in DISCRETE type.

DoubleValueSpec

DoubleValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Value specification for a parameter in DOUBLE type.

IntegerValueSpec

IntegerValueSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Value specification for a parameter in INTEGER type.

ScaleType

ScaleType(value)

The type of scaling that should be applied to this parameter.