CallableOptions

public final class CallableOptions 

 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 type tensorflow.CallableOptions

Nested Classes

class CallableOptions.Builder 
 Defines a subgraph in another `GraphDef` as a set of feed points and nodes
 to be fetched or executed. 

Constants

int FEED_DEVICES_FIELD_NUMBER
int FEED_FIELD_NUMBER
int FETCH_DEVICES_FIELD_NUMBER
int FETCH_FIELD_NUMBER
int FETCH_SKIP_SYNC_FIELD_NUMBER
int RUN_OPTIONS_FIELD_NUMBER
int TARGET_FIELD_NUMBER
int TENSOR_CONNECTION_FIELD_NUMBER

Public Methods

boolean
containsFeedDevices(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(String key)
map<string, string> fetch_devices = 7;
boolean
equals(Object obj)
static CallableOptions
getDefaultInstance()
CallableOptions
getDefaultInstanceForType()
final static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
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.
Map<String, String>
getFeedDevices()
Use getFeedDevicesMap() instead.
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.
Map<String, 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.
String
getFeedDevicesOrDefault(String key, 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.
String
getFeedDevicesOrThrow(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.
String
getFetch(int index) 
 Fetches.
com.google.protobuf.ByteString
getFetchBytes(int index) 
 Fetches.
int
getFetchCount() 
 Fetches.
Map<String, String>
getFetchDevices()
Use getFetchDevicesMap() instead.
int
getFetchDevicesCount()
map<string, string> fetch_devices = 7;
Map<String, String>
getFetchDevicesMap()
map<string, string> fetch_devices = 7;
String
getFetchDevicesOrDefault(String key, String defaultValue)
map<string, string> fetch_devices = 7;
String
getFetchDevicesOrThrow(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.
getParserForType()
RunOptions
getRunOptions() 
 Options that will be applied to each run.
RunOptionsOrBuilder
getRunOptionsOrBuilder() 
 Options that will be applied to each run.
int
getSerializedSize()
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.
List<TensorConnection>
getTensorConnectionList() 
 Tensors to be connected in the callable.
TensorConnectionOrBuilder
getTensorConnectionOrBuilder(int index) 
 Tensors to be connected in the callable.
List<? extends TensorConnectionOrBuilder>
getTensorConnectionOrBuilderList() 
 Tensors to be connected in the callable.
final com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasRunOptions() 
 Options that will be applied to each run.
int
hashCode()
final boolean
isInitialized()
static CallableOptions.Builder
newBuilder()
static CallableOptions.Builder
newBuilder(CallableOptions prototype)
CallableOptions.Builder
newBuilderForType()
static CallableOptions
parseDelimitedFrom(InputStream input)
static CallableOptions
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(com.google.protobuf.CodedInputStream input)
static CallableOptions
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(ByteBuffer data)
static CallableOptions
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(com.google.protobuf.ByteString data)
static CallableOptions
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CallableOptions
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static
parser()
CallableOptions.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)

Inherited Methods

Constants

public static final int FEED_DEVICES_FIELD_NUMBER

Constant Value: 6

public static final int FEED_FIELD_NUMBER

Constant Value: 1

public static final int FETCH_DEVICES_FIELD_NUMBER

Constant Value: 7

public static final int FETCH_FIELD_NUMBER

Constant Value: 2

public static final int FETCH_SKIP_SYNC_FIELD_NUMBER

Constant Value: 8

public static final int RUN_OPTIONS_FIELD_NUMBER

Constant Value: 4

public static final int TARGET_FIELD_NUMBER

Constant Value: 3

public static final int TENSOR_CONNECTION_FIELD_NUMBER

Constant Value: 5

Public Methods

public boolean containsFeedDevices (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;

public boolean containsFetchDevices (String key)

map<string, string> fetch_devices = 7;

public boolean equals (Object obj)

public static CallableOptions getDefaultInstance ()

public CallableOptions getDefaultInstanceForType ()

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()

public String getFeed (int index) 

 Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;

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;

public int getFeedCount () 

 Tensors to be fed in the callable. Each feed is the name of a tensor.
repeated string feed = 1;

public Map<String, String> getFeedDevices ()

Use getFeedDevicesMap() instead.

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

public Map<String, 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;

public String getFeedDevicesOrDefault (String key, 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;

public String getFeedDevicesOrThrow (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;

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;

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

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;

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;

public Map<String, String> getFetchDevices ()

Use getFetchDevicesMap() instead.

public int getFetchDevicesCount ()

map<string, string> fetch_devices = 7;

public Map<String, String> getFetchDevicesMap ()

map<string, string> fetch_devices = 7;

public String getFetchDevicesOrDefault (String key, String defaultValue)

map<string, string> fetch_devices = 7;

public String getFetchDevicesOrThrow (String key)

map<string, string> fetch_devices = 7;

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;

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;

public getParserForType ()

public RunOptions getRunOptions () 

 Options that will be applied to each run.
.tensorflow.RunOptions run_options = 4;

public RunOptionsOrBuilder getRunOptionsOrBuilder () 

 Options that will be applied to each run.
.tensorflow.RunOptions run_options = 4;

public int getSerializedSize ()

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

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;

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;

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;

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 .tensorflow.TensorConnection tensor_connection = 5;

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 .tensorflow.TensorConnection tensor_connection = 5;

public 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 .tensorflow.TensorConnection tensor_connection = 5;

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 .tensorflow.TensorConnection tensor_connection = 5;

public 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 .tensorflow.TensorConnection tensor_connection = 5;

public final com.google.protobuf.UnknownFieldSet getUnknownFields ()

public boolean hasRunOptions () 

 Options that will be applied to each run.
.tensorflow.RunOptions run_options = 4;

public int hashCode ()

public final boolean isInitialized ()

public static CallableOptions.Builder newBuilder ()

public static CallableOptions.Builder newBuilder (CallableOptions prototype)

public CallableOptions.Builder newBuilderForType ()

public static CallableOptions parseDelimitedFrom (InputStream input)

Throws
IOException

public static CallableOptions parseDelimitedFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static CallableOptions parseFrom (ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static CallableOptions parseFrom (com.google.protobuf.CodedInputStream input)

Throws
IOException

public static CallableOptions parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static CallableOptions parseFrom (ByteBuffer data)

Throws
InvalidProtocolBufferException

public static CallableOptions parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static CallableOptions parseFrom (com.google.protobuf.ByteString data)

Throws
InvalidProtocolBufferException

public static CallableOptions parseFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static CallableOptions parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static parser ()

public CallableOptions.Builder toBuilder ()

public void writeTo (com.google.protobuf.CodedOutputStream output)

Throws
IOException