Class DebugTensorWatch.Builder

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

  • Method Details

    • getDescriptor

      public static final Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

    • clear

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

    • getDescriptorForType

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

    • getDefaultInstanceForType

      public DebugTensorWatch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public DebugTensorWatch.Builder mergeFrom(DebugTensorWatch other)

    • isInitialized

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

    • mergeFrom

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

    • 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 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(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(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 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 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, 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(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(Iterable<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(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 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 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, 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(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(Iterable<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(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(UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface Message.Builder
      Overrides:
      setUnknownFields in class GeneratedMessageV3.Builder<DebugTensorWatch.Builder>

    • mergeUnknownFields

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