Struct googapis::google::cloud::ml::v1::ParameterSpec

pub struct ParameterSpec {
    pub parameter_name: String,
    pub type: i32,
    pub min_value: f64,
    pub max_value: f64,
    pub categorical_values: Vec<String>,
    pub discrete_values: Vec<f64>,
    pub scale_type: i32,
}

Represents a single hyperparameter to optimize.

Fields

parameter_name: String

Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., “learning_rate”.

type: i32

Required. The type of the parameter.

min_value: f64

Required if type is DOUBLE or INTEGER. This field should be unset if type is CATEGORICAL. This value should be integers if type is INTEGER.

max_value: f64

Required if typeis DOUBLE or INTEGER. This field should be unset if type is CATEGORICAL. This value should be integers if type is INTEGER.

categorical_values: Vec<String>

Required if type is CATEGORICAL. The list of possible categories.

discrete_values: Vec<f64>

Required if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. 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.

scale_type: i32

Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., UNIT_LINEAR_SCALE).

Implementations

impl ParameterSpec

pub fn type(&self) -> ParameterType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: ParameterType)

Sets type to the provided enum value.

pub fn scale_type(&self) -> ScaleType

Returns the enum value of scale_type, or the default if the field is set to an invalid enum value.

pub fn set_scale_type(&mut self, value: ScaleType)

Sets scale_type to the provided enum value.

Trait Implementations

impl Clone for ParameterSpec

fn clone(&self) -> ParameterSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParameterSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for ParameterSpec

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ParameterSpec> for ParameterSpec

fn eq(&self, other: &ParameterSpec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ParameterSpec) -> bool

This method tests for !=.

impl StructuralPartialEq for ParameterSpec