org.tensorflow.framework

Class GPUOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

org.tensorflow.framework.GPUOptions.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, GPUOptionsOrBuilder

Enclosing class:

GPUOptions

public static final class GPUOptions.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>
implements GPUOptionsOrBuilder

Protobuf type tensorflow.GPUOptions

Method Summary

Modifier and Type	Method and Description
GPUOptions.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GPUOptions	build()
GPUOptions	buildPartial()
GPUOptions.Builder	clear()
GPUOptions.Builder	clearAllocatorType() The type of GPU allocation strategy to use.
GPUOptions.Builder	clearAllowGrowth() If true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.
GPUOptions.Builder	clearDeferredDeletionBytes() Delay deletion of up to this many bytes to reduce the number of interactions with gpu driver code.
GPUOptions.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GPUOptions.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GPUOptions.Builder	clearPerProcessGpuMemoryFraction() A value between 0 and 1 that indicates what fraction of the available GPU memory to pre-allocate for each process.
GPUOptions.Builder	clearPollingActiveDelayUsecs() In the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty.
GPUOptions.Builder	clearPollingInactiveDelayMsecs() In the event polling loop sleep this many millisconds between PollEvents calls, when the queue is empty.
GPUOptions.Builder	clearVisibleDeviceList() A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.
GPUOptions.Builder	clone()
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.
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()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getPerProcessGpuMemoryFraction() A value between 0 and 1 that indicates what fraction of the available GPU memory to pre-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() In the event polling loop sleep this many millisconds between PollEvents calls, when the queue is empty.
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GPUOptions.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GPUOptions.Builder	mergeFrom(GPUOptions other)
GPUOptions.Builder	mergeFrom(com.google.protobuf.Message other)
GPUOptions.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GPUOptions.Builder	setAllocatorType(String value) The type of GPU allocation strategy to use.
GPUOptions.Builder	setAllocatorTypeBytes(com.google.protobuf.ByteString value) The type of GPU allocation strategy to use.
GPUOptions.Builder	setAllowGrowth(boolean value) If true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.
GPUOptions.Builder	setDeferredDeletionBytes(long value) Delay deletion of up to this many bytes to reduce the number of interactions with gpu driver code.
GPUOptions.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GPUOptions.Builder	setPerProcessGpuMemoryFraction(double value) A value between 0 and 1 that indicates what fraction of the available GPU memory to pre-allocate for each process.
GPUOptions.Builder	setPollingActiveDelayUsecs(int value) In the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty.
GPUOptions.Builder	setPollingInactiveDelayMsecs(int value) In the event polling loop sleep this many millisconds between PollEvents calls, when the queue is empty.
GPUOptions.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
GPUOptions.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GPUOptions.Builder	setVisibleDeviceList(String value) A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.
GPUOptions.Builder	setVisibleDeviceListBytes(com.google.protobuf.ByteString value) A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

clear

public GPUOptions.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

getDefaultInstanceForType

public GPUOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GPUOptions build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GPUOptions buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public GPUOptions.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

setField

public GPUOptions.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

clearField

public GPUOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

clearOneof

public GPUOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

setRepeatedField

public GPUOptions.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

addRepeatedField

public GPUOptions.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

mergeFrom

public GPUOptions.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GPUOptions.Builder>

mergeFrom

public GPUOptions.Builder mergeFrom(GPUOptions other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

mergeFrom

public GPUOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GPUOptions.Builder>

Throws:

IOException

getPerProcessGpuMemoryFraction

public double getPerProcessGpuMemoryFraction()

 A value between 0 and 1 that indicates what fraction of the
 available GPU memory to pre-allocate for each process.  1 means
 to pre-allocate all of the GPU memory, 0.5 means the process
 allocates ~50% of the available GPU memory.
 

double per_process_gpu_memory_fraction = 1;

Specified by:

getPerProcessGpuMemoryFraction in interface GPUOptionsOrBuilder

setPerProcessGpuMemoryFraction

public GPUOptions.Builder setPerProcessGpuMemoryFraction(double value)

 A value between 0 and 1 that indicates what fraction of the
 available GPU memory to pre-allocate for each process.  1 means
 to pre-allocate all of the GPU memory, 0.5 means the process
 allocates ~50% of the available GPU memory.
 

double per_process_gpu_memory_fraction = 1;

clearPerProcessGpuMemoryFraction

public GPUOptions.Builder clearPerProcessGpuMemoryFraction()

 A value between 0 and 1 that indicates what fraction of the
 available GPU memory to pre-allocate for each process.  1 means
 to pre-allocate all of the GPU memory, 0.5 means the process
 allocates ~50% of the available GPU memory.
 

double per_process_gpu_memory_fraction = 1;

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

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

setAllocatorType

public GPUOptions.Builder setAllocatorType(String value)

 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;

clearAllocatorType

public GPUOptions.Builder clearAllocatorType()

 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;

setAllocatorTypeBytes

public GPUOptions.Builder setAllocatorTypeBytes(com.google.protobuf.ByteString value)

 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;

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

setDeferredDeletionBytes

public GPUOptions.Builder setDeferredDeletionBytes(long value)

 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;

clearDeferredDeletionBytes

public GPUOptions.Builder clearDeferredDeletionBytes()

 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;

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

setAllowGrowth

public GPUOptions.Builder setAllowGrowth(boolean value)

 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;

clearAllowGrowth

public GPUOptions.Builder clearAllowGrowth()

 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;

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 "/gpu:0", and "/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: 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.
 

string visible_device_list = 5;

Specified by:

getVisibleDeviceList in interface GPUOptionsOrBuilder

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 "/gpu:0", and "/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: 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.
 

string visible_device_list = 5;

Specified by:

getVisibleDeviceListBytes in interface GPUOptionsOrBuilder

setVisibleDeviceList

public GPUOptions.Builder setVisibleDeviceList(String value)

 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 "/gpu:0", and "/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: 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.
 

string visible_device_list = 5;

clearVisibleDeviceList

public GPUOptions.Builder clearVisibleDeviceList()

 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 "/gpu:0", and "/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: 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.
 

string visible_device_list = 5;

setVisibleDeviceListBytes

public GPUOptions.Builder setVisibleDeviceListBytes(com.google.protobuf.ByteString value)

 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 "/gpu:0", and "/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: 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.
 

string visible_device_list = 5;

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

setPollingActiveDelayUsecs

public GPUOptions.Builder setPollingActiveDelayUsecs(int value)

 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;

clearPollingActiveDelayUsecs

public GPUOptions.Builder clearPollingActiveDelayUsecs()

 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;

getPollingInactiveDelayMsecs

public int getPollingInactiveDelayMsecs()

 In the event polling loop sleep this many millisconds between
 PollEvents calls, when the queue is empty.  If value is not
 set or set to 0, gets set to a non-zero default.
 

int32 polling_inactive_delay_msecs = 7;

Specified by:

getPollingInactiveDelayMsecs in interface GPUOptionsOrBuilder

setPollingInactiveDelayMsecs

public GPUOptions.Builder setPollingInactiveDelayMsecs(int value)

 In the event polling loop sleep this many millisconds between
 PollEvents calls, when the queue is empty.  If value is not
 set or set to 0, gets set to a non-zero default.
 

int32 polling_inactive_delay_msecs = 7;

clearPollingInactiveDelayMsecs

public GPUOptions.Builder clearPollingInactiveDelayMsecs()

 In the event polling loop sleep this many millisconds between
 PollEvents calls, when the queue is empty.  If value is not
 set or set to 0, gets set to a non-zero default.
 

int32 polling_inactive_delay_msecs = 7;

setUnknownFields

public final GPUOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>

mergeUnknownFields

public final GPUOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GPUOptions.Builder>