Struct SummaryMetadata 

pub struct SummaryMetadata {
    pub plugin_data: Option<PluginData>,
    pub display_name: String,
    pub summary_description: String,
    pub data_class: i32,
}

A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.

Fields

plugin_data: Option<PluginData>

Data that associates a summary with a certain plugin.

display_name: String

Display name for viewing in TensorBoard.

summary_description: String

Longform readable description of the summary sequence. Markdown supported.

data_class: i32

Class of data stored in this time series. Required for compatibility with TensorBoard’s generic data facilities (DataProvider, et al.). This value imposes constraints on the dtype and shape of the corresponding tensor values. See DataClass docs for details.

Implementations

impl SummaryMetadata

pub fn data_class(&self) -> DataClass

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

pub fn set_data_class(&mut self, value: DataClass)

Sets data_class to the provided enum value.

Trait Implementations

impl Clone for SummaryMetadata

fn clone(&self) -> SummaryMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryMetadata

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

Formats the value using the given formatter.

impl Default for SummaryMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SummaryMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SummaryMetadata

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for SummaryMetadata

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

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 SummaryMetadata