pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::BenchmarkRecord Struct Reference

One measured quantity. More...

#include <benchmark.hpp>

Collaboration diagram for pulsatrix::BenchmarkRecord:

Public Types

enum class  Kind { Time , Metric }
 

Public Attributes

std::string name
 What was measured, for example "train.mlp" or "conservation.lrp_epsilon.mlp".
 
std::string device
 Where it ran: "cpu", "hip" or "cuda".
 
Kind kind = Kind::Time
 
TimingStats stats
 Set for Kind::Time.
 
double value = 0.0
 Set for Kind::Metric. May be NaN or infinite when the measured thing is broken.
 
std::string unit
 What value or stats measure, for example "ms per step" or "relative error".
 

Detailed Description

One measured quantity.

Member Enumeration Documentation

◆ Kind

Enumerator
Time 

A duration: stats holds the timings and lower is better.

Metric 

A single number where lower is better, such as a relative error: value holds it.

Member Data Documentation

◆ device

std::string pulsatrix::BenchmarkRecord::device

Where it ran: "cpu", "hip" or "cuda".

◆ kind

Kind pulsatrix::BenchmarkRecord::kind = Kind::Time

◆ name

std::string pulsatrix::BenchmarkRecord::name

What was measured, for example "train.mlp" or "conservation.lrp_epsilon.mlp".

◆ stats

TimingStats pulsatrix::BenchmarkRecord::stats

Set for Kind::Time.

◆ unit

std::string pulsatrix::BenchmarkRecord::unit

What value or stats measure, for example "ms per step" or "relative error".

◆ value

double pulsatrix::BenchmarkRecord::value = 0.0

Set for Kind::Metric. May be NaN or infinite when the measured thing is broken.


The documentation for this struct was generated from the following file: