Class BenchmarkEntry.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BenchmarkEntry.Builder>

com.google.protobuf.GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

org.tensorflow.proto.BenchmarkEntry.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable, BenchmarkEntryOrBuilder

Enclosing class:

BenchmarkEntry

public static final class BenchmarkEntry.Builder
extends GeneratedMessageV3.Builder<BenchmarkEntry.Builder>
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

Method Summary

Modifier and Type	Method	Description
BenchmarkEntry.Builder	addAllMetrics(Iterable<? extends MetricEntry> values)	Metric name, value and expected range.
BenchmarkEntry.Builder	addMetrics(int index, MetricEntry value)	Metric name, value and expected range.
BenchmarkEntry.Builder	addMetrics(int index, MetricEntry.Builder builderForValue)	Metric name, value and expected range.
BenchmarkEntry.Builder	addMetrics(MetricEntry value)	Metric name, value and expected range.
BenchmarkEntry.Builder	addMetrics(MetricEntry.Builder builderForValue)	Metric name, value and expected range.
MetricEntry.Builder	addMetricsBuilder()	Metric name, value and expected range.
MetricEntry.Builder	addMetricsBuilder(int index)	Metric name, value and expected range.
BenchmarkEntry.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
BenchmarkEntry	build()
BenchmarkEntry	buildPartial()
BenchmarkEntry.Builder	clear()
BenchmarkEntry.Builder	clearCpuTime()	Total cpu time used for all iterations (in seconds)
BenchmarkEntry.Builder	clearExtras()
BenchmarkEntry.Builder	clearField(Descriptors.FieldDescriptor field)
BenchmarkEntry.Builder	clearIters()	If a benchmark, how many iterations it was run for
BenchmarkEntry.Builder	clearMetrics()	Metric name, value and expected range.
BenchmarkEntry.Builder	clearName()	The name of the specific benchmark or test (e.g.
BenchmarkEntry.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
BenchmarkEntry.Builder	clearThroughput()	Throughput (in MB/s)
BenchmarkEntry.Builder	clearWallTime()	Total wall time used for all iterations (in seconds)
BenchmarkEntry.Builder	clone()
boolean	containsExtras(String key)	Generic map from result key to value.
double	getCpuTime()	Total cpu time used for all iterations (in seconds)
BenchmarkEntry	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
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.
MetricEntry.Builder	getMetricsBuilder(int index)	Metric name, value and expected range.
List<MetricEntry.Builder>	getMetricsBuilderList()	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.
Map<String, EntryValue>	getMutableExtras()	Deprecated.
String	getName()	The name of the specific benchmark or test (e.g.
ByteString	getNameBytes()	The name of the specific benchmark or test (e.g.
double	getThroughput()	Throughput (in MB/s)
double	getWallTime()	Total wall time used for all iterations (in seconds)
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
protected MapField	internalGetMutableMapField(int number)
final boolean	isInitialized()
BenchmarkEntry.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
BenchmarkEntry.Builder	mergeFrom(Message other)
BenchmarkEntry.Builder	mergeFrom(BenchmarkEntry other)
final BenchmarkEntry.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
BenchmarkEntry.Builder	putAllExtras(Map<String, EntryValue> values)	Generic map from result key to value.
BenchmarkEntry.Builder	putExtras(String key, EntryValue value)	Generic map from result key to value.
BenchmarkEntry.Builder	removeExtras(String key)	Generic map from result key to value.
BenchmarkEntry.Builder	removeMetrics(int index)	Metric name, value and expected range.
BenchmarkEntry.Builder	setCpuTime(double value)	Total cpu time used for all iterations (in seconds)
BenchmarkEntry.Builder	setField(Descriptors.FieldDescriptor field, Object value)
BenchmarkEntry.Builder	setIters(long value)	If a benchmark, how many iterations it was run for
BenchmarkEntry.Builder	setMetrics(int index, MetricEntry value)	Metric name, value and expected range.
BenchmarkEntry.Builder	setMetrics(int index, MetricEntry.Builder builderForValue)	Metric name, value and expected range.
BenchmarkEntry.Builder	setName(String value)	The name of the specific benchmark or test (e.g.
BenchmarkEntry.Builder	setNameBytes(ByteString value)	The name of the specific benchmark or test (e.g.
BenchmarkEntry.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
BenchmarkEntry.Builder	setThroughput(double value)	Throughput (in MB/s)
final BenchmarkEntry.Builder	setUnknownFields(UnknownFieldSet unknownFields)
BenchmarkEntry.Builder	setWallTime(double value)	Total wall time used for all iterations (in seconds)

Methods inherited from class GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface MessageLite.Builder

mergeFrom

Methods inherited from interface MessageOrBuilder

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

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

internalGetMutableMapField

protected MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

clear

public BenchmarkEntry.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

getDefaultInstanceForType

public BenchmarkEntry getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public BenchmarkEntry build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public BenchmarkEntry buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public BenchmarkEntry.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

setField

public BenchmarkEntry.Builder setField(Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

clearField

public BenchmarkEntry.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

clearOneof

public BenchmarkEntry.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

setRepeatedField

public BenchmarkEntry.Builder setRepeatedField(Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

addRepeatedField

public BenchmarkEntry.Builder addRepeatedField(Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

mergeFrom

public BenchmarkEntry.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<BenchmarkEntry.Builder>

mergeFrom

public BenchmarkEntry.Builder mergeFrom(BenchmarkEntry other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

mergeFrom

public BenchmarkEntry.Builder mergeFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<BenchmarkEntry.Builder>

Throws:

IOException

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.

setName

public BenchmarkEntry.Builder setName(String value)

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

string name = 1;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public BenchmarkEntry.Builder clearName()

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

string name = 1;

Returns:

This builder for chaining.

setNameBytes

public BenchmarkEntry.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

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.

setIters

public BenchmarkEntry.Builder setIters(long value)

If a benchmark, how many iterations it was run for

int64 iters = 2;

Parameters:

value - The iters to set.

Returns:

This builder for chaining.

clearIters

public BenchmarkEntry.Builder clearIters()

If a benchmark, how many iterations it was run for

int64 iters = 2;

Returns:

This builder for chaining.

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.

setCpuTime

public BenchmarkEntry.Builder setCpuTime(double value)

Total cpu time used for all iterations (in seconds)

double cpu_time = 3;

Parameters:

value - The cpuTime to set.

Returns:

This builder for chaining.

clearCpuTime

public BenchmarkEntry.Builder clearCpuTime()

Total cpu time used for all iterations (in seconds)

double cpu_time = 3;

Returns:

This builder for chaining.

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.

setWallTime

public BenchmarkEntry.Builder setWallTime(double value)

Total wall time used for all iterations (in seconds)

double wall_time = 4;

Parameters:

value - The wallTime to set.

Returns:

This builder for chaining.

clearWallTime

public BenchmarkEntry.Builder clearWallTime()

Total wall time used for all iterations (in seconds)

double wall_time = 4;

Returns:

This builder for chaining.

getThroughput

public double getThroughput()

Throughput (in MB/s)

double throughput = 5;

Specified by:

getThroughput in interface BenchmarkEntryOrBuilder

Returns:

The throughput.

setThroughput

public BenchmarkEntry.Builder setThroughput(double value)

Throughput (in MB/s)

double throughput = 5;

Parameters:

value - The throughput to set.

Returns:

This builder for chaining.

clearThroughput

public BenchmarkEntry.Builder clearThroughput()

Throughput (in MB/s)

double throughput = 5;

Returns:

This builder for chaining.

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

clearExtras

public BenchmarkEntry.Builder clearExtras()

removeExtras

public BenchmarkEntry.Builder removeExtras(String key)

Generic map from result key to value.

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

getMutableExtras

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

Deprecated.

Use alternate mutation accessors instead.

putExtras

public BenchmarkEntry.Builder putExtras(String key,
 EntryValue value)

Generic map from result key to value.

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

putAllExtras

public BenchmarkEntry.Builder putAllExtras(Map<String, EntryValue> values)

Generic map from result key to value.

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

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

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

setMetrics

public BenchmarkEntry.Builder setMetrics(int index,
 MetricEntry value)

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;

setMetrics

public BenchmarkEntry.Builder setMetrics(int index,
 MetricEntry.Builder builderForValue)

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;

addMetrics

public BenchmarkEntry.Builder addMetrics(MetricEntry value)

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;

addMetrics

public BenchmarkEntry.Builder addMetrics(int index,
 MetricEntry value)

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;

addMetrics

public BenchmarkEntry.Builder addMetrics(MetricEntry.Builder builderForValue)

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;

addMetrics

public BenchmarkEntry.Builder addMetrics(int index,
 MetricEntry.Builder builderForValue)

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;

addAllMetrics

public BenchmarkEntry.Builder addAllMetrics(Iterable<? extends MetricEntry> values)

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;

clearMetrics

public BenchmarkEntry.Builder clearMetrics()

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;

removeMetrics

public BenchmarkEntry.Builder removeMetrics(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;

getMetricsBuilder

public MetricEntry.Builder getMetricsBuilder(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;

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

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

addMetricsBuilder

public MetricEntry.Builder addMetricsBuilder()

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;

addMetricsBuilder

public MetricEntry.Builder addMetricsBuilder(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;

getMetricsBuilderList

public List<MetricEntry.Builder> getMetricsBuilderList()

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;

setUnknownFields

public final BenchmarkEntry.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>

mergeUnknownFields

public final BenchmarkEntry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<BenchmarkEntry.Builder>