TensorFlow is back at Google I/O on May 14! Register now

BenchmarkEntry

public final class BenchmarkEntry

 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.

Protobuf type tensorflow.BenchmarkEntry

Nested Classes

class

BenchmarkEntry.Builder

 Each unit test or benchmark in a test or benchmark run provides
 some set of information.

Constants

int	CPU_TIME_FIELD_NUMBER
int	EXTRAS_FIELD_NUMBER
int	ITERS_FIELD_NUMBER
int	METRICS_FIELD_NUMBER
int	NAME_FIELD_NUMBER
int	THROUGHPUT_FIELD_NUMBER
int	WALL_TIME_FIELD_NUMBER

Public Methods

boolean	containsExtras(String key) Generic map from result key to value.
boolean	equals(Object obj)
double	getCpuTime() Total cpu time used for all iterations (in seconds) `double cpu_time = 3;`
static BenchmarkEntry	getDefaultInstance()
BenchmarkEntry	getDefaultInstanceForType()
final static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String, EntryValue>	getExtras() Use `getExtrasMap()` instead.
int	getExtrasCount() Generic map from result key to value.
Map<String, EntryValue>	getExtrasMap() Generic map from result key to value.
EntryValue	getExtrasOrDefault(String key, EntryValue defaultValue) Generic map from result key to value.
EntryValue	getExtrasOrThrow(String key) Generic map from result key to value.
long	getIters() If a benchmark, how many iterations it was run for `int64 iters = 2;`
MetricEntry	getMetrics(int index) Metric name, value and expected range.
int	getMetricsCount() Metric name, value and expected range.
List<MetricEntry>	getMetricsList() Metric name, value and expected range.
MetricEntryOrBuilder	getMetricsOrBuilder(int index) Metric name, value and expected range.
List<? extends MetricEntryOrBuilder>	getMetricsOrBuilderList() Metric name, value and expected range.
String	getName() The name of the specific benchmark or test (e.g.
com.google.protobuf.ByteString	getNameBytes() The name of the specific benchmark or test (e.g.
	getParserForType()
int	getSerializedSize()
double	getThroughput() Throughput (in MB/s) `double throughput = 5;`
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
double	getWallTime() Total wall time used for all iterations (in seconds) `double wall_time = 4;`
int	hashCode()
final boolean	isInitialized()
static BenchmarkEntry.Builder	newBuilder()
static BenchmarkEntry.Builder	newBuilder(BenchmarkEntry prototype)
BenchmarkEntry.Builder	newBuilderForType()
static BenchmarkEntry	parseDelimitedFrom(InputStream input)
static BenchmarkEntry	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(ByteBuffer data)
static BenchmarkEntry	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(com.google.protobuf.CodedInputStream input)
static BenchmarkEntry	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(com.google.protobuf.ByteString data)
static BenchmarkEntry	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static	parser()
BenchmarkEntry.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Inherited Methods

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface org.tensorflow.proto.util.testlog.BenchmarkEntryOrBuilder

abstract boolean	containsExtras(String key) Generic map from result key to value.
abstract double	getCpuTime() Total cpu time used for all iterations (in seconds) `double cpu_time = 3;`
abstract Map<String, EntryValue>	getExtras() Use `getExtrasMap()` instead.
abstract int	getExtrasCount() Generic map from result key to value.
abstract Map<String, EntryValue>	getExtrasMap() Generic map from result key to value.
abstract EntryValue	getExtrasOrDefault(String key, EntryValue defaultValue) Generic map from result key to value.
abstract EntryValue	getExtrasOrThrow(String key) Generic map from result key to value.
abstract long	getIters() If a benchmark, how many iterations it was run for `int64 iters = 2;`
abstract MetricEntry	getMetrics(int index) Metric name, value and expected range.
abstract int	getMetricsCount() Metric name, value and expected range.
abstract List<MetricEntry>	getMetricsList() Metric name, value and expected range.
abstract MetricEntryOrBuilder	getMetricsOrBuilder(int index) Metric name, value and expected range.
abstract List<? extends MetricEntryOrBuilder>	getMetricsOrBuilderList() Metric name, value and expected range.
abstract String	getName() The name of the specific benchmark or test (e.g.
abstract com.google.protobuf.ByteString	getNameBytes() The name of the specific benchmark or test (e.g.
abstract double	getThroughput() Throughput (in MB/s) `double throughput = 5;`
abstract double	getWallTime() Total wall time used for all iterations (in seconds) `double wall_time = 4;`

Constants

public static final int CPU_TIME_FIELD_NUMBER

Constant Value: 3

public static final int EXTRAS_FIELD_NUMBER

Constant Value: 6

public static final int ITERS_FIELD_NUMBER

Constant Value: 2

public static final int METRICS_FIELD_NUMBER

Constant Value: 7

public static final int NAME_FIELD_NUMBER

Constant Value: 1

public static final int THROUGHPUT_FIELD_NUMBER

Constant Value: 5

public static final int WALL_TIME_FIELD_NUMBER

Constant Value: 4

Public Methods

public boolean containsExtras (String key)

 Generic map from result key to value.

map<string, .tensorflow.EntryValue> extras = 6;

public boolean equals (Object obj)

public double getCpuTime ()

 Total cpu time used for all iterations (in seconds)

double cpu_time = 3;

public static BenchmarkEntry getDefaultInstance ()

public BenchmarkEntry getDefaultInstanceForType ()

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()

public Map<String, EntryValue> getExtras ()

Use getExtrasMap() instead.

public int getExtrasCount ()

 Generic map from result key to value.

map<string, .tensorflow.EntryValue> extras = 6;

public Map<String, EntryValue> getExtrasMap ()

 Generic map from result key to value.

map<string, .tensorflow.EntryValue> extras = 6;

public EntryValue getExtrasOrDefault (String key, EntryValue defaultValue)

 Generic map from result key to value.

map<string, .tensorflow.EntryValue> extras = 6;

public EntryValue getExtrasOrThrow (String key)

 Generic map from result key to value.

map<string, .tensorflow.EntryValue> extras = 6;

public long getIters ()

 If a benchmark, how many iterations it was run for

int64 iters = 2;