Class ParameterSpec (1.1.1)

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

Represents a single parameter to optimize. .. attribute:: double_value_spec

The value spec for a 'DOUBLE' parameter.

:type: google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DoubleValueSpec

Attributes

Name Description
integer_value_spec google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.IntegerValueSpec
The value spec for an 'INTEGER' parameter.
categorical_value_spec google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.CategoricalValueSpec
The value spec for a 'CATEGORICAL' parameter.
discrete_value_spec google.cloud.aiplatform_v1.types.StudySpec.ParameterSpec.DiscreteValueSpec
The value spec for a 'DISCRETE' parameter.
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. .. attribute:: values

Required. The list of possible categories.

:type: Sequence[str]

ConditionalParameterSpec

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

Represents a parameter spec with condition from its parent parameter.

DiscreteValueSpec

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

Value specification for a parameter in DISCRETE type. .. attribute:: values

Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.

:type: Sequence[float]

DoubleValueSpec

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

Value specification for a parameter in DOUBLE type. .. attribute:: min_value

Required. Inclusive minimum value of the parameter.

:type: float

IntegerValueSpec

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

Value specification for a parameter in INTEGER type. .. attribute:: min_value

Required. Inclusive minimum value of the parameter.

:type: int

ScaleType

ScaleType(value)

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