Package org.tensorflow.framework
Class GPUOptions
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.framework.GPUOptions
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable,GPUOptionsOrBuilder
public final class GPUOptions
extends com.google.protobuf.GeneratedMessageV3
implements GPUOptionsOrBuilder
Protobuf type
tensorflow.GPUOptions- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typetensorflow.GPUOptionsstatic final classProtobuf typetensorflow.GPUOptions.Experimentalstatic interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe type of GPU allocation strategy to use.com.google.protobuf.ByteStringThe type of GPU allocation strategy to use.booleanIf true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.static GPUOptionslongDelay deletion of up to this many bytes to reduce the number of interactions with gpu driver code.static final com.google.protobuf.Descriptors.DescriptorEverything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.booleanForce all tensors to be gpu_compatible.com.google.protobuf.Parser<GPUOptions> doubleFraction of the total 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 total GPU memory.intIn the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty.intThis field is deprecated and ignored.intA comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.com.google.protobuf.ByteStringA comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.booleanEverything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic GPUOptions.Builderstatic GPUOptions.BuildernewBuilder(GPUOptions prototype) protected GPUOptions.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static GPUOptionsparseDelimitedFrom(InputStream input) static GPUOptionsparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static GPUOptionsparseFrom(byte[] data) static GPUOptionsparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static GPUOptionsparseFrom(com.google.protobuf.ByteString data) static GPUOptionsparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static GPUOptionsparseFrom(com.google.protobuf.CodedInputStream input) static GPUOptionsparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static GPUOptionsparseFrom(InputStream input) static GPUOptionsparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static GPUOptionsparseFrom(ByteBuffer data) static GPUOptionsparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<GPUOptions> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER
public static final int PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER- See Also:
-
ALLOW_GROWTH_FIELD_NUMBER
public static final int ALLOW_GROWTH_FIELD_NUMBER- See Also:
-
ALLOCATOR_TYPE_FIELD_NUMBER
public static final int ALLOCATOR_TYPE_FIELD_NUMBER- See Also:
-
DEFERRED_DELETION_BYTES_FIELD_NUMBER
public static final int DEFERRED_DELETION_BYTES_FIELD_NUMBER- See Also:
-
VISIBLE_DEVICE_LIST_FIELD_NUMBER
public static final int VISIBLE_DEVICE_LIST_FIELD_NUMBER- See Also:
-
POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER
public static final int POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER- See Also:
-
POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER
public static final int POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER- See Also:
-
FORCE_GPU_COMPATIBLE_FIELD_NUMBER
public static final int FORCE_GPU_COMPATIBLE_FIELD_NUMBER- See Also:
-
EXPERIMENTAL_FIELD_NUMBER
public static final int EXPERIMENTAL_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getPerProcessGpuMemoryFraction
public double getPerProcessGpuMemoryFraction()Fraction of the total 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 total 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:
getPerProcessGpuMemoryFractionin 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:
getAllowGrowthin interfaceGPUOptionsOrBuilder- Returns:
- The allowGrowth.
-
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:
getAllocatorTypein 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:
getAllocatorTypeBytesin 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:
getDeferredDeletionBytesin interfaceGPUOptionsOrBuilder- Returns:
- The deferredDeletionBytes.
-
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. 3. The visible_device_list is also used for PluggableDevice. And different types of PluggableDevices share this field. In that case, the pluggable_device_type is used to distinguish them, making the visible_device_list a list of <pluggable_device_type>:<device_index>, e.g. "PluggableDeviceA:0,PluggableDeviceA:1,PluggableDeviceB:0".string visible_device_list = 5;- Specified by:
getVisibleDeviceListin 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. 3. The visible_device_list is also used for PluggableDevice. And different types of PluggableDevices share this field. In that case, the pluggable_device_type is used to distinguish them, making the visible_device_list a list of <pluggable_device_type>:<device_index>, e.g. "PluggableDeviceA:0,PluggableDeviceA:1,PluggableDeviceB:0".string visible_device_list = 5;- Specified by:
getVisibleDeviceListBytesin 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:
getPollingActiveDelayUsecsin interfaceGPUOptionsOrBuilder- Returns:
- The pollingActiveDelayUsecs.
-
getPollingInactiveDelayMsecs
public int getPollingInactiveDelayMsecs()This field is deprecated and ignored.
int32 polling_inactive_delay_msecs = 7;- Specified by:
getPollingInactiveDelayMsecsin 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:
getForceGpuCompatiblein 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.
.tensorflow.GPUOptions.Experimental experimental = 9;- Specified by:
hasExperimentalin interfaceGPUOptionsOrBuilder- Returns:
- Whether the experimental field is set.
-
getExperimental
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
.tensorflow.GPUOptions.Experimental experimental = 9;- Specified by:
getExperimentalin interfaceGPUOptionsOrBuilder- Returns:
- The experimental.
-
getExperimentalOrBuilder
Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.
.tensorflow.GPUOptions.Experimental experimental = 9;- Specified by:
getExperimentalOrBuilderin interfaceGPUOptionsOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static GPUOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GPUOptions parseFrom(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
- Throws:
IOException
-
parseFrom
public static GPUOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static GPUOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static GPUOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected GPUOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-