Class DebugTensorWatch

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.DebugTensorWatch

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, DebugTensorWatchOrBuilder

public final class DebugTensorWatch
extends GeneratedMessageV3
implements DebugTensorWatchOrBuilder

Option for watching a node in TensorFlow Debugger (tfdbg).

Protobuf type tensorflow.DebugTensorWatch

See Also:

• Serialized Form

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 GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

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 GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDebugOps(int index)	Name(s) of the debugging op(s).
ByteString	getDebugOpsBytes(int index)	Name(s) of the debugging op(s).
int	getDebugOpsCount()	Name(s) of the debugging op(s).
ProtocolStringList	getDebugOpsList()	Name(s) of the debugging op(s).
String	getDebugUrls(int index)	URL(s) for debug targets(s).
ByteString	getDebugUrlsBytes(int index)	URL(s) for debug targets(s).
int	getDebugUrlsCount()	URL(s) for debug targets(s).
ProtocolStringList	getDebugUrlsList()	URL(s) for debug targets(s).
static DebugTensorWatch	getDefaultInstance()
DebugTensorWatch	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
String	getNodeName()	Name of the node to watch.
ByteString	getNodeNameBytes()	Name of the node to watch.
int	getOutputSlot()	Output slot to watch.
Parser<DebugTensorWatch>	getParserForType()
int	getSerializedSize()
boolean	getTolerateDebugOpCreationFailures()	Do not error out if debug op creation fails (e.g., due to dtype incompatibility).
final UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static DebugTensorWatch.Builder	newBuilder()
static DebugTensorWatch.Builder	newBuilder(DebugTensorWatch prototype)
DebugTensorWatch.Builder	newBuilderForType()
protected DebugTensorWatch.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static DebugTensorWatch	parseDelimitedFrom(InputStream input)
static DebugTensorWatch	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static DebugTensorWatch	parseFrom(byte[] data)
static DebugTensorWatch	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DebugTensorWatch	parseFrom(ByteString data)
static DebugTensorWatch	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static DebugTensorWatch	parseFrom(CodedInputStream input)
static DebugTensorWatch	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static DebugTensorWatch	parseFrom(InputStream input)
static DebugTensorWatch	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static DebugTensorWatch	parseFrom(ByteBuffer data)
static DebugTensorWatch	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<DebugTensorWatch>	parser()
DebugTensorWatch.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

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

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

NODE_NAME_FIELD_NUMBER

public static final int NODE_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

OUTPUT_SLOT_FIELD_NUMBER

public static final int OUTPUT_SLOT_FIELD_NUMBER

See Also:

• Constant Field Values

DEBUG_OPS_FIELD_NUMBER

public static final int DEBUG_OPS_FIELD_NUMBER

See Also:

• Constant Field Values

DEBUG_URLS_FIELD_NUMBER

public static final int DEBUG_URLS_FIELD_NUMBER

See Also:

• Constant Field Values

TOLERATE_DEBUG_OP_CREATION_FAILURES_FIELD_NUMBER

public static final int TOLERATE_DEBUG_OP_CREATION_FAILURES_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class 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 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 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.

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.

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 MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static DebugTensorWatch parseFrom(ByteBuffer data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(ByteString data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(byte[] data)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                  throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DebugTensorWatch parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DebugTensorWatch parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static DebugTensorWatch parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static DebugTensorWatch parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static DebugTensorWatch parseFrom(CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DebugTensorWatch parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public DebugTensorWatch.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface 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 Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected DebugTensorWatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static DebugTensorWatch getDefaultInstance()

parser

public static Parser<DebugTensorWatch> parser()

getParserForType

public Parser<DebugTensorWatch> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public DebugTensorWatch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder