Struct StudySpec 

pub struct StudySpec {
    pub metrics: Vec<MetricSpec>,
    pub parameters: Vec<ParameterSpec>,
    pub algorithm: String,
    pub observation_noise: i32,
    pub metadata: Vec<KeyValue>,
    pub automated_stopping_spec: Option<AutomatedStoppingSpec>,
}

Represents specification of a Study.

Fields

metrics: Vec<MetricSpec>

Metric specs for the Study.

parameters: Vec<ParameterSpec>

The set of parameters to tune.

algorithm: String

The search algorithm specified for the Study. See pyvizier.Algorithm for a list of native Vizier algorithms.

observation_noise: i32

The observation noise level of the study. Currently only supported by the Optimizer service. Not supported by HyperparamterTuningJob or TrainingPipeline.

metadata: Vec<KeyValue>

Arbitrary metadata associated with the Study. This is not processed by the Vizier server, but is readable/writeable by Pythia policies and user code. FYI, the “” namespace may be read and written by the user. NOTE: Each KeyValue item is limited to 10 megabytes. NOTE: Keys should be unique within their namespaces.

automated_stopping_spec: Option<AutomatedStoppingSpec>

Implementations

impl StudySpec

pub fn observation_noise(&self) -> ObservationNoise

Returns the enum value of observation_noise, or the default if the field is set to an invalid enum value.

pub fn set_observation_noise(&mut self, value: ObservationNoise)

Sets observation_noise to the provided enum value.

Trait Implementations

impl Clone for StudySpec

fn clone(&self) -> StudySpec

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

impl Message for StudySpec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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 StructuralPartialEq for StudySpec