Package org.tensorflow.framework

Interface DebugTensorWatchOrBuilder

  • All Superinterfaces:
    org.nd4j.shade.protobuf.MessageLiteOrBuilder, org.nd4j.shade.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DebugTensorWatch, DebugTensorWatch.Builder
    public interface DebugTensorWatchOrBuilder
extends org.nd4j.shade.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDebugOps​(int index)
      Name(s) of the debugging op(s).
      org.nd4j.shade.protobuf.ByteString getDebugOpsBytes​(int index)
      Name(s) of the debugging op(s).
      int getDebugOpsCount()
      Name(s) of the debugging op(s).
      List<String> getDebugOpsList()
      Name(s) of the debugging op(s).
      String getDebugUrls​(int index)
      URL(s) for debug targets(s).
      org.nd4j.shade.protobuf.ByteString getDebugUrlsBytes​(int index)
      URL(s) for debug targets(s).
      int getDebugUrlsCount()
      URL(s) for debug targets(s).
      List<String> getDebugUrlsList()
      URL(s) for debug targets(s).
      String getNodeName()
      Name of the node to watch.
      org.nd4j.shade.protobuf.ByteString getNodeNameBytes()
      Name of the node to watch.
      int getOutputSlot()
      Output slot to watch.
      boolean getTolerateDebugOpCreationFailures()
      Do not error out if debug op creation fails (e.g., due to dtype incompatibility).

      • Methods inherited from interface org.nd4j.shade.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface org.nd4j.shade.protobuf.MessageOrBuilder

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

    • Method Detail

      • getNodeName

        String getNodeName()
         Name of the node to watch.
        string node_name = 1;
        Returns:
        The nodeName.

      • getNodeNameBytes

        org.nd4j.shade.protobuf.ByteString getNodeNameBytes()
         Name of the node to watch.
        string node_name = 1;
        Returns:
        The bytes for nodeName.

      • getOutputSlot

        int getOutputSlot()
         Output slot to watch.
 The semantics of output_slot == -1 is that the node is only watched for
 completion, but not for any output tensors. See NodeCompletionCallback
 in debug_gateway.h.
 TODO(cais): Implement this semantics.
        int32 output_slot = 2;
        Returns:
        The outputSlot.

      • getDebugOpsList

        List<String> 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;
        Returns:
        A list containing the debugOps.

      • getDebugOpsCount

        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;
        Returns:
        The count of debugOps.

      • getDebugOps

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The debugOps at the given index.

      • getDebugOpsBytes

        org.nd4j.shade.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the debugOps at the given index.

      • getDebugUrlsList

        List<String> 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;
        Returns:
        A list containing the debugUrls.

      • getDebugUrlsCount

        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;
        Returns:
        The count of debugUrls.

      • getDebugUrls

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The debugUrls at the given index.

      • getDebugUrlsBytes

        org.nd4j.shade.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the debugUrls at the given index.

      • getTolerateDebugOpCreationFailures

        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;
        Returns:
        The tolerateDebugOpCreationFailures.