Package org.tensorflow.framework

Class RunMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.framework.RunMetadata
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, RunMetadataOrBuilder
public final class RunMetadata
extends com.google.protobuf.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 class  RunMetadata.Builder
    Metadata output (i.e., non-Tensor) for a single Run() call.
    static class  RunMetadata.FunctionGraphs
    Protobuf type tensorflow.RunMetadata.FunctionGraphs
    static interface  RunMetadata.FunctionGraphsOrBuilder  

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int COST_GRAPH_FIELD_NUMBER  
    static int FUNCTION_GRAPHS_FIELD_NUMBER  
    static int PARTITION_GRAPHS_FIELD_NUMBER  
    static int STEP_STATS_FIELD_NUMBER  

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.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 com.google.protobuf.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.
    java.util.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.
    java.util.List<? extends RunMetadata.FunctionGraphsOrBuilder> getFunctionGraphsOrBuilderList()
    This is only populated for graphs that are run as functions in TensorFlow V2.
    com.google.protobuf.Parser<RunMetadata> getParserForType()  
    GraphDef getPartitionGraphs​(int index)
    Graphs of the partitions executed by executors.
    int getPartitionGraphsCount()
    Graphs of the partitions executed by executors.
    java.util.List<GraphDef> getPartitionGraphsList()
    Graphs of the partitions executed by executors.
    GraphDefOrBuilder getPartitionGraphsOrBuilder​(int index)
    Graphs of the partitions executed by executors.
    java.util.List<? extends GraphDefOrBuilder> getPartitionGraphsOrBuilderList()
    Graphs of the partitions executed by executors.
    int getSerializedSize()  
    StepStats getStepStats()
    Statistics traced for this step.
    StepStatsOrBuilder getStepStatsOrBuilder()
    Statistics traced for this step.
    com.google.protobuf.UnknownFieldSet getUnknownFields()  
    boolean hasCostGraph()
    The cost graph for the computation defined by the run call.
    int hashCode()  
    boolean hasStepStats()
    Statistics traced for this step.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
    boolean isInitialized()  
    static RunMetadata.Builder newBuilder()  
    static RunMetadata.Builder newBuilder​(RunMetadata prototype)  
    RunMetadata.Builder newBuilderForType()  
    protected RunMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
    protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
    static RunMetadata parseDelimitedFrom​(java.io.InputStream input)  
    static RunMetadata parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static RunMetadata parseFrom​(byte[] data)  
    static RunMetadata parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static RunMetadata parseFrom​(com.google.protobuf.ByteString data)  
    static RunMetadata parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static RunMetadata parseFrom​(com.google.protobuf.CodedInputStream input)  
    static RunMetadata parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static RunMetadata parseFrom​(java.io.InputStream input)  
    static RunMetadata parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static RunMetadata parseFrom​(java.nio.ByteBuffer data)  
    static RunMetadata parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static com.google.protobuf.Parser<RunMetadata> parser()  
    RunMetadata.Builder toBuilder()  
    void writeTo​(com.google.protobuf.CodedOutputStream output)  

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, 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 com.google.protobuf.AbstractMessage

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

    Methods inherited from class com.google.protobuf.AbstractMessageLite

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.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 java.util.List<GraphDef> getPartitionGraphsList()
       Graphs of the partitions executed by executors.
      repeated .tensorflow.GraphDef partition_graphs = 3;
      Specified by:
      getPartitionGraphsList in interface RunMetadataOrBuilder

    • getPartitionGraphsOrBuilderList

      public java.util.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 java.util.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 java.util.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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo​(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      java.io.IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals​(java.lang.Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RunMetadata parseFrom​(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunMetadata parseFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static RunMetadata parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static RunMetadata parseDelimitedFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static RunMetadata parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static RunMetadata parseFrom​(com.google.protobuf.CodedInputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static RunMetadata parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • newBuilderForType

      public RunMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RunMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RunMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<RunMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RunMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder