Class RunMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.RunMetadata

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, RunMetadataOrBuilder

public final class RunMetadata
extends GeneratedMessageV3
implements RunMetadataOrBuilder

Metadata output (i.e., non-Tensor) for a single Run() call.

Protobuf type tensorflow.RunMetadata

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RunMetadata.Builder	Metadata output (i.e., non-Tensor) for a single Run() call.
static final class	RunMetadata.FunctionGraphs	Protobuf type tensorflow.RunMetadata.FunctionGraphs
static interface	RunMetadata.FunctionGraphsOrBuilder

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	COST_GRAPH_FIELD_NUMBER
static final int	FUNCTION_GRAPHS_FIELD_NUMBER
static final int	PARTITION_GRAPHS_FIELD_NUMBER
static final int	SESSION_METADATA_FIELD_NUMBER
static final int	STEP_STATS_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	equals(Object obj)
CostGraphDef	getCostGraph()	The cost graph for the computation defined by the run call.
CostGraphDefOrBuilder	getCostGraphOrBuilder()	The cost graph for the computation defined by the run call.
static RunMetadata	getDefaultInstance()
RunMetadata	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
RunMetadata.FunctionGraphs	getFunctionGraphs(int index)	This is only populated for graphs that are run as functions in TensorFlow V2.
int	getFunctionGraphsCount()	This is only populated for graphs that are run as functions in TensorFlow V2.
List<RunMetadata.FunctionGraphs>	getFunctionGraphsList()	This is only populated for graphs that are run as functions in TensorFlow V2.
RunMetadata.FunctionGraphsOrBuilder	getFunctionGraphsOrBuilder(int index)	This is only populated for graphs that are run as functions in TensorFlow V2.
List<? extends RunMetadata.FunctionGraphsOrBuilder>	getFunctionGraphsOrBuilderList()	This is only populated for graphs that are run as functions in TensorFlow V2.
Parser<RunMetadata>	getParserForType()
GraphDef	getPartitionGraphs(int index)	Graphs of the partitions executed by executors.
int	getPartitionGraphsCount()	Graphs of the partitions executed by executors.
List<GraphDef>	getPartitionGraphsList()	Graphs of the partitions executed by executors.
GraphDefOrBuilder	getPartitionGraphsOrBuilder(int index)	Graphs of the partitions executed by executors.
List<? extends GraphDefOrBuilder>	getPartitionGraphsOrBuilderList()	Graphs of the partitions executed by executors.
int	getSerializedSize()
SessionMetadata	getSessionMetadata()	Metadata about the session.
SessionMetadataOrBuilder	getSessionMetadataOrBuilder()	Metadata about the session.
StepStats	getStepStats()	Statistics traced for this step.
StepStatsOrBuilder	getStepStatsOrBuilder()	Statistics traced for this step.
final UnknownFieldSet	getUnknownFields()
boolean	hasCostGraph()	The cost graph for the computation defined by the run call.
int	hashCode()
boolean	hasSessionMetadata()	Metadata about the session.
boolean	hasStepStats()	Statistics traced for this step.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RunMetadata.Builder	newBuilder()
static RunMetadata.Builder	newBuilder(RunMetadata prototype)
RunMetadata.Builder	newBuilderForType()
protected RunMetadata.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static RunMetadata	parseDelimitedFrom(InputStream input)
static RunMetadata	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RunMetadata	parseFrom(byte[] data)
static RunMetadata	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RunMetadata	parseFrom(ByteString data)
static RunMetadata	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RunMetadata	parseFrom(CodedInputStream input)
static RunMetadata	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RunMetadata	parseFrom(InputStream input)
static RunMetadata	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RunMetadata	parseFrom(ByteBuffer data)
static RunMetadata	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<RunMetadata>	parser()
RunMetadata.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, internalGetMapField, 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

STEP_STATS_FIELD_NUMBER

public static final int STEP_STATS_FIELD_NUMBER

See Also:

• Constant Field Values

COST_GRAPH_FIELD_NUMBER

public static final int COST_GRAPH_FIELD_NUMBER

See Also:

• Constant Field Values

PARTITION_GRAPHS_FIELD_NUMBER

public static final int PARTITION_GRAPHS_FIELD_NUMBER

See Also:

• Constant Field Values

FUNCTION_GRAPHS_FIELD_NUMBER

public static final int FUNCTION_GRAPHS_FIELD_NUMBER

See Also:

• Constant Field Values

SESSION_METADATA_FIELD_NUMBER

public static final int SESSION_METADATA_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()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

hasStepStats

public boolean hasStepStats()

Statistics traced for this step. Populated if tracing is turned on via the
"RunOptions" proto.
EXPERIMENTAL: The format and set of events may change in future versions.

.tensorflow.StepStats step_stats = 1;

Specified by:

hasStepStats in interface RunMetadataOrBuilder

Returns:

Whether the stepStats field is set.

getStepStats

public StepStats getStepStats()

Statistics traced for this step. Populated if tracing is turned on via the
"RunOptions" proto.
EXPERIMENTAL: The format and set of events may change in future versions.

.tensorflow.StepStats step_stats = 1;

Specified by:

getStepStats in interface RunMetadataOrBuilder

Returns:

The stepStats.

getStepStatsOrBuilder

public StepStatsOrBuilder getStepStatsOrBuilder()

Statistics traced for this step. Populated if tracing is turned on via the
"RunOptions" proto.
EXPERIMENTAL: The format and set of events may change in future versions.

.tensorflow.StepStats step_stats = 1;

Specified by:

getStepStatsOrBuilder in interface RunMetadataOrBuilder

hasCostGraph

public boolean hasCostGraph()

The cost graph for the computation defined by the run call.

.tensorflow.CostGraphDef cost_graph = 2;

Specified by:

hasCostGraph in interface RunMetadataOrBuilder

Returns:

Whether the costGraph field is set.

getCostGraph

public CostGraphDef getCostGraph()

The cost graph for the computation defined by the run call.

.tensorflow.CostGraphDef cost_graph = 2;

Specified by:

getCostGraph in interface RunMetadataOrBuilder

Returns:

The costGraph.

getCostGraphOrBuilder

public CostGraphDefOrBuilder getCostGraphOrBuilder()

The cost graph for the computation defined by the run call.

.tensorflow.CostGraphDef cost_graph = 2;

Specified by:

getCostGraphOrBuilder in interface RunMetadataOrBuilder

getPartitionGraphsList

public List<GraphDef> getPartitionGraphsList()

Graphs of the partitions executed by executors.

repeated .tensorflow.GraphDef partition_graphs = 3;

Specified by:

getPartitionGraphsList in interface RunMetadataOrBuilder

getPartitionGraphsOrBuilderList

public List<? extends GraphDefOrBuilder> getPartitionGraphsOrBuilderList()

Graphs of the partitions executed by executors.

repeated .tensorflow.GraphDef partition_graphs = 3;

Specified by:

getPartitionGraphsOrBuilderList in interface RunMetadataOrBuilder

getPartitionGraphsCount

public int getPartitionGraphsCount()

Graphs of the partitions executed by executors.

repeated .tensorflow.GraphDef partition_graphs = 3;

Specified by:

getPartitionGraphsCount in interface RunMetadataOrBuilder

getPartitionGraphs

public GraphDef getPartitionGraphs(int index)

Graphs of the partitions executed by executors.

repeated .tensorflow.GraphDef partition_graphs = 3;

Specified by:

getPartitionGraphs in interface RunMetadataOrBuilder

getPartitionGraphsOrBuilder

public GraphDefOrBuilder getPartitionGraphsOrBuilder(int index)

Graphs of the partitions executed by executors.

repeated .tensorflow.GraphDef partition_graphs = 3;

Specified by:

getPartitionGraphsOrBuilder in interface RunMetadataOrBuilder

getFunctionGraphsList

public List<RunMetadata.FunctionGraphs> getFunctionGraphsList()

This is only populated for graphs that are run as functions in TensorFlow
V2. There will be an entry below for each function that is traced.
The main use cases of the post_optimization_graph and the partition_graphs
is to give the caller insight into the graphs that were actually run by the
runtime. Additional information (such as those in step_stats) will match
these graphs.
We also include the pre_optimization_graph since it is usually easier to
read, and is helpful in situations where the caller wants to get a high
level idea of what the built graph looks like (since the various graph
optimization passes might change the structure of the graph significantly).

repeated .tensorflow.RunMetadata.FunctionGraphs function_graphs = 4;

Specified by:

getFunctionGraphsList in interface RunMetadataOrBuilder

getFunctionGraphsOrBuilderList

public List<? extends RunMetadata.FunctionGraphsOrBuilder> getFunctionGraphsOrBuilderList()

This is only populated for graphs that are run as functions in TensorFlow
V2. There will be an entry below for each function that is traced.
The main use cases of the post_optimization_graph and the partition_graphs
is to give the caller insight into the graphs that were actually run by the
runtime. Additional information (such as those in step_stats) will match
these graphs.
We also include the pre_optimization_graph since it is usually easier to
read, and is helpful in situations where the caller wants to get a high
level idea of what the built graph looks like (since the various graph
optimization passes might change the structure of the graph significantly).

repeated .tensorflow.RunMetadata.FunctionGraphs function_graphs = 4;

Specified by:

getFunctionGraphsOrBuilderList in interface RunMetadataOrBuilder

getFunctionGraphsCount

public int getFunctionGraphsCount()

This is only populated for graphs that are run as functions in TensorFlow
V2. There will be an entry below for each function that is traced.
The main use cases of the post_optimization_graph and the partition_graphs
is to give the caller insight into the graphs that were actually run by the
runtime. Additional information (such as those in step_stats) will match
these graphs.
We also include the pre_optimization_graph since it is usually easier to
read, and is helpful in situations where the caller wants to get a high
level idea of what the built graph looks like (since the various graph
optimization passes might change the structure of the graph significantly).

repeated .tensorflow.RunMetadata.FunctionGraphs function_graphs = 4;

Specified by:

getFunctionGraphsCount in interface RunMetadataOrBuilder

getFunctionGraphs

public RunMetadata.FunctionGraphs getFunctionGraphs(int index)

This is only populated for graphs that are run as functions in TensorFlow
V2. There will be an entry below for each function that is traced.
The main use cases of the post_optimization_graph and the partition_graphs
is to give the caller insight into the graphs that were actually run by the
runtime. Additional information (such as those in step_stats) will match
these graphs.
We also include the pre_optimization_graph since it is usually easier to
read, and is helpful in situations where the caller wants to get a high
level idea of what the built graph looks like (since the various graph
optimization passes might change the structure of the graph significantly).

repeated .tensorflow.RunMetadata.FunctionGraphs function_graphs = 4;

Specified by:

getFunctionGraphs in interface RunMetadataOrBuilder

getFunctionGraphsOrBuilder

public RunMetadata.FunctionGraphsOrBuilder getFunctionGraphsOrBuilder(int index)

This is only populated for graphs that are run as functions in TensorFlow
V2. There will be an entry below for each function that is traced.
The main use cases of the post_optimization_graph and the partition_graphs
is to give the caller insight into the graphs that were actually run by the
runtime. Additional information (such as those in step_stats) will match
these graphs.
We also include the pre_optimization_graph since it is usually easier to
read, and is helpful in situations where the caller wants to get a high
level idea of what the built graph looks like (since the various graph
optimization passes might change the structure of the graph significantly).

repeated .tensorflow.RunMetadata.FunctionGraphs function_graphs = 4;

Specified by:

getFunctionGraphsOrBuilder in interface RunMetadataOrBuilder

hasSessionMetadata

public boolean hasSessionMetadata()

Metadata about the session.

.tensorflow.SessionMetadata session_metadata = 5;

Specified by:

hasSessionMetadata in interface RunMetadataOrBuilder

Returns:

Whether the sessionMetadata field is set.

getSessionMetadata

public SessionMetadata getSessionMetadata()

Metadata about the session.

.tensorflow.SessionMetadata session_metadata = 5;

Specified by:

getSessionMetadata in interface RunMetadataOrBuilder

Returns:

The sessionMetadata.

getSessionMetadataOrBuilder

public SessionMetadataOrBuilder getSessionMetadataOrBuilder()

Metadata about the session.

.tensorflow.SessionMetadata session_metadata = 5;

Specified by:

getSessionMetadataOrBuilder in interface RunMetadataOrBuilder

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 RunMetadata parseFrom(ByteBuffer data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static RunMetadata parseFrom(ByteString data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static RunMetadata parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RunMetadata parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static RunMetadata parseFrom(CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RunMetadata.Builder newBuilder()

newBuilder

public static RunMetadata.Builder newBuilder(RunMetadata prototype)

toBuilder

public RunMetadata.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RunMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RunMetadata getDefaultInstance()

parser

public static Parser<RunMetadata> parser()

getParserForType

public Parser<RunMetadata> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RunMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder