Struct Measurement 

#[non_exhaustive]
pub struct Measurement {
    pub elapsed_duration: Option<Duration>,
    pub step_count: i64,
    pub metrics: Vec<Metric>,
    /* private fields */
}

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

A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.

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.

elapsed_duration: Option<Duration>

Output only. Time that the Trial has been running at the point of this Measurement.

step_count: i64

Output only. The number of steps the machine learning model has been trained for. Must be non-negative.

metrics: Vec<Metric>

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

Implementations

impl Measurement

pub fn new() -> Self

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

where T: Into<Duration>,

Sets the value of elapsed_duration.

Example

use wkt::Duration;
let x = Measurement::new().set_elapsed_duration(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of elapsed_duration.

Example

use wkt::Duration;
let x = Measurement::new().set_or_clear_elapsed_duration(Some(Duration::default()/* use setters */));
let x = Measurement::new().set_or_clear_elapsed_duration(None::<Duration>);

pub fn set_step_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of step_count.

Example

let x = Measurement::new().set_step_count(42);

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

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

Sets the value of metrics.

Example

use google_cloud_aiplatform_v1::model::measurement::Metric;
let x = Measurement::new()
    .set_metrics([
        Metric::default()/* use setters */,
        Metric::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Measurement

fn clone(&self) -> Measurement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Measurement

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

Formats the value using the given formatter.

impl Default for Measurement

fn default() -> Measurement

Returns the “default value” for a type.

impl Message for Measurement

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Measurement

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