org.bytedeco.onnxruntime

Class OrtROCMProviderOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.onnxruntime.OrtROCMProviderOptions

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=onnxruntime.class)
public class OrtROCMProviderOptions
extends Pointer

\brief ROCM Provider Options

See Also:

OrtApi::SessionOptionsAppendExecutionProvider_ROCM

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OrtROCMProviderOptions()
OrtROCMProviderOptions(long size) Native array allocator.
OrtROCMProviderOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	arena_extend_strategy() \brief Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
OrtROCMProviderOptions	arena_extend_strategy(int setter)
OrtArenaCfg	default_memory_arena_cfg() \brief ROCM memory arena configuration parameters
OrtROCMProviderOptions	default_memory_arena_cfg(OrtArenaCfg setter)
int	device_id() \brief ROCM device Id Defaults to 0.
OrtROCMProviderOptions	device_id(int setter)
int	do_copy_in_default_stream() \brief Flag indicating if copying needs to take place on the same stream as the compute stream in the ROCM EP 0 = Use separate streams for copying and compute.
OrtROCMProviderOptions	do_copy_in_default_stream(int setter)
int	enable_hip_graph()
OrtROCMProviderOptions	enable_hip_graph(int setter)
OrtROCMProviderOptions	getPointer(long i)
long	gpu_mem_limit() \brief ROCM memory limit (To use all possible memory pass in maximum size_t) Defaults to SIZE_MAX.
OrtROCMProviderOptions	gpu_mem_limit(long setter)
int	has_user_compute_stream() \brief Flag indicating if there is a user provided compute stream Defaults to 0.
OrtROCMProviderOptions	has_user_compute_stream(int setter)
int	miopen_conv_exhaustive_search() \brief ROCM MIOpen Convolution algorithm exaustive search option.
OrtROCMProviderOptions	miopen_conv_exhaustive_search(int setter)
OrtROCMProviderOptions	position(long position)
int	tunable_op_enable() \brief Enable TunableOp for using.
OrtROCMProviderOptions	tunable_op_enable(int setter)
int	tunable_op_max_tuning_duration_ms() \brief Max tuning duration time limit for each instance of TunableOp.
OrtROCMProviderOptions	tunable_op_max_tuning_duration_ms(int setter)
int	tunable_op_tuning_enable() \brief Enable TunableOp for tuning.
OrtROCMProviderOptions	tunable_op_tuning_enable(int setter)
Pointer	user_compute_stream() \brief User provided compute stream.
OrtROCMProviderOptions	user_compute_stream(Pointer setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

OrtROCMProviderOptions

public OrtROCMProviderOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

OrtROCMProviderOptions

public OrtROCMProviderOptions(long size)

Native array allocator. Access with Pointer.position(long).

OrtROCMProviderOptions

public OrtROCMProviderOptions()

Method Detail

position

public OrtROCMProviderOptions position(long position)

Overrides:

position in class Pointer

getPointer

public OrtROCMProviderOptions getPointer(long i)

Overrides:

getPointer in class Pointer

device_id

public int device_id()

\brief ROCM device Id Defaults to 0.

device_id

public OrtROCMProviderOptions device_id(int setter)

miopen_conv_exhaustive_search

public int miopen_conv_exhaustive_search()

\brief ROCM MIOpen Convolution algorithm exaustive search option. Defaults to 0 (false).

miopen_conv_exhaustive_search

public OrtROCMProviderOptions miopen_conv_exhaustive_search(int setter)

gpu_mem_limit

@Cast(value="size_t")
public long gpu_mem_limit()

\brief ROCM memory limit (To use all possible memory pass in maximum size_t) Defaults to SIZE_MAX. \note If a ::OrtArenaCfg has been applied, it will override this field

gpu_mem_limit

public OrtROCMProviderOptions gpu_mem_limit(long setter)

arena_extend_strategy

public int arena_extend_strategy()

\brief Strategy used to grow the memory arena 0 = kNextPowerOfTwo
1 = kSameAsRequested
Defaults to 0. \note If a ::OrtArenaCfg has been applied, it will override this field

arena_extend_strategy

public OrtROCMProviderOptions arena_extend_strategy(int setter)

do_copy_in_default_stream

public int do_copy_in_default_stream()

\brief Flag indicating if copying needs to take place on the same stream as the compute stream in the ROCM EP 0 = Use separate streams for copying and compute. 1 = Use the same stream for copying and compute. Defaults to 1. WARNING: Setting this to 0 may result in data races for some models. Please see issue #4829 for more details.

do_copy_in_default_stream

public OrtROCMProviderOptions do_copy_in_default_stream(int setter)

has_user_compute_stream

public int has_user_compute_stream()

\brief Flag indicating if there is a user provided compute stream Defaults to 0.

has_user_compute_stream

public OrtROCMProviderOptions has_user_compute_stream(int setter)

user_compute_stream

public Pointer user_compute_stream()

\brief User provided compute stream. If provided, please set has_user_compute_stream to 1.

user_compute_stream

public OrtROCMProviderOptions user_compute_stream(Pointer setter)

default_memory_arena_cfg

public OrtArenaCfg default_memory_arena_cfg()

\brief ROCM memory arena configuration parameters

default_memory_arena_cfg

public OrtROCMProviderOptions default_memory_arena_cfg(OrtArenaCfg setter)

enable_hip_graph

public int enable_hip_graph()

enable_hip_graph

public OrtROCMProviderOptions enable_hip_graph(int setter)

tunable_op_enable

public int tunable_op_enable()

\brief Enable TunableOp for using. Set it to 1/0 to enable/disable TunableOp. Otherwise, it is disabled by default. This option can be overridden by environment variable ORT_ROCM_TUNABLE_OP_ENABLE.

tunable_op_enable

public OrtROCMProviderOptions tunable_op_enable(int setter)

tunable_op_tuning_enable

public int tunable_op_tuning_enable()

\brief Enable TunableOp for tuning. Set it to 1/0 to enable/disable TunableOp tuning. Otherwise, it is disabled by default. This option can be overridden by environment variable ORT_ROCM_TUNABLE_OP_TUNING_ENABLE.

tunable_op_tuning_enable

public OrtROCMProviderOptions tunable_op_tuning_enable(int setter)

tunable_op_max_tuning_duration_ms

public int tunable_op_max_tuning_duration_ms()

\brief Max tuning duration time limit for each instance of TunableOp. Defaults to 0 to disable the limit.

tunable_op_max_tuning_duration_ms

public OrtROCMProviderOptions tunable_op_max_tuning_duration_ms(int setter)