Struct StudySpec

#[non_exhaustive]
pub struct StudySpec {
    pub metrics: Vec<MetricSpec>,
    pub parameters: Vec<ParameterSpec>,
    pub algorithm: Algorithm,
    pub observation_noise: ObservationNoise,
    pub measurement_selection_type: MeasurementSelectionType,
    pub study_stopping_config: Option<StudyStoppingConfig>,
    pub automated_stopping_spec: Option<AutomatedStoppingSpec>,
    /* private fields */
}

Represents specification of a Study.

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.

metrics: Vec<MetricSpec>

Required. Metric specs for the Study.

parameters: Vec<ParameterSpec>

Required. The set of parameters to tune.

algorithm: Algorithm

The search algorithm specified for the Study.

observation_noise: ObservationNoise

The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.

measurement_selection_type: MeasurementSelectionType

Describe which measurement selection type will be used

study_stopping_config: Option<StudyStoppingConfig>

Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.

automated_stopping_spec: Option<AutomatedStoppingSpec>

Implementations

impl StudySpec

pub fn new() -> Self

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

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

Sets the value of metrics.

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

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

Sets the value of parameters.

pub fn set_algorithm<T: Into<Algorithm>>(self, v: T) -> Self

Sets the value of algorithm.

pub fn set_observation_noise<T: Into<ObservationNoise>>(self, v: T) -> Self

Sets the value of observation_noise.

pub fn set_measurement_selection_type<T: Into<MeasurementSelectionType>>( self, v: T, ) -> Self

Sets the value of measurement_selection_type.

pub fn set_study_stopping_config<T: Into<Option<StudyStoppingConfig>>>( self, v: T, ) -> Self

Sets the value of study_stopping_config.

pub fn set_automated_stopping_spec<T: Into<Option<AutomatedStoppingSpec>>>( self, v: T, ) -> Self

Sets the value of automated_stopping_spec.

Note that all the setters affecting automated_stopping_spec are mutually exclusive.

pub fn decay_curve_stopping_spec( &self, ) -> Option<&Box<DecayCurveAutomatedStoppingSpec>>

The value of automated_stopping_spec if it holds a DecayCurveStoppingSpec, None if the field is not set or holds a different branch.

pub fn set_decay_curve_stopping_spec<T: Into<Box<DecayCurveAutomatedStoppingSpec>>>( self, v: T, ) -> Self

Sets the value of automated_stopping_spec to hold a DecayCurveStoppingSpec.

Note that all the setters affecting automated_stopping_spec are mutually exclusive.

pub fn median_automated_stopping_spec( &self, ) -> Option<&Box<MedianAutomatedStoppingSpec>>

The value of automated_stopping_spec if it holds a MedianAutomatedStoppingSpec, None if the field is not set or holds a different branch.

pub fn set_median_automated_stopping_spec<T: Into<Box<MedianAutomatedStoppingSpec>>>( self, v: T, ) -> Self

Sets the value of automated_stopping_spec to hold a MedianAutomatedStoppingSpec.

Note that all the setters affecting automated_stopping_spec are mutually exclusive.

pub fn convex_automated_stopping_spec( &self, ) -> Option<&Box<ConvexAutomatedStoppingSpec>>

The value of automated_stopping_spec if it holds a ConvexAutomatedStoppingSpec, None if the field is not set or holds a different branch.

pub fn set_convex_automated_stopping_spec<T: Into<Box<ConvexAutomatedStoppingSpec>>>( self, v: T, ) -> Self

Sets the value of automated_stopping_spec to hold a ConvexAutomatedStoppingSpec.

Note that all the setters affecting automated_stopping_spec are mutually exclusive.

Trait Implementations

impl Clone for StudySpec

fn clone(&self) -> StudySpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StudySpec

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

Formats the value using the given formatter.

impl Default for StudySpec

fn default() -> StudySpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StudySpec

where StudySpec: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StudySpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StudySpec

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StudySpec