Struct TrialContext 

#[non_exhaustive]
pub struct TrialContext {
    pub description: String,
    pub parameters: Vec<Parameter>,
    /* private fields */
}

Available on crate feature vizier-service only.

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.

description: String

A human-readable field which can store a description of this context. This will become part of the resulting Trial’s description field.

parameters: Vec<Parameter>

If/when a Trial is generated or selected from this Context, its Parameters will match any parameters specified here. (I.e. if this context specifies parameter name:‘a’ int_value:3, then a resulting Trial will have int_value:3 for its parameter named ‘a’.) Note that we first attempt to match existing REQUESTED Trials with contexts, and if there are no matches, we generate suggestions in the subspace defined by the parameters specified here. NOTE: a Context without any Parameters matches the entire feasible search space.

Implementations

impl TrialContext

pub fn new() -> Self

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = TrialContext::new().set_description("example");

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

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

Sets the value of parameters.

Example

use google_cloud_aiplatform_v1::model::trial::Parameter;
let x = TrialContext::new()
    .set_parameters([
        Parameter::default()/* use setters */,
        Parameter::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for TrialContext

fn clone(&self) -> TrialContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrialContext

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

Formats the value using the given formatter.

impl Default for TrialContext

fn default() -> TrialContext

Returns the “default value” for a type.

impl Message for TrialContext

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TrialContext

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