Package org.platanios.tensorflow.proto
Class GPUOptions
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.platanios.tensorflow.proto.GPUOptions
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
,GPUOptionsOrBuilder
public final class GPUOptions extends com.google.protobuf.GeneratedMessageV3 implements GPUOptionsOrBuilder
Protobuf typeorg.platanios.tensorflow.proto.GPUOptions
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GPUOptions.Builder
Protobuf typeorg.platanios.tensorflow.proto.GPUOptions
static class
GPUOptions.Experimental
Protobuf typeorg.platanios.tensorflow.proto.GPUOptions.Experimental
static interface
GPUOptions.ExperimentalOrBuilder
-
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
ALLOCATOR_TYPE_FIELD_NUMBER
static int
ALLOW_GROWTH_FIELD_NUMBER
static int
DEFERRED_DELETION_BYTES_FIELD_NUMBER
static int
EXPERIMENTAL_FIELD_NUMBER
static int
FORCE_GPU_COMPATIBLE_FIELD_NUMBER
static int
PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER
static int
POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER
static int
POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER
static int
VISIBLE_DEVICE_LIST_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getAllocatorType()
The type of GPU allocation strategy to use.com.google.protobuf.ByteString
getAllocatorTypeBytes()
The type of GPU allocation strategy to use.boolean
getAllowGrowth()
If true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.static GPUOptions
getDefaultInstance()
GPUOptions
getDefaultInstanceForType()
long
getDeferredDeletionBytes()
Delay deletion of up to this many bytes to reduce the number of interactions with gpu driver code.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
GPUOptions.Experimental
getExperimental()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.GPUOptions.ExperimentalOrBuilder
getExperimentalOrBuilder()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.boolean
getForceGpuCompatible()
Force all tensors to be gpu_compatible.com.google.protobuf.Parser<GPUOptions>
getParserForType()
double
getPerProcessGpuMemoryFraction()
Fraction of the available GPU memory to allocate for each process.int
getPollingActiveDelayUsecs()
In the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty.int
getPollingInactiveDelayMsecs()
This field is deprecated and ignored.int
getSerializedSize()
com.google.protobuf.UnknownFieldSet
getUnknownFields()
java.lang.String
getVisibleDeviceList()
A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.com.google.protobuf.ByteString
getVisibleDeviceListBytes()
A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.boolean
hasExperimental()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static GPUOptions.Builder
newBuilder()
static GPUOptions.Builder
newBuilder(GPUOptions prototype)
GPUOptions.Builder
newBuilderForType()
protected GPUOptions.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GPUOptions
parseDelimitedFrom(java.io.InputStream input)
static GPUOptions
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GPUOptions
parseFrom(byte[] data)
static GPUOptions
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GPUOptions
parseFrom(com.google.protobuf.ByteString data)
static GPUOptions
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GPUOptions
parseFrom(com.google.protobuf.CodedInputStream input)
static GPUOptions
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GPUOptions
parseFrom(java.io.InputStream input)
static GPUOptions
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GPUOptions
parseFrom(java.nio.ByteBuffer data)
static GPUOptions
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GPUOptions>
parser()
GPUOptions.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, internalGetMapField, 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
-
PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER
public static final int PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALLOW_GROWTH_FIELD_NUMBER
public static final int ALLOW_GROWTH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALLOCATOR_TYPE_FIELD_NUMBER
public static final int ALLOCATOR_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEFERRED_DELETION_BYTES_FIELD_NUMBER
public static final int DEFERRED_DELETION_BYTES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VISIBLE_DEVICE_LIST_FIELD_NUMBER
public static final int VISIBLE_DEVICE_LIST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER
public static final int POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER
public static final int POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FORCE_GPU_COMPATIBLE_FIELD_NUMBER
public static final int FORCE_GPU_COMPATIBLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXPERIMENTAL_FIELD_NUMBER
public static final int EXPERIMENTAL_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()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getPerProcessGpuMemoryFraction
public double getPerProcessGpuMemoryFraction()
Fraction of the available GPU memory to allocate for each process. 1 means to allocate all of the GPU memory, 0.5 means the process allocates up to ~50% of the available GPU memory. GPU memory is pre-allocated unless the allow_growth option is enabled. If greater than 1.0, uses CUDA unified memory to potentially oversubscribe the amount of memory available on the GPU device by using host memory as a swap space. Accessing memory not available on the device will be significantly slower as that would require memory transfer between the host and the device. Options to reduce the memory requirement should be considered before enabling this option as this may come with a negative performance impact. Oversubscription using the unified memory requires Pascal class or newer GPUs and it is currently only supported on the Linux operating system. See https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#um-requirements for the detailed requirements.
double per_process_gpu_memory_fraction = 1;
- Specified by:
getPerProcessGpuMemoryFraction
in interfaceGPUOptionsOrBuilder
- Returns:
- The perProcessGpuMemoryFraction.
-
getAllowGrowth
public boolean getAllowGrowth()
If true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.
bool allow_growth = 4;
- Specified by:
getAllowGrowth
in interfaceGPUOptionsOrBuilder
- Returns:
- The allowGrowth.
-
getAllocatorType
public java.lang.String getAllocatorType()
The type of GPU allocation strategy to use. Allowed values: "": The empty string (default) uses a system-chosen default which may change over time. "BFC": A "Best-fit with coalescing" algorithm, simplified from a version of dlmalloc.
string allocator_type = 2;
- Specified by:
getAllocatorType
in interfaceGPUOptionsOrBuilder
- Returns:
- The allocatorType.
-
getAllocatorTypeBytes
public com.google.protobuf.ByteString getAllocatorTypeBytes()
The type of GPU allocation strategy to use. Allowed values: "": The empty string (default) uses a system-chosen default which may change over time. "BFC": A "Best-fit with coalescing" algorithm, simplified from a version of dlmalloc.
string allocator_type = 2;
- Specified by:
getAllocatorTypeBytes
in interfaceGPUOptionsOrBuilder
- Returns:
- The bytes for allocatorType.
-
getDeferredDeletionBytes
public long getDeferredDeletionBytes()
Delay deletion of up to this many bytes to reduce the number of interactions with gpu driver code. If 0, the system chooses a reasonable default (several MBs).
int64 deferred_deletion_bytes = 3;
- Specified by:
getDeferredDeletionBytes
in interfaceGPUOptionsOrBuilder
- Returns:
- The deferredDeletionBytes.
-
getVisibleDeviceList
public java.lang.String getVisibleDeviceList()
A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices. For example, if TensorFlow can see 8 GPU devices in the process, and one wanted to map visible GPU devices 5 and 3 as "/device:GPU:0", and "/device:GPU:1", then one would specify this field as "5,3". This field is similar in spirit to the CUDA_VISIBLE_DEVICES environment variable, except it applies to the visible GPU devices in the process. NOTE: 1. The GPU driver provides the process with the visible GPUs in an order which is not guaranteed to have any correlation to the *physical* GPU id in the machine. This field is used for remapping "visible" to "virtual", which means this operates only after the process starts. Users are required to use vendor specific mechanisms (e.g., CUDA_VISIBLE_DEVICES) to control the physical to visible device mapping prior to invoking TensorFlow. 2. In the code, the ids in this list are also called "platform GPU id"s, and the 'virtual' ids of GPU devices (i.e. the ids in the device name "/device:GPU:<id>") are also called "TF GPU id"s. Please refer to third_party/tensorflow/core/common_runtime/gpu/gpu_id.h for more information.
string visible_device_list = 5;
- Specified by:
getVisibleDeviceList
in interfaceGPUOptionsOrBuilder
- Returns:
- The visibleDeviceList.
-
getVisibleDeviceListBytes
public com.google.protobuf.ByteString getVisibleDeviceListBytes()
A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices. For example, if TensorFlow can see 8 GPU devices in the process, and one wanted to map visible GPU devices 5 and 3 as "/device:GPU:0", and "/device:GPU:1", then one would specify this field as "5,3". This field is similar in spirit to the CUDA_VISIBLE_DEVICES environment variable, except it applies to the visible GPU devices in the process. NOTE: 1. The GPU driver provides the process with the visible GPUs in an order which is not guaranteed to have any correlation to the *physical* GPU id in the machine. This field is used for remapping "visible" to "virtual", which means this operates only after the process starts. Users are required to use vendor specific mechanisms (e.g., CUDA_VISIBLE_DEVICES) to control the physical to visible device mapping prior to invoking TensorFlow. 2. In the code, the ids in this list are also called "platform GPU id"s, and the 'virtual' ids of GPU devices (i.e. the ids in the device name "/device:GPU:<id>") are also called "TF GPU id"s. Please refer to third_party/tensorflow/core/common_runtime/gpu/gpu_id.h for more information.
string visible_device_list = 5;
- Specified by:
getVisibleDeviceListBytes
in interfaceGPUOptionsOrBuilder
- Returns:
- The bytes for visibleDeviceList.
-
getPollingActiveDelayUsecs
public int getPollingActiveDelayUsecs()
In the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty. If value is not set or set to 0, gets set to a non-zero default.
int32 polling_active_delay_usecs = 6;
- Specified by:
getPollingActiveDelayUsecs
in interfaceGPUOptionsOrBuilder
- Returns:
- The pollingActiveDelayUsecs.
-
getPollingInactiveDelayMsecs
public int getPollingInactiveDelayMsecs()
This field is deprecated and ignored.
int32 polling_inactive_delay_msecs = 7;
- Specified by:
getPollingInactiveDelayMsecs
in interfaceGPUOptionsOrBuilder
- Returns:
- The pollingInactiveDelayMsecs.
-
getForceGpuCompatible
public boolean getForceGpuCompatible()
Force all tensors to be gpu_compatible. On a GPU-enabled TensorFlow, enabling this option forces all CPU tensors to be allocated with Cuda pinned memory. Normally, TensorFlow will infer which tensors should be allocated as the pinned memory. But in case where the inference is incomplete, this option can significantly speed up the cross-device memory copy performance as long as it fits the memory. Note that this option is not something that should be enabled by default for unknown or very large models, since all Cuda pinned memory is unpageable, having too much pinned memory might negatively impact the overall host system performance.
bool force_gpu_compatible = 8;
- Specified by:
getForceGpuCompatible
in interfaceGPUOptionsOrBuilder
- Returns:
- The forceGpuCompatible.
-
hasExperimental
public boolean hasExperimental()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
.org.platanios.tensorflow.proto.GPUOptions.Experimental experimental = 9;
- Specified by:
hasExperimental
in interfaceGPUOptionsOrBuilder
- Returns:
- Whether the experimental field is set.
-
getExperimental
public GPUOptions.Experimental getExperimental()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
.org.platanios.tensorflow.proto.GPUOptions.Experimental experimental = 9;
- Specified by:
getExperimental
in interfaceGPUOptionsOrBuilder
- Returns:
- The experimental.
-
getExperimentalOrBuilder
public GPUOptions.ExperimentalOrBuilder getExperimentalOrBuilder()
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
.org.platanios.tensorflow.proto.GPUOptions.Experimental experimental = 9;
- Specified by:
getExperimentalOrBuilder
in interfaceGPUOptionsOrBuilder
-
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 GPUOptions parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GPUOptions parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static GPUOptions parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static GPUOptions parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GPUOptions parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GPUOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public GPUOptions.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static GPUOptions.Builder newBuilder()
-
newBuilder
public static GPUOptions.Builder newBuilder(GPUOptions prototype)
-
toBuilder
public GPUOptions.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected GPUOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static GPUOptions getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<GPUOptions> parser()
-
getParserForType
public com.google.protobuf.Parser<GPUOptions> 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 GPUOptions getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-