Struct CustomTuningModel 

#[non_exhaustive]
pub struct CustomTuningModel {
    pub name: String,
    pub display_name: String,
    pub model_version: i64,
    pub model_state: ModelState,
    pub create_time: Option<Timestamp>,
    pub training_start_time: Option<Timestamp>,
    pub metrics: HashMap<String, f64>,
    pub error_message: String,
    /* private fields */
}

Available on crate feature search-tuning-service only.

Metadata that describes a custom tuned model.

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.

name: String

Required. The fully qualified resource name of the model.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.

Model must be an alpha-numerical string with limit of 40 characters.

display_name: String

The display name of the model.

model_version: i64

The version of the model.

model_state: ModelState

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).

create_time: Option<Timestamp>

👎Deprecated

Deprecated: Timestamp the Model was created at.

training_start_time: Option<Timestamp>

Timestamp the model training was initiated.

metrics: HashMap<String, f64>

The metrics of the trained model.

error_message: String

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

Implementations

impl CustomTuningModel

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = CustomTuningModel::new().set_name(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/customTuningModels/{custom_tuning_model_id}"));

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

Sets the value of display_name.

Example

let x = CustomTuningModel::new().set_display_name("example");

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

Sets the value of model_version.

Example

let x = CustomTuningModel::new().set_model_version(42);

pub fn set_model_state<T: Into<ModelState>>(self, v: T) -> Self

Sets the value of model_state.

Example

use google_cloud_discoveryengine_v1::model::custom_tuning_model::ModelState;
let x0 = CustomTuningModel::new().set_model_state(ModelState::TrainingPaused);
let x1 = CustomTuningModel::new().set_model_state(ModelState::Training);
let x2 = CustomTuningModel::new().set_model_state(ModelState::TrainingComplete);

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

where T: Into<Timestamp>,

👎Deprecated

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = CustomTuningModel::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

👎Deprecated

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = CustomTuningModel::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = CustomTuningModel::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of training_start_time.

Example

use wkt::Timestamp;
let x = CustomTuningModel::new().set_training_start_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of training_start_time.

Example

use wkt::Timestamp;
let x = CustomTuningModel::new().set_or_clear_training_start_time(Some(Timestamp::default()/* use setters */));
let x = CustomTuningModel::new().set_or_clear_training_start_time(None::<Timestamp>);

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<f64>,

Sets the value of metrics.

Example

let x = CustomTuningModel::new().set_metrics([
    ("key0", 123.5),
    ("key1", 456.5),
]);

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

Sets the value of error_message.

Example

let x = CustomTuningModel::new().set_error_message("example");

Trait Implementations

impl Clone for CustomTuningModel

fn clone(&self) -> CustomTuningModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomTuningModel

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

Formats the value using the given formatter.

impl Default for CustomTuningModel

fn default() -> CustomTuningModel

Returns the “default value” for a type.

impl Message for CustomTuningModel

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CustomTuningModel

fn eq(&self, other: &CustomTuningModel) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CustomTuningModel