Struct RunMetadata

pub struct RunMetadata {
    pub step_stats: Option<StepStats>,
    pub cost_graph: Option<CostGraphDef>,
    pub partition_graphs: Vec<GraphDef>,
    pub function_graphs: Vec<FunctionGraphs>,
}

Metadata output (i.e., non-Tensor) for a single Run() call.

Fields

step_stats: Option<StepStats>

Statistics traced for this step. Populated if tracing is turned on via the “RunOptions” proto. EXPERIMENTAL: The format and set of events may change in future versions.

cost_graph: Option<CostGraphDef>

The cost graph for the computation defined by the run call.

partition_graphs: Vec<GraphDef>

Graphs of the partitions executed by executors.

function_graphs: Vec<FunctionGraphs>

This is only populated for graphs that are run as functions in TensorFlow V2. There will be an entry below for each function that is traced. The main use cases of the post_optimization_graph and the partition_graphs is to give the caller insight into the graphs that were actually run by the runtime. Additional information (such as those in step_stats) will match these graphs. We also include the pre_optimization_graph since it is usually easier to read, and is helpful in situations where the caller wants to get a high level idea of what the built graph looks like (since the various graph optimization passes might change the structure of the graph significantly).

Trait Implementations

impl Clone for RunMetadata

fn clone(&self) -> RunMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunMetadata

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

Formats the value using the given formatter.

impl Default for RunMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for RunMetadata

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_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 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 RunMetadata

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