Struct DiscreteValueSpec 

#[non_exhaustive]
pub struct DiscreteValueSpec {
    pub values: Vec<f64>,
    pub default_value: Option<f64>,
    /* private fields */
}

Available on crate features job-service or vizier-service only.

Value specification for a parameter in DISCRETE type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

values: Vec<f64>

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.

default_value: Option<f64>

A default value for a DISCRETE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point.

Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

Implementations

impl DiscreteValueSpec

pub fn new() -> Self

pub fn set_values<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<f64>,

Sets the value of values.

Example

let x = DiscreteValueSpec::new().set_values([1.0, 2.0, 3.0]);

pub fn set_default_value<T>(self, v: T) -> Self

where T: Into<f64>,

Sets the value of default_value.

Example

let x = DiscreteValueSpec::new().set_default_value(42.0);

pub fn set_or_clear_default_value<T>(self, v: Option<T>) -> Self

where T: Into<f64>,

Sets or clears the value of default_value.

Example

let x = DiscreteValueSpec::new().set_or_clear_default_value(Some(42.0));
let x = DiscreteValueSpec::new().set_or_clear_default_value(None::<f32>);

Trait Implementations

impl Clone for DiscreteValueSpec

fn clone(&self) -> DiscreteValueSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiscreteValueSpec

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

Formats the value using the given formatter.

impl Default for DiscreteValueSpec

fn default() -> DiscreteValueSpec

Returns the “default value” for a type.

impl Message for DiscreteValueSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DiscreteValueSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DiscreteValueSpec