Struct TensorboardExperiment

#[non_exhaustive]
pub struct TensorboardExperiment {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub etag: String,
    pub source: String,
    /* private fields */
}

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

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

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

display_name: String

User provided name of this TensorboardExperiment.

description: String

Description of this TensorboardExperiment.

create_time: Option<Timestamp>

Output only. Timestamp when this TensorboardExperiment was created.

update_time: Option<Timestamp>

Output only. Timestamp when this TensorboardExperiment was last updated.

labels: HashMap<String, String>

The labels with user-defined metadata to organize your TensorboardExperiment.

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

• aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema’s title.

etag: String

Used to perform consistent read-modify-write updates. If not set, a blind “overwrite” update happens.

source: String

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

Implementations

impl TensorboardExperiment

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of display_name.

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

Sets the value of description.

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

Sets the value of create_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

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

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

Sets the value of labels.

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

Sets the value of etag.

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

Sets the value of source.

Trait Implementations

impl Clone for TensorboardExperiment

fn clone(&self) -> TensorboardExperiment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TensorboardExperiment

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

Formats the value using the given formatter.

impl Default for TensorboardExperiment

fn default() -> TensorboardExperiment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TensorboardExperiment

where TensorboardExperiment: 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 TensorboardExperiment

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TensorboardExperiment

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

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 TensorboardExperiment