Struct tensorflow_proto::tensorflow::BenchmarkEntry

pub struct BenchmarkEntry {
    pub name: String,
    pub iters: i64,
    pub cpu_time: f64,
    pub wall_time: f64,
    pub throughput: f64,
    pub extras: HashMap<String, EntryValue>,
    pub metrics: Vec<MetricEntry>,
}

Each unit test or benchmark in a test or benchmark run provides some set of information. Here we provide some reasonable keys one would expect to see, with optional key/value pairs for things we haven't considered.

This BenchmarkEntry should be emitted by each unit test or benchmark reporter.

Fields

name: String

The name of the specific benchmark or test (e.g. BM_AdjustContrast_gpu_B_W_H)

iters: i64

If a benchmark, how many iterations it was run for

cpu_time: f64

Total cpu time used for all iterations (in seconds)

wall_time: f64

Total wall time used for all iterations (in seconds)

throughput: f64

Throughput (in MB/s)

extras: HashMap<String, EntryValue>

Generic map from result key to value.

metrics: Vec<MetricEntry>

Metric name, value and expected range. This can include accuracy metrics typically used to determine whether the accuracy test has passed

Trait Implementations

impl Clone for BenchmarkEntry

pub fn clone(&self) -> BenchmarkEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BenchmarkEntry

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

Formats the value using the given formatter.

impl Default for BenchmarkEntry

pub fn default() -> Self

Returns the "default value" for a type.

impl Message for BenchmarkEntry

pub fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<BenchmarkEntry> for BenchmarkEntry

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for BenchmarkEntry