Package org.tensorflow.framework

Class DebugTensorWatch

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.framework.DebugTensorWatch
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, DebugTensorWatchOrBuilder
public final class DebugTensorWatch extends com.google.protobuf.GeneratedMessageV3 implements DebugTensorWatchOrBuilder
 Option for watching a node in TensorFlow Debugger (tfdbg).
Protobuf type tensorflow.DebugTensorWatch
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DebugTensorWatch.Builder
    Option for watching a node in TensorFlow Debugger (tfdbg).

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    DEBUG_OPS_FIELD_NUMBER
     
    static final int
    DEBUG_URLS_FIELD_NUMBER
     
    static final int
    NODE_NAME_FIELD_NUMBER
     
    static final int
    OUTPUT_SLOT_FIELD_NUMBER
     
    static final int
    TOLERATE_DEBUG_OP_CREATION_FAILURES_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(Object obj)
     
    String
    getDebugOps(int index)
    Name(s) of the debugging op(s).
    com.google.protobuf.ByteString
    getDebugOpsBytes(int index)
    Name(s) of the debugging op(s).
    int
    getDebugOpsCount()
    Name(s) of the debugging op(s).
    com.google.protobuf.ProtocolStringList
    getDebugOpsList()
    Name(s) of the debugging op(s).
    String
    getDebugUrls(int index)
    URL(s) for debug targets(s).
    com.google.protobuf.ByteString
    getDebugUrlsBytes(int index)
    URL(s) for debug targets(s).
    int
    getDebugUrlsCount()
    URL(s) for debug targets(s).
    com.google.protobuf.ProtocolStringList
    getDebugUrlsList()
    URL(s) for debug targets(s).
    static DebugTensorWatch
    getDefaultInstance()
     
    DebugTensorWatch
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getNodeName()
    Name of the node to watch.
    com.google.protobuf.ByteString
    getNodeNameBytes()
    Name of the node to watch.
    int
    getOutputSlot()
    Output slot to watch.
    com.google.protobuf.Parser<DebugTensorWatch>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    getTolerateDebugOpCreationFailures()
    Do not error out if debug op creation fails (e.g., due to dtype incompatibility).
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DebugTensorWatch.Builder
    newBuilder()
     
    static DebugTensorWatch.Builder
    newBuilder(DebugTensorWatch prototype)
     
    DebugTensorWatch.Builder
    newBuilderForType()
     
    protected DebugTensorWatch.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DebugTensorWatch
    parseDelimitedFrom(InputStream input)
     
    static DebugTensorWatch
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DebugTensorWatch
    parseFrom(byte[] data)
     
    static DebugTensorWatch
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DebugTensorWatch
    parseFrom(com.google.protobuf.ByteString data)
     
    static DebugTensorWatch
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DebugTensorWatch
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DebugTensorWatch
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DebugTensorWatch
    parseFrom(InputStream input)
     
    static DebugTensorWatch
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DebugTensorWatch
    parseFrom(ByteBuffer data)
     
    static DebugTensorWatch
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DebugTensorWatch>
    parser()
     
    DebugTensorWatch.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

  • Field Details

    • NODE_NAME_FIELD_NUMBER

      public static final int NODE_NAME_FIELD_NUMBER
      See Also:

    • OUTPUT_SLOT_FIELD_NUMBER

      public static final int OUTPUT_SLOT_FIELD_NUMBER
      See Also:

    • DEBUG_OPS_FIELD_NUMBER

      public static final int DEBUG_OPS_FIELD_NUMBER
      See Also:

    • DEBUG_URLS_FIELD_NUMBER

      public static final int DEBUG_URLS_FIELD_NUMBER
      See Also:

    • TOLERATE_DEBUG_OP_CREATION_FAILURES_FIELD_NUMBER

      public static final int TOLERATE_DEBUG_OP_CREATION_FAILURES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getNodeName

      public String getNodeName()
       Name of the node to watch.
 Use "*" for wildcard. But note: currently, regex is not supported in
 general.
      string node_name = 1;
      Specified by:
      getNodeName in interface DebugTensorWatchOrBuilder
      Returns:
      The nodeName.

    • getNodeNameBytes

      public com.google.protobuf.ByteString getNodeNameBytes()
       Name of the node to watch.
 Use "*" for wildcard. But note: currently, regex is not supported in
 general.
      string node_name = 1;
      Specified by:
      getNodeNameBytes in interface DebugTensorWatchOrBuilder
      Returns:
      The bytes for nodeName.

    • getOutputSlot

      public int getOutputSlot()
       Output slot to watch.
 The semantics of output_slot == -1 is that all outputs of the node
 will be watched (i.e., a wildcard).
 Other negative values of output_slot are invalid and will lead to
 errors currently.
      int32 output_slot = 2;
      Specified by:
      getOutputSlot in interface DebugTensorWatchOrBuilder
      Returns:
      The outputSlot.

    • getDebugOpsList

      public com.google.protobuf.ProtocolStringList getDebugOpsList()
       Name(s) of the debugging op(s).
 One or more than one probes on a tensor.
 e.g., {"DebugIdentity", "DebugNanCount"}
      repeated string debug_ops = 3;
      Specified by:
      getDebugOpsList in interface DebugTensorWatchOrBuilder
      Returns:
      A list containing the debugOps.

    • getDebugOpsCount

      public int getDebugOpsCount()
       Name(s) of the debugging op(s).
 One or more than one probes on a tensor.
 e.g., {"DebugIdentity", "DebugNanCount"}
      repeated string debug_ops = 3;
      Specified by:
      getDebugOpsCount in interface DebugTensorWatchOrBuilder
      Returns:
      The count of debugOps.

    • getDebugOps

      public String getDebugOps(int index)
       Name(s) of the debugging op(s).
 One or more than one probes on a tensor.
 e.g., {"DebugIdentity", "DebugNanCount"}
      repeated string debug_ops = 3;
      Specified by:
      getDebugOps in interface DebugTensorWatchOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The debugOps at the given index.

    • getDebugOpsBytes

      public com.google.protobuf.ByteString getDebugOpsBytes(int index)
       Name(s) of the debugging op(s).
 One or more than one probes on a tensor.
 e.g., {"DebugIdentity", "DebugNanCount"}
      repeated string debug_ops = 3;
      Specified by:
      getDebugOpsBytes in interface DebugTensorWatchOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the debugOps at the given index.

    • getDebugUrlsList

      public com.google.protobuf.ProtocolStringList getDebugUrlsList()
       URL(s) for debug targets(s).

 Supported URL formats are:
   - file:///foo/tfdbg_dump: Writes out Event content to file
     /foo/tfdbg_dump.  Assumes all directories can be created if they don't
     already exist.
   - grpc://localhost:11011: Sends an RPC request to an EventListener
     service running at localhost:11011 with the event.
   - memcbk:///event_key: Routes tensors to clients using the
     callback registered with the DebugCallbackRegistry for event_key.

 Each debug op listed in debug_ops will publish its output tensor (debug
 signal) to all URLs in debug_urls.

 N.B. Session::Run() supports concurrent invocations of the same inputs
 (feed keys), outputs and target nodes. If such concurrent invocations
 are to be debugged, the callers of Session::Run() must use distinct
 debug_urls to make sure that the streamed or dumped events do not overlap
 among the invocations.
 TODO(cais): More visible documentation of this in g3docs.
      repeated string debug_urls = 4;
      Specified by:
      getDebugUrlsList in interface DebugTensorWatchOrBuilder
      Returns:
      A list containing the debugUrls.

    • getDebugUrlsCount

      public int getDebugUrlsCount()
       URL(s) for debug targets(s).

 Supported URL formats are:
   - file:///foo/tfdbg_dump: Writes out Event content to file
     /foo/tfdbg_dump.  Assumes all directories can be created if they don't
     already exist.
   - grpc://localhost:11011: Sends an RPC request to an EventListener
     service running at localhost:11011 with the event.
   - memcbk:///event_key: Routes tensors to clients using the
     callback registered with the DebugCallbackRegistry for event_key.

 Each debug op listed in debug_ops will publish its output tensor (debug
 signal) to all URLs in debug_urls.

 N.B. Session::Run() supports concurrent invocations of the same inputs
 (feed keys), outputs and target nodes. If such concurrent invocations
 are to be debugged, the callers of Session::Run() must use distinct
 debug_urls to make sure that the streamed or dumped events do not overlap
 among the invocations.
 TODO(cais): More visible documentation of this in g3docs.
      repeated string debug_urls = 4;
      Specified by:
      getDebugUrlsCount in interface DebugTensorWatchOrBuilder
      Returns:
      The count of debugUrls.

    • getDebugUrls

      public String getDebugUrls(int index)
       URL(s) for debug targets(s).

 Supported URL formats are:
   - file:///foo/tfdbg_dump: Writes out Event content to file
     /foo/tfdbg_dump.  Assumes all directories can be created if they don't
     already exist.
   - grpc://localhost:11011: Sends an RPC request to an EventListener
     service running at localhost:11011 with the event.
   - memcbk:///event_key: Routes tensors to clients using the
     callback registered with the DebugCallbackRegistry for event_key.

 Each debug op listed in debug_ops will publish its output tensor (debug
 signal) to all URLs in debug_urls.

 N.B. Session::Run() supports concurrent invocations of the same inputs
 (feed keys), outputs and target nodes. If such concurrent invocations
 are to be debugged, the callers of Session::Run() must use distinct
 debug_urls to make sure that the streamed or dumped events do not overlap
 among the invocations.
 TODO(cais): More visible documentation of this in g3docs.
      repeated string debug_urls = 4;
      Specified by:
      getDebugUrls in interface DebugTensorWatchOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The debugUrls at the given index.

    • getDebugUrlsBytes

      public com.google.protobuf.ByteString getDebugUrlsBytes(int index)
       URL(s) for debug targets(s).

 Supported URL formats are:
   - file:///foo/tfdbg_dump: Writes out Event content to file
     /foo/tfdbg_dump.  Assumes all directories can be created if they don't
     already exist.
   - grpc://localhost:11011: Sends an RPC request to an EventListener
     service running at localhost:11011 with the event.
   - memcbk:///event_key: Routes tensors to clients using the
     callback registered with the DebugCallbackRegistry for event_key.

 Each debug op listed in debug_ops will publish its output tensor (debug
 signal) to all URLs in debug_urls.

 N.B. Session::Run() supports concurrent invocations of the same inputs
 (feed keys), outputs and target nodes. If such concurrent invocations
 are to be debugged, the callers of Session::Run() must use distinct
 debug_urls to make sure that the streamed or dumped events do not overlap
 among the invocations.
 TODO(cais): More visible documentation of this in g3docs.
      repeated string debug_urls = 4;
      Specified by:
      getDebugUrlsBytes in interface DebugTensorWatchOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the debugUrls at the given index.

    • getTolerateDebugOpCreationFailures

      public boolean getTolerateDebugOpCreationFailures()
       Do not error out if debug op creation fails (e.g., due to dtype
 incompatibility). Instead, just log the failure.
      bool tolerate_debug_op_creation_failures = 5;
      Specified by:
      getTolerateDebugOpCreationFailures in interface DebugTensorWatchOrBuilder
      Returns:
      The tolerateDebugOpCreationFailures.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 DebugTensorWatch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DebugTensorWatch parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DebugTensorWatch parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DebugTensorWatch parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DebugTensorWatch parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DebugTensorWatch parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DebugTensorWatch parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DebugTensorWatch parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DebugTensorWatch.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DebugTensorWatch.Builder newBuilder()

    • newBuilder

      public static DebugTensorWatch.Builder newBuilder(DebugTensorWatch prototype)

    • toBuilder

      public DebugTensorWatch.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

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

    • getDefaultInstance

      public static DebugTensorWatch getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DebugTensorWatch> 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 DebugTensorWatch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder