Class ParameterSpec (0.4.0)

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

Represents a single parameter to optimize.

Attributes

Name	Description
double_value_spec	`.study.StudySpec.ParameterSpec.DoubleValueSpec` The value spec for a 'DOUBLE' parameter.
integer_value_spec	`.study.StudySpec.ParameterSpec.IntegerValueSpec` The value spec for an 'INTEGER' parameter.
categorical_value_spec	`.study.StudySpec.ParameterSpec.CategoricalValueSpec` The value spec for a 'CATEGORICAL' parameter.
discrete_value_spec	`.study.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	`.study.StudySpec.ParameterSpec.ScaleType` How the parameter should be scaled. Leave unset for ``CATEGORICAL`` parameters.
conditional_parameter_specs	Sequence[`.study.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.

builtins.object > proto.message.Message > ParameterSpec

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

Value specification for a parameter in CATEGORICAL type.

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

Represents a parameter spec with condition from its parent parameter.

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

Value specification for a parameter in DISCRETE type.

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

Value specification for a parameter in DOUBLE type.

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

Value specification for a parameter in INTEGER type.

ScaleType(value)

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