Package org.tensorflow.framework

Class DebugTensorWatch.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, DebugTensorWatchOrBuilder
    Enclosing class:
    DebugTensorWatch
    public static final class DebugTensorWatch.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>
implements DebugTensorWatchOrBuilder
     Option for watching a node in TensorFlow Debugger (tfdbg).
    Protobuf type tensorflow.DebugTensorWatch

    • Method Detail

      • 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.Builder<DebugTensorWatch.Builder>

      • clear

        public DebugTensorWatch.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public DebugTensorWatch.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • setField

        public DebugTensorWatch.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • clearField

        public DebugTensorWatch.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • clearOneof

        public DebugTensorWatch.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • setRepeatedField

        public DebugTensorWatch.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • addRepeatedField

        public DebugTensorWatch.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • mergeFrom

        public DebugTensorWatch.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DebugTensorWatch.Builder>

      • isInitialized

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

      • mergeFrom

        public DebugTensorWatch.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DebugTensorWatch.Builder>
        Throws:
        java.io.IOException

      • getNodeName

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

      • setNodeName

        public DebugTensorWatch.Builder setNodeName​(java.lang.String value)
         Name of the node to watch.
 Use "*" for wildcard. But note: currently, regex is not supported in
 general.
        string node_name = 1;
        Parameters:
        value - The nodeName to set.
        Returns:
        This builder for chaining.

      • clearNodeName

        public DebugTensorWatch.Builder clearNodeName()
         Name of the node to watch.
 Use "*" for wildcard. But note: currently, regex is not supported in
 general.
        string node_name = 1;
        Returns:
        This builder for chaining.

      • setNodeNameBytes

        public DebugTensorWatch.Builder setNodeNameBytes​(com.google.protobuf.ByteString value)
         Name of the node to watch.
 Use "*" for wildcard. But note: currently, regex is not supported in
 general.
        string node_name = 1;
        Parameters:
        value - The bytes for nodeName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setOutputSlot

        public DebugTensorWatch.Builder setOutputSlot​(int value)
         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;
        Parameters:
        value - The outputSlot to set.
        Returns:
        This builder for chaining.

      • clearOutputSlot

        public DebugTensorWatch.Builder clearOutputSlot()
         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;
        Returns:
        This builder for chaining.

      • 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 java.lang.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.

      • setDebugOps

        public DebugTensorWatch.Builder setDebugOps​(int index,
                                            java.lang.String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The debugOps to set.
        Returns:
        This builder for chaining.

      • addDebugOps

        public DebugTensorWatch.Builder addDebugOps​(java.lang.String value)
         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;
        Parameters:
        value - The debugOps to add.
        Returns:
        This builder for chaining.

      • addAllDebugOps

        public DebugTensorWatch.Builder addAllDebugOps​(java.lang.Iterable<java.lang.String> values)
         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;
        Parameters:
        values - The debugOps to add.
        Returns:
        This builder for chaining.

      • clearDebugOps

        public DebugTensorWatch.Builder clearDebugOps()
         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;
        Returns:
        This builder for chaining.

      • addDebugOpsBytes

        public DebugTensorWatch.Builder addDebugOpsBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the debugOps to add.
        Returns:
        This builder for chaining.

      • 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 java.lang.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.

      • setDebugUrls

        public DebugTensorWatch.Builder setDebugUrls​(int index,
                                             java.lang.String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The debugUrls to set.
        Returns:
        This builder for chaining.

      • addDebugUrls

        public DebugTensorWatch.Builder addDebugUrls​(java.lang.String value)
         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;
        Parameters:
        value - The debugUrls to add.
        Returns:
        This builder for chaining.

      • addAllDebugUrls

        public DebugTensorWatch.Builder addAllDebugUrls​(java.lang.Iterable<java.lang.String> values)
         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;
        Parameters:
        values - The debugUrls to add.
        Returns:
        This builder for chaining.

      • clearDebugUrls

        public DebugTensorWatch.Builder clearDebugUrls()
         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;
        Returns:
        This builder for chaining.

      • addDebugUrlsBytes

        public DebugTensorWatch.Builder addDebugUrlsBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the debugUrls to add.
        Returns:
        This builder for chaining.

      • 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.

      • setTolerateDebugOpCreationFailures

        public DebugTensorWatch.Builder setTolerateDebugOpCreationFailures​(boolean value)
         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;
        Parameters:
        value - The tolerateDebugOpCreationFailures to set.
        Returns:
        This builder for chaining.

      • clearTolerateDebugOpCreationFailures

        public DebugTensorWatch.Builder clearTolerateDebugOpCreationFailures()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final DebugTensorWatch.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

      • mergeUnknownFields

        public final DebugTensorWatch.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DebugTensorWatch.Builder>