Class BenchmarkEntry

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.BenchmarkEntry

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, BenchmarkEntryOrBuilder

public final class BenchmarkEntry
extends GeneratedMessageV3
implements BenchmarkEntryOrBuilder

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BenchmarkEntry.Builder	Each unit test or benchmark in a test or benchmark run provides some set of information.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CPU_TIME_FIELD_NUMBER
static final int	EXTRAS_FIELD_NUMBER
static final int	ITERS_FIELD_NUMBER
static final int	METRICS_FIELD_NUMBER
static final int	NAME_FIELD_NUMBER
static final int	THROUGHPUT_FIELD_NUMBER
static final int	WALL_TIME_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
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)
static BenchmarkEntry	getDefaultInstance()
BenchmarkEntry	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
Map<String, EntryValue>	getExtras()	Deprecated.
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
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.
ByteString	getNameBytes()	The name of the specific benchmark or test (e.g.
Parser<BenchmarkEntry>	getParserForType()
int	getSerializedSize()
double	getThroughput()	Throughput (in MB/s)
final UnknownFieldSet	getUnknownFields()
double	getWallTime()	Total wall time used for all iterations (in seconds)
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
final boolean	isInitialized()
static BenchmarkEntry.Builder	newBuilder()
static BenchmarkEntry.Builder	newBuilder(BenchmarkEntry prototype)
BenchmarkEntry.Builder	newBuilderForType()
protected BenchmarkEntry.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static BenchmarkEntry	parseDelimitedFrom(InputStream input)
static BenchmarkEntry	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(byte[] data)
static BenchmarkEntry	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(ByteString data)
static BenchmarkEntry	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(CodedInputStream input)
static BenchmarkEntry	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(InputStream input)
static BenchmarkEntry	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static BenchmarkEntry	parseFrom(ByteBuffer data)
static BenchmarkEntry	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<BenchmarkEntry>	parser()
BenchmarkEntry.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

ITERS_FIELD_NUMBER

public static final int ITERS_FIELD_NUMBER

See Also:

• Constant Field Values

CPU_TIME_FIELD_NUMBER

public static final int CPU_TIME_FIELD_NUMBER

See Also:

• Constant Field Values

WALL_TIME_FIELD_NUMBER

public static final int WALL_TIME_FIELD_NUMBER

See Also:

• Constant Field Values

THROUGHPUT_FIELD_NUMBER

public static final int THROUGHPUT_FIELD_NUMBER

See Also:

• Constant Field Values

EXTRAS_FIELD_NUMBER

public static final int EXTRAS_FIELD_NUMBER

See Also:

• Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public String getName()

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

string name = 1;

Specified by:

getName in interface BenchmarkEntryOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

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

string name = 1;

Specified by:

getNameBytes in interface BenchmarkEntryOrBuilder

Returns:

The bytes for name.

getIters

public long getIters()

If a benchmark, how many iterations it was run for

int64 iters = 2;

Specified by:

getIters in interface BenchmarkEntryOrBuilder

Returns:

The iters.

getCpuTime

public double getCpuTime()

Total cpu time used for all iterations (in seconds)

double cpu_time = 3;

Specified by:

getCpuTime in interface BenchmarkEntryOrBuilder

Returns:

The cpuTime.

getWallTime

public double getWallTime()

Total wall time used for all iterations (in seconds)

double wall_time = 4;

Specified by:

getWallTime in interface BenchmarkEntryOrBuilder

Returns:

The wallTime.

getThroughput

public double getThroughput()

Throughput (in MB/s)

double throughput = 5;

Specified by:

getThroughput in interface BenchmarkEntryOrBuilder

Returns:

The throughput.

getExtrasCount

public int getExtrasCount()

Description copied from interface: BenchmarkEntryOrBuilder

Generic map from result key to value.

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

Specified by:

getExtrasCount in interface BenchmarkEntryOrBuilder

containsExtras

public boolean containsExtras(String key)

Generic map from result key to value.

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

Specified by:

containsExtras in interface BenchmarkEntryOrBuilder

getExtras

@Deprecated
public Map<String, EntryValue> getExtras()

Deprecated.

Use getExtrasMap() instead.

Specified by:

getExtras in interface BenchmarkEntryOrBuilder

getExtrasMap

public Map<String, EntryValue> getExtrasMap()

Generic map from result key to value.

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

Specified by:

getExtrasMap in interface BenchmarkEntryOrBuilder

getExtrasOrDefault

public EntryValue getExtrasOrDefault(String key,
 EntryValue defaultValue)

Generic map from result key to value.

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

Specified by:

getExtrasOrDefault in interface BenchmarkEntryOrBuilder

getExtrasOrThrow

public EntryValue getExtrasOrThrow(String key)

Generic map from result key to value.

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

Specified by:

getExtrasOrThrow in interface BenchmarkEntryOrBuilder

getMetricsList

public List<MetricEntry> getMetricsList()

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

repeated .tensorflow.MetricEntry metrics = 7;

Specified by:

getMetricsList in interface BenchmarkEntryOrBuilder

getMetricsOrBuilderList

public List<? extends MetricEntryOrBuilder> getMetricsOrBuilderList()

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

repeated .tensorflow.MetricEntry metrics = 7;

Specified by:

getMetricsOrBuilderList in interface BenchmarkEntryOrBuilder

getMetricsCount

public int getMetricsCount()

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

repeated .tensorflow.MetricEntry metrics = 7;

Specified by:

getMetricsCount in interface BenchmarkEntryOrBuilder

getMetrics

public MetricEntry getMetrics(int index)

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

repeated .tensorflow.MetricEntry metrics = 7;

Specified by:

getMetrics in interface BenchmarkEntryOrBuilder

getMetricsOrBuilder

public MetricEntryOrBuilder getMetricsOrBuilder(int index)

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

repeated .tensorflow.MetricEntry metrics = 7;

Specified by:

getMetricsOrBuilder in interface BenchmarkEntryOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static BenchmarkEntry parseFrom(ByteBuffer data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(ByteString data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(byte[] data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static BenchmarkEntry parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BenchmarkEntry parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static BenchmarkEntry parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static BenchmarkEntry parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static BenchmarkEntry parseFrom(CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static BenchmarkEntry parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public BenchmarkEntry.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static BenchmarkEntry.Builder newBuilder()

newBuilder

public static BenchmarkEntry.Builder newBuilder(BenchmarkEntry prototype)

toBuilder

public BenchmarkEntry.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected BenchmarkEntry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static BenchmarkEntry getDefaultInstance()

parser

public static Parser<BenchmarkEntry> parser()

getParserForType

public Parser<BenchmarkEntry> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public BenchmarkEntry getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder