Struct MultiTrialAlgorithmSpec 

#[non_exhaustive]
pub struct MultiTrialAlgorithmSpec {
    pub multi_trial_algorithm: MultiTrialAlgorithm,
    pub metric: Option<MetricSpec>,
    pub search_trial_spec: Option<SearchTrialSpec>,
    pub train_trial_spec: Option<TrainTrialSpec>,
    /* private fields */
}

Available on crate feature job-service only.

The spec of multi-trial Neural Architecture Search (NAS).

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.

multi_trial_algorithm: MultiTrialAlgorithm

The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to REINFORCEMENT_LEARNING.

metric: Option<MetricSpec>

Metric specs for the NAS job. Validation for this field is done at multi_trial_algorithm_spec field.

search_trial_spec: Option<SearchTrialSpec>

Required. Spec for search trials.

train_trial_spec: Option<TrainTrialSpec>

Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.

Implementations

impl MultiTrialAlgorithmSpec

pub fn new() -> Self

pub fn set_multi_trial_algorithm<T: Into<MultiTrialAlgorithm>>( self, v: T, ) -> Self

Sets the value of multi_trial_algorithm.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::MultiTrialAlgorithm;
let x0 = MultiTrialAlgorithmSpec::new().set_multi_trial_algorithm(MultiTrialAlgorithm::ReinforcementLearning);
let x1 = MultiTrialAlgorithmSpec::new().set_multi_trial_algorithm(MultiTrialAlgorithm::GridSearch);

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

where T: Into<MetricSpec>,

Sets the value of metric.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::MetricSpec;
let x = MultiTrialAlgorithmSpec::new().set_metric(MetricSpec::default()/* use setters */);

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

where T: Into<MetricSpec>,

Sets or clears the value of metric.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::MetricSpec;
let x = MultiTrialAlgorithmSpec::new().set_or_clear_metric(Some(MetricSpec::default()/* use setters */));
let x = MultiTrialAlgorithmSpec::new().set_or_clear_metric(None::<MetricSpec>);

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

where T: Into<SearchTrialSpec>,

Sets the value of search_trial_spec.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::SearchTrialSpec;
let x = MultiTrialAlgorithmSpec::new().set_search_trial_spec(SearchTrialSpec::default()/* use setters */);

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

where T: Into<SearchTrialSpec>,

Sets or clears the value of search_trial_spec.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::SearchTrialSpec;
let x = MultiTrialAlgorithmSpec::new().set_or_clear_search_trial_spec(Some(SearchTrialSpec::default()/* use setters */));
let x = MultiTrialAlgorithmSpec::new().set_or_clear_search_trial_spec(None::<SearchTrialSpec>);

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

where T: Into<TrainTrialSpec>,

Sets the value of train_trial_spec.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::TrainTrialSpec;
let x = MultiTrialAlgorithmSpec::new().set_train_trial_spec(TrainTrialSpec::default()/* use setters */);

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

where T: Into<TrainTrialSpec>,

Sets or clears the value of train_trial_spec.

Example

use google_cloud_aiplatform_v1::model::nas_job_spec::multi_trial_algorithm_spec::TrainTrialSpec;
let x = MultiTrialAlgorithmSpec::new().set_or_clear_train_trial_spec(Some(TrainTrialSpec::default()/* use setters */));
let x = MultiTrialAlgorithmSpec::new().set_or_clear_train_trial_spec(None::<TrainTrialSpec>);

Trait Implementations

impl Clone for MultiTrialAlgorithmSpec

fn clone(&self) -> MultiTrialAlgorithmSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiTrialAlgorithmSpec

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

Formats the value using the given formatter.

impl Default for MultiTrialAlgorithmSpec

fn default() -> MultiTrialAlgorithmSpec

Returns the “default value” for a type.

impl Message for MultiTrialAlgorithmSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MultiTrialAlgorithmSpec

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