Package org.tensorflow.framework

Interface DebugTensorWatchOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DebugTensorWatch, DebugTensorWatch.Builder
public interface DebugTensorWatchOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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).
    List<String>
    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).
    List<String>
    getDebugUrlsList()
    URL(s) for debug targets(s).
    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.
    boolean
    getTolerateDebugOpCreationFailures()
    Do not error out if debug op creation fails (e.g., due to dtype incompatibility).

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getNodeName

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

    • getNodeNameBytes

      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;
      Returns:
      The bytes for nodeName.

    • getOutputSlot

      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;
      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

      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;
      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

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