Struct DoubleValueSpec 

#[non_exhaustive]
pub struct DoubleValueSpec {
    pub min_value: f64,
    pub max_value: f64,
    pub default_value: Option<f64>,
    /* private fields */
}

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

Value specification for a parameter in DOUBLE 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.

min_value: f64

Required. Inclusive minimum value of the parameter.

max_value: f64

Required. Inclusive maximum value of the parameter.

default_value: Option<f64>

A default value for a DOUBLE parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point.

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

Implementations

impl DoubleValueSpec

pub fn new() -> Self

pub fn set_min_value<T: Into<f64>>(self, v: T) -> Self

Sets the value of min_value.

Example

let x = DoubleValueSpec::new().set_min_value(42.0);

pub fn set_max_value<T: Into<f64>>(self, v: T) -> Self

Sets the value of max_value.

Example

let x = DoubleValueSpec::new().set_max_value(42.0);

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

where T: Into<f64>,

Sets the value of default_value.

Example

let x = DoubleValueSpec::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 = DoubleValueSpec::new().set_or_clear_default_value(Some(42.0));
let x = DoubleValueSpec::new().set_or_clear_default_value(None::<f32>);

Trait Implementations

impl Clone for DoubleValueSpec

fn clone(&self) -> DoubleValueSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DoubleValueSpec

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

Formats the value using the given formatter.

impl Default for DoubleValueSpec

fn default() -> DoubleValueSpec

Returns the “default value” for a type.

impl Message for DoubleValueSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DoubleValueSpec

fn eq(&self, other: &DoubleValueSpec) -> 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 DoubleValueSpec