Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec (v1.27.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec.

Represents a single parameter to optimize.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#categorical_value_spec

def categorical_value_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::CategoricalValueSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::CategoricalValueSpec) — The value spec for a 'CATEGORICAL' parameter.

  Note: The following fields are mutually exclusive: categorical_value_spec, double_value_spec, integer_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#categorical_value_spec=

def categorical_value_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::CategoricalValueSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::CategoricalValueSpec) — The value spec for a 'CATEGORICAL' parameter.

  Note: The following fields are mutually exclusive: categorical_value_spec, double_value_spec, integer_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::CategoricalValueSpec) — The value spec for a 'CATEGORICAL' parameter.

  Note: The following fields are mutually exclusive: categorical_value_spec, double_value_spec, integer_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#conditional_parameter_specs

def conditional_parameter_specs() -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ConditionalParameterSpec>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::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.

#conditional_parameter_specs=

def conditional_parameter_specs=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ConditionalParameterSpec>

Parameter

• value (::Array<::Google::Cloud::AIPlatform::V1::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.

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::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.

#discrete_value_spec

def discrete_value_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DiscreteValueSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DiscreteValueSpec) — The value spec for a 'DISCRETE' parameter.

  Note: The following fields are mutually exclusive: discrete_value_spec, double_value_spec, integer_value_spec, categorical_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#discrete_value_spec=

def discrete_value_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DiscreteValueSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DiscreteValueSpec) — The value spec for a 'DISCRETE' parameter.

  Note: The following fields are mutually exclusive: discrete_value_spec, double_value_spec, integer_value_spec, categorical_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DiscreteValueSpec) — The value spec for a 'DISCRETE' parameter.

  Note: The following fields are mutually exclusive: discrete_value_spec, double_value_spec, integer_value_spec, categorical_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_value_spec

def double_value_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DoubleValueSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DoubleValueSpec) — The value spec for a 'DOUBLE' parameter.

  Note: The following fields are mutually exclusive: double_value_spec, integer_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_value_spec=

def double_value_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DoubleValueSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DoubleValueSpec) — The value spec for a 'DOUBLE' parameter.

  Note: The following fields are mutually exclusive: double_value_spec, integer_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::DoubleValueSpec) — The value spec for a 'DOUBLE' parameter.

  Note: The following fields are mutually exclusive: double_value_spec, integer_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value_spec

def integer_value_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::IntegerValueSpec

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::IntegerValueSpec) — The value spec for an 'INTEGER' parameter.

  Note: The following fields are mutually exclusive: integer_value_spec, double_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value_spec=

def integer_value_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::IntegerValueSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::IntegerValueSpec) — The value spec for an 'INTEGER' parameter.

  Note: The following fields are mutually exclusive: integer_value_spec, double_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::IntegerValueSpec) — The value spec for an 'INTEGER' parameter.

  Note: The following fields are mutually exclusive: integer_value_spec, double_value_spec, categorical_value_spec, discrete_value_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#parameter_id

def parameter_id() -> ::String

Returns

• (::String) — Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

#parameter_id=

def parameter_id=(value) -> ::String

Parameter

• value (::String) — Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

Returns

• (::String) — Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

#scale_type

def scale_type() -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ScaleType

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ScaleType) — How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

#scale_type=

def scale_type=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ScaleType

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ScaleType) — How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::ParameterSpec::ScaleType) — How the parameter should be scaled. Leave unset for CATEGORICAL parameters.