Package org.platanios.tensorflow.proto
Class CallableOptions
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.platanios.tensorflow.proto.CallableOptions
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
,CallableOptionsOrBuilder
public final class CallableOptions extends com.google.protobuf.GeneratedMessageV3 implements CallableOptionsOrBuilder
Defines a subgraph in another `GraphDef` as a set of feed points and nodes to be fetched or executed. Compare with the arguments to `Session::Run()`.
Protobuf typeorg.platanios.tensorflow.proto.CallableOptions
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CallableOptions.Builder
Defines a subgraph in another `GraphDef` as a set of feed points and nodes to be fetched or executed.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
FEED_DEVICES_FIELD_NUMBER
static int
FEED_FIELD_NUMBER
static int
FETCH_DEVICES_FIELD_NUMBER
static int
FETCH_FIELD_NUMBER
static int
FETCH_SKIP_SYNC_FIELD_NUMBER
static int
RUN_OPTIONS_FIELD_NUMBER
static int
TARGET_FIELD_NUMBER
static int
TENSOR_CONNECTION_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsFeedDevices(java.lang.String key)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default.boolean
containsFetchDevices(java.lang.String key)
map<string, string> fetch_devices = 7;
boolean
equals(java.lang.Object obj)
static CallableOptions
getDefaultInstance()
CallableOptions
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
java.lang.String
getFeed(int index)
Tensors to be fed in the callable.com.google.protobuf.ByteString
getFeedBytes(int index)
Tensors to be fed in the callable.int
getFeedCount()
Tensors to be fed in the callable.java.util.Map<java.lang.String,java.lang.String>
getFeedDevices()
Deprecated.int
getFeedDevicesCount()
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default.java.util.Map<java.lang.String,java.lang.String>
getFeedDevicesMap()
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default.java.lang.String
getFeedDevicesOrDefault(java.lang.String key, java.lang.String defaultValue)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default.java.lang.String
getFeedDevicesOrThrow(java.lang.String key)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default.com.google.protobuf.ProtocolStringList
getFeedList()
Tensors to be fed in the callable.java.lang.String
getFetch(int index)
Fetches.com.google.protobuf.ByteString
getFetchBytes(int index)
Fetches.int
getFetchCount()
Fetches.java.util.Map<java.lang.String,java.lang.String>
getFetchDevices()
Deprecated.int
getFetchDevicesCount()
map<string, string> fetch_devices = 7;
java.util.Map<java.lang.String,java.lang.String>
getFetchDevicesMap()
map<string, string> fetch_devices = 7;
java.lang.String
getFetchDevicesOrDefault(java.lang.String key, java.lang.String defaultValue)
map<string, string> fetch_devices = 7;
java.lang.String
getFetchDevicesOrThrow(java.lang.String key)
map<string, string> fetch_devices = 7;
com.google.protobuf.ProtocolStringList
getFetchList()
Fetches.boolean
getFetchSkipSync()
By default, RunCallable() will synchronize the GPU stream before returning fetched tensors on a GPU device, to ensure that the values in those tensors have been produced.com.google.protobuf.Parser<CallableOptions>
getParserForType()
RunOptions
getRunOptions()
Options that will be applied to each run.RunOptionsOrBuilder
getRunOptionsOrBuilder()
Options that will be applied to each run.int
getSerializedSize()
java.lang.String
getTarget(int index)
Target Nodes.com.google.protobuf.ByteString
getTargetBytes(int index)
Target Nodes.int
getTargetCount()
Target Nodes.com.google.protobuf.ProtocolStringList
getTargetList()
Target Nodes.TensorConnection
getTensorConnection(int index)
Tensors to be connected in the callable.int
getTensorConnectionCount()
Tensors to be connected in the callable.java.util.List<TensorConnection>
getTensorConnectionList()
Tensors to be connected in the callable.TensorConnectionOrBuilder
getTensorConnectionOrBuilder(int index)
Tensors to be connected in the callable.java.util.List<? extends TensorConnectionOrBuilder>
getTensorConnectionOrBuilderList()
Tensors to be connected in the callable.com.google.protobuf.UnknownFieldSet
getUnknownFields()
int
hashCode()
boolean
hasRunOptions()
Options that will be applied to each run.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static CallableOptions.Builder
newBuilder()
static CallableOptions.Builder
newBuilder(CallableOptions prototype)
CallableOptions.Builder
newBuilderForType()
protected CallableOptions.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CallableOptions
parseDelimitedFrom(java.io.InputStream input)
static CallableOptions
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(byte[] data)
static CallableOptions
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(com.google.protobuf.ByteString data)
static CallableOptions
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(com.google.protobuf.CodedInputStream input)
static CallableOptions
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(java.io.InputStream input)
static CallableOptions
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(java.nio.ByteBuffer data)
static CallableOptions
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CallableOptions>
parser()
CallableOptions.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, 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 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
FEED_FIELD_NUMBER
public static final int FEED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FETCH_FIELD_NUMBER
public static final int FETCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TARGET_FIELD_NUMBER
public static final int TARGET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RUN_OPTIONS_FIELD_NUMBER
public static final int RUN_OPTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TENSOR_CONNECTION_FIELD_NUMBER
public static final int TENSOR_CONNECTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FEED_DEVICES_FIELD_NUMBER
public static final int FEED_DEVICES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FETCH_DEVICES_FIELD_NUMBER
public static final int FETCH_DEVICES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FETCH_SKIP_SYNC_FIELD_NUMBER
public static final int FETCH_SKIP_SYNC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getFeedList
public com.google.protobuf.ProtocolStringList getFeedList()
Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;
- Specified by:
getFeedList
in interfaceCallableOptionsOrBuilder
- Returns:
- A list containing the feed.
-
getFeedCount
public int getFeedCount()
Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;
- Specified by:
getFeedCount
in interfaceCallableOptionsOrBuilder
- Returns:
- The count of feed.
-
getFeed
public java.lang.String getFeed(int index)
Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;
- Specified by:
getFeed
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The feed at the given index.
-
getFeedBytes
public com.google.protobuf.ByteString getFeedBytes(int index)
Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;
- Specified by:
getFeedBytes
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the feed at the given index.
-
getFetchList
public com.google.protobuf.ProtocolStringList getFetchList()
Fetches. A list of tensor names. The caller of the callable expects a tensor to be returned for each fetch[i] (see RunStepResponse.tensor). The order of specified fetches does not change the execution order.
repeated string fetch = 2;
- Specified by:
getFetchList
in interfaceCallableOptionsOrBuilder
- Returns:
- A list containing the fetch.
-
getFetchCount
public int getFetchCount()
Fetches. A list of tensor names. The caller of the callable expects a tensor to be returned for each fetch[i] (see RunStepResponse.tensor). The order of specified fetches does not change the execution order.
repeated string fetch = 2;
- Specified by:
getFetchCount
in interfaceCallableOptionsOrBuilder
- Returns:
- The count of fetch.
-
getFetch
public java.lang.String getFetch(int index)
Fetches. A list of tensor names. The caller of the callable expects a tensor to be returned for each fetch[i] (see RunStepResponse.tensor). The order of specified fetches does not change the execution order.
repeated string fetch = 2;
- Specified by:
getFetch
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The fetch at the given index.
-
getFetchBytes
public com.google.protobuf.ByteString getFetchBytes(int index)
Fetches. A list of tensor names. The caller of the callable expects a tensor to be returned for each fetch[i] (see RunStepResponse.tensor). The order of specified fetches does not change the execution order.
repeated string fetch = 2;
- Specified by:
getFetchBytes
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the fetch at the given index.
-
getTargetList
public com.google.protobuf.ProtocolStringList getTargetList()
Target Nodes. A list of node names. The named nodes will be run by the callable but their outputs will not be returned.
repeated string target = 3;
- Specified by:
getTargetList
in interfaceCallableOptionsOrBuilder
- Returns:
- A list containing the target.
-
getTargetCount
public int getTargetCount()
Target Nodes. A list of node names. The named nodes will be run by the callable but their outputs will not be returned.
repeated string target = 3;
- Specified by:
getTargetCount
in interfaceCallableOptionsOrBuilder
- Returns:
- The count of target.
-
getTarget
public java.lang.String getTarget(int index)
Target Nodes. A list of node names. The named nodes will be run by the callable but their outputs will not be returned.
repeated string target = 3;
- Specified by:
getTarget
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The target at the given index.
-
getTargetBytes
public com.google.protobuf.ByteString getTargetBytes(int index)
Target Nodes. A list of node names. The named nodes will be run by the callable but their outputs will not be returned.
repeated string target = 3;
- Specified by:
getTargetBytes
in interfaceCallableOptionsOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the target at the given index.
-
hasRunOptions
public boolean hasRunOptions()
Options that will be applied to each run.
.org.platanios.tensorflow.proto.RunOptions run_options = 4;
- Specified by:
hasRunOptions
in interfaceCallableOptionsOrBuilder
- Returns:
- Whether the runOptions field is set.
-
getRunOptions
public RunOptions getRunOptions()
Options that will be applied to each run.
.org.platanios.tensorflow.proto.RunOptions run_options = 4;
- Specified by:
getRunOptions
in interfaceCallableOptionsOrBuilder
- Returns:
- The runOptions.
-
getRunOptionsOrBuilder
public RunOptionsOrBuilder getRunOptionsOrBuilder()
Options that will be applied to each run.
.org.platanios.tensorflow.proto.RunOptions run_options = 4;
- Specified by:
getRunOptionsOrBuilder
in interfaceCallableOptionsOrBuilder
-
getTensorConnectionList
public java.util.List<TensorConnection> getTensorConnectionList()
Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.
repeated .org.platanios.tensorflow.proto.TensorConnection tensor_connection = 5;
- Specified by:
getTensorConnectionList
in interfaceCallableOptionsOrBuilder
-
getTensorConnectionOrBuilderList
public java.util.List<? extends TensorConnectionOrBuilder> getTensorConnectionOrBuilderList()
Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.
repeated .org.platanios.tensorflow.proto.TensorConnection tensor_connection = 5;
- Specified by:
getTensorConnectionOrBuilderList
in interfaceCallableOptionsOrBuilder
-
getTensorConnectionCount
public int getTensorConnectionCount()
Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.
repeated .org.platanios.tensorflow.proto.TensorConnection tensor_connection = 5;
- Specified by:
getTensorConnectionCount
in interfaceCallableOptionsOrBuilder
-
getTensorConnection
public TensorConnection getTensorConnection(int index)
Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.
repeated .org.platanios.tensorflow.proto.TensorConnection tensor_connection = 5;
- Specified by:
getTensorConnection
in interfaceCallableOptionsOrBuilder
-
getTensorConnectionOrBuilder
public TensorConnectionOrBuilder getTensorConnectionOrBuilder(int index)
Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.
repeated .org.platanios.tensorflow.proto.TensorConnection tensor_connection = 5;
- Specified by:
getTensorConnectionOrBuilder
in interfaceCallableOptionsOrBuilder
-
getFeedDevicesCount
public int getFeedDevicesCount()
Description copied from interface:CallableOptionsOrBuilder
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).
map<string, string> feed_devices = 6;
- Specified by:
getFeedDevicesCount
in interfaceCallableOptionsOrBuilder
-
containsFeedDevices
public boolean containsFeedDevices(java.lang.String key)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).
map<string, string> feed_devices = 6;
- Specified by:
containsFeedDevices
in interfaceCallableOptionsOrBuilder
-
getFeedDevices
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getFeedDevices()
Deprecated.UsegetFeedDevicesMap()
instead.- Specified by:
getFeedDevices
in interfaceCallableOptionsOrBuilder
-
getFeedDevicesMap
public java.util.Map<java.lang.String,java.lang.String> getFeedDevicesMap()
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).
map<string, string> feed_devices = 6;
- Specified by:
getFeedDevicesMap
in interfaceCallableOptionsOrBuilder
-
getFeedDevicesOrDefault
public java.lang.String getFeedDevicesOrDefault(java.lang.String key, java.lang.String defaultValue)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).
map<string, string> feed_devices = 6;
- Specified by:
getFeedDevicesOrDefault
in interfaceCallableOptionsOrBuilder
-
getFeedDevicesOrThrow
public java.lang.String getFeedDevicesOrThrow(java.lang.String key)
The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).
map<string, string> feed_devices = 6;
- Specified by:
getFeedDevicesOrThrow
in interfaceCallableOptionsOrBuilder
-
getFetchDevicesCount
public int getFetchDevicesCount()
Description copied from interface:CallableOptionsOrBuilder
map<string, string> fetch_devices = 7;
- Specified by:
getFetchDevicesCount
in interfaceCallableOptionsOrBuilder
-
containsFetchDevices
public boolean containsFetchDevices(java.lang.String key)
map<string, string> fetch_devices = 7;
- Specified by:
containsFetchDevices
in interfaceCallableOptionsOrBuilder
-
getFetchDevices
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getFetchDevices()
Deprecated.UsegetFetchDevicesMap()
instead.- Specified by:
getFetchDevices
in interfaceCallableOptionsOrBuilder
-
getFetchDevicesMap
public java.util.Map<java.lang.String,java.lang.String> getFetchDevicesMap()
map<string, string> fetch_devices = 7;
- Specified by:
getFetchDevicesMap
in interfaceCallableOptionsOrBuilder
-
getFetchDevicesOrDefault
public java.lang.String getFetchDevicesOrDefault(java.lang.String key, java.lang.String defaultValue)
map<string, string> fetch_devices = 7;
- Specified by:
getFetchDevicesOrDefault
in interfaceCallableOptionsOrBuilder
-
getFetchDevicesOrThrow
public java.lang.String getFetchDevicesOrThrow(java.lang.String key)
map<string, string> fetch_devices = 7;
- Specified by:
getFetchDevicesOrThrow
in interfaceCallableOptionsOrBuilder
-
getFetchSkipSync
public boolean getFetchSkipSync()
By default, RunCallable() will synchronize the GPU stream before returning fetched tensors on a GPU device, to ensure that the values in those tensors have been produced. This simplifies interacting with the tensors, but potentially incurs a performance hit. If this options is set to true, the caller is responsible for ensuring that the values in the fetched tensors have been produced before they are used. The caller can do this by invoking `Device::Sync()` on the underlying device(s), or by feeding the tensors back to the same Session using `feed_devices` with the same corresponding device name.
bool fetch_skip_sync = 8;
- Specified by:
getFetchSkipSync
in interfaceCallableOptionsOrBuilder
- Returns:
- The fetchSkipSync.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CallableOptions parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CallableOptions parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CallableOptions parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CallableOptions parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CallableOptions parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CallableOptions parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CallableOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public CallableOptions.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static CallableOptions.Builder newBuilder()
-
newBuilder
public static CallableOptions.Builder newBuilder(CallableOptions prototype)
-
toBuilder
public CallableOptions.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CallableOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static CallableOptions getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<CallableOptions> parser()
-
getParserForType
public com.google.protobuf.Parser<CallableOptions> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public CallableOptions getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-