Class GPUOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.GPUOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, GPUOptionsOrBuilder

public final class GPUOptions
extends GeneratedMessageV3
implements GPUOptionsOrBuilder

Protobuf type tensorflow.GPUOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GPUOptions.Builder	Protobuf type tensorflow.GPUOptions
static final class	GPUOptions.Experimental	Protobuf type tensorflow.GPUOptions.Experimental
static interface	GPUOptions.ExperimentalOrBuilder

Nested classes/interfaces inherited from class GeneratedMessageV3

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

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALLOCATOR_TYPE_FIELD_NUMBER
static final int	ALLOW_GROWTH_FIELD_NUMBER
static final int	DEFERRED_DELETION_BYTES_FIELD_NUMBER
static final int	EXPERIMENTAL_FIELD_NUMBER
static final int	FORCE_GPU_COMPATIBLE_FIELD_NUMBER
static final int	PER_PROCESS_GPU_MEMORY_FRACTION_FIELD_NUMBER
static final int	POLLING_ACTIVE_DELAY_USECS_FIELD_NUMBER
static final int	POLLING_INACTIVE_DELAY_MSECS_FIELD_NUMBER
static final int	VISIBLE_DEVICE_LIST_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAllocatorType()	The type of GPU allocation strategy to use.
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 final 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.
Parser<GPUOptions>	getParserForType()
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.
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()
final UnknownFieldSet	getUnknownFields()
String	getVisibleDeviceList()	A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.
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 GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static GPUOptions.Builder	newBuilder()
static GPUOptions.Builder	newBuilder(GPUOptions prototype)
GPUOptions.Builder	newBuilderForType()
protected GPUOptions.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static GPUOptions	parseDelimitedFrom(InputStream input)
static GPUOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static GPUOptions	parseFrom(byte[] data)
static GPUOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static GPUOptions	parseFrom(ByteString data)
static GPUOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static GPUOptions	parseFrom(CodedInputStream input)
static GPUOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static GPUOptions	parseFrom(InputStream input)
static GPUOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static GPUOptions	parseFrom(ByteBuffer data)
static GPUOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<GPUOptions>	parser()
GPUOptions.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

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

Methods inherited from class AbstractMessageLite

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

Methods inherited from class Object

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

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

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 Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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:

getPerProcessGpuMemoryFraction in interface GPUOptionsOrBuilder

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 interface GPUOptionsOrBuilder

Returns:

The allowGrowth.

getAllocatorType

public 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 interface GPUOptionsOrBuilder

Returns:

The allocatorType.

getAllocatorTypeBytes

public 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 interface GPUOptionsOrBuilder

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 interface GPUOptionsOrBuilder

Returns:

The deferredDeletionBytes.

getVisibleDeviceList

public 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 interface GPUOptionsOrBuilder

Returns:

The visibleDeviceList.

getVisibleDeviceListBytes

public 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 interface GPUOptionsOrBuilder

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 interface GPUOptionsOrBuilder

Returns:

The pollingActiveDelayUsecs.

getPollingInactiveDelayMsecs

public int getPollingInactiveDelayMsecs()

This field is deprecated and ignored.

int32 polling_inactive_delay_msecs = 7;

Specified by:

getPollingInactiveDelayMsecs in interface GPUOptionsOrBuilder

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 interface GPUOptionsOrBuilder

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:

hasExperimental in interface GPUOptionsOrBuilder

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.

.tensorflow.GPUOptions.Experimental experimental = 9;

Specified by:

getExperimental in interface GPUOptionsOrBuilder

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.

.tensorflow.GPUOptions.Experimental experimental = 9;

Specified by:

getExperimentalOrBuilder in interface GPUOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static GPUOptions parseFrom(ByteBuffer data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static GPUOptions parseFrom(ByteString data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static GPUOptions parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static GPUOptions parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static GPUOptions parseFrom(CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GPUOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static GPUOptions.Builder newBuilder()

newBuilder

public static GPUOptions.Builder newBuilder(GPUOptions prototype)

toBuilder

public GPUOptions.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected GPUOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static GPUOptions getDefaultInstance()

parser

public static Parser<GPUOptions> parser()

getParserForType

public Parser<GPUOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public GPUOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder