ONNX Runtime Go

https://pkg.go.dev/github.com/yalue/onnxruntime_go
Admin
A cross-platform Go wrapper for the ONNX Runtime C library that enables loading and executing neural...
Tokens:62,370
Snippets:586
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### func GetInputOutputInfo(path string) ([]InputOutputInfo, []InputOutputInfo, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Takes a path to a .onnx file, and returns a list of inputs and a list of outputs, respectively. Will open, read, and close the .onnx file to get the information.

```APIDOC
## func GetInputOutputInfo

### Description
Takes a path to a .onnx file, and returns a list of inputs and a list of outputs, respectively. Will open, read, and close the .onnx file to get the information. InitializeEnvironment() must have been called prior to using this function. Warning: this function requires loading the .onnx file into a temporary onnxruntime session, which may be an expensive operation. For now, this may fail if the network has any non-tensor inputs or inputs that don't have a concrete shape and type.

### Function Signature
`func GetInputOutputInfo(path string) ([]InputOutputInfo, []InputOutputInfo, error)`

### Parameters
- **path** (string) - Required - The path to the .onnx file.

### Return Value
- **[]InputOutputInfo** - A list of input information.
- **[]InputOutputInfo** - A list of output information.
- **error** - Returns an error if the operation fails.
```

--------------------------------

### GetInputOutputNames

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Gets the input and output names for a training model.

```APIDOC
## GetInputOutputNames

### Description
Gets the input and output names for a training model.

### Method
GetInputOutputNames

### Signature
func GetInputOutputNames(checkpointStatePath string, trainingModelPath string, evalModelPath string) (*TrainingInputOutputNames, error)

### Parameters
- **checkpointStatePath** (string) - Required - Path to the checkpoint state.
- **trainingModelPath** (string) - Required - Path to the training model.
- **evalModelPath** (string) - Required - Path to the evaluation model.

### Returns
- **TrainingInputOutputNames** - The input and output names.
- **error** - An error if retrieval fails.
```

--------------------------------

### func NewMemoryInfo(name string, allocatorType AllocatorType, deviceID int, memType MemType) (*MemoryInfo, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a MemoryInfo referring to the named memory location; for example, NewMemoryInfo("Cuda", AllocatorTypeDevice, 0, MemTypeDefault) refers to the memory of the first CUDA device. The returned MemoryInfo must be freed using Destroy when no longer needed.

```APIDOC
## func NewMemoryInfo(name string, allocatorType AllocatorType, deviceID int, memType MemType) (*MemoryInfo, error)

### Description
Creates a MemoryInfo referring to the named memory location; for example, NewMemoryInfo("Cuda", AllocatorTypeDevice, 0, MemTypeDefault) refers to the memory of the first CUDA device. The known location names are defined by onnxruntime and its execution providers. The returned MemoryInfo must be freed using Destroy when no longer needed.

### Method
func

### Endpoint
NewMemoryInfo(name string, allocatorType AllocatorType, deviceID int, memType MemType) (*MemoryInfo, error)

### Parameters
- **name** (string) - Required - The name of the memory location.
- **allocatorType** (AllocatorType) - Required - The type of allocator.
- **deviceID** (int) - Required - The device ID.
- **memType** (MemType) - Required - The memory type.

### Returns
- **(*MemoryInfo, error)** - A new MemoryInfo instance and an error if creation fails.
```

--------------------------------

### Load and run an ONNX network with onnxruntime_go

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Loads an ONNX model with a single input and output tensor of float32 values. Sets the shared library path explicitly, initializes the environment, creates input and output tensors before the session, runs the session, and reads the output data. Error handling is omitted for brevity; each function returns an error that is non-nil on failure.

```go
import (
    "fmt"
    ort "github.com/yalue/onnxruntime_go"
    "os"
)

func main() {
    // This line _may_ be optional; by default the library will try to load
    // "onnxruntime.dll" on Windows, and "onnxruntime.so" on any other system.
    // For stability, programs should always set this explicitly.
    ort.SetSharedLibraryPath("path/to/onnxruntime.so")

    err := ort.InitializeEnvironment()
    if err != nil {
        panic(err)
    }
    defer ort.DestroyEnvironment()

    // For a slight performance boost and convenience when re-using existing
    // tensors, this library expects the user to create all input and output
    // tensors prior to creating the session. If this isn't ideal for your use
    // case, see the DynamicAdvancedSession type in the documnentation, which
    // allows input and output tensors to be specified when calling Run()
    // rather than when initializing a session.
    inputData := []float32{0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9}
    inputShape := ort.NewShape(2, 5)
    inputTensor, err := ort.NewTensor(inputShape, inputData)
    defer inputTensor.Destroy()
    // This hypothetical network maps a 2x5 input -> 2x3x4 output.
    outputShape := ort.NewShape(2, 3, 4)
    outputTensor, err := ort.NewEmptyTensor[float32](outputShape)
    defer outputTensor.Destroy()

    session, err := ort.NewAdvancedSession("path/to/network.onnx",
        []string{"Input 1 Name"}, []string{"Output 1 Name"},
        []ort.Value{inputTensor}, []ort.Value{outputTensor}, nil)
    defer session.Destroy()

    // Calling Run() will run the network, reading the current contents of the
    // input tensors and modifying the contents of the output tensors.
    err = session.Run()

    // Get a slice view of the output tensor's data.
    outputData := outputTensor.GetData()

    // If you want to run the network on a different input, all you need to do
    // is modify the input tensor data (available via inputTensor.GetData())
    // and call Run() again.

    // ...
}
```

--------------------------------

### SessionOptions.GetSessionConfigEntry

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Gets the value of a session configuration entry.

```APIDOC
## SessionOptions.GetSessionConfigEntry

### Description
Gets the value of a session configuration entry.

### Method
GetSessionConfigEntry

### Signature
func (o *SessionOptions) GetSessionConfigEntry(key string) (string, error)

### Parameters
- **key** (string) - Required - The configuration key.

### Returns
- **string** - The value of the configuration entry.
- **error** - An error if the operation fails.
```

--------------------------------

### func GetInputOutputInfoWithOptions(path string, options *SessionOptions) ([]InputOutputInfo, []InputOutputInfo, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Identical in behavior to GetInputOutputInfo, but additionally takes session options to handle models that require options to load.

```APIDOC
## func GetInputOutputInfoWithOptions

### Description
Identical in behavior to GetInputOutputInfo, but additionally takes session options to handle models that require options to load.

### Function Signature
`func GetInputOutputInfoWithOptions(path string, options *SessionOptions) ([]InputOutputInfo, []InputOutputInfo, error)`

### Parameters
- **path** (string) - Required - The path to the .onnx file.
- **options** (*SessionOptions) - Required - Session options for loading the model.

### Return Value
- **[]InputOutputInfo** - A list of input information.
- **[]InputOutputInfo** - A list of output information.
- **error** - Returns an error if the operation fails.
```

--------------------------------

### func InitializeEnvironment(opts ...EnvironmentOption) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Initializes the ONNX Runtime environment with optional logging options. Must be called before using most other functions.

```APIDOC
## func InitializeEnvironment(opts ...EnvironmentOption) error

### Description
Initializes the ONNX Runtime environment. Accepts optional EnvironmentOption values to configure logging levels.

### Signature
```go
func InitializeEnvironment(opts ...EnvironmentOption) error
```

### Parameters
- **opts** (EnvironmentOption) - Optional - Environment options for logging configuration.

### Returns
- **error** - Returns nil on success, or an error if initialization fails.
```

--------------------------------

### func (o *RunOptions) GetRunConfigEntry(key string) (string, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Gets a run configuration entry by key.

```APIDOC
## func (o *RunOptions) GetRunConfigEntry(key string) (string, error)

### Description
Retrieves the value of a run configuration entry.

### Signature
`func (o *RunOptions) GetRunConfigEntry(key string) (string, error)`

### Parameters
- **key** (string) - The configuration key.

### Returns
- **string** - The configuration value.
- **error** - An error if retrieval fails.
```

--------------------------------

### Tensor.GetData

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns the slice containing the tensor's underlying data. The contents can be read or written to get or set the tensor's contents.

```APIDOC
## Tensor.GetData

### Description
Returns the slice containing the tensor's underlying data. The contents of the slice can be read or written to get or set the tensor's contents.

### Function Signature
func (t *Tensor[T]) GetData() []T

### Returns
- **[]T** - The underlying data slice.

```

--------------------------------

### NewTrainingSession

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new training session.

```APIDOC
## NewTrainingSession

### Description
Creates a new training session.

### Method
NewTrainingSession

### Signature
func NewTrainingSession(...) (*TrainingSession, error)

### Returns
- **TrainingSession** - The new training session.
- **error** - An error if creation fails.
```

--------------------------------

### func GetEpDevices() ([]EpDevice, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns a list of available execution provider devices.

```APIDOC
## func GetEpDevices() ([]EpDevice, error)

### Description
Retrieves the list of execution provider devices available in the ONNX Runtime environment.

### Signature
`func GetEpDevices() ([]EpDevice, error)`

### Returns
- **[]EpDevice** - A slice of EpDevice structs representing available devices.
- **error** - An error if the operation fails.
```

--------------------------------

### func (*StringTensor) GetContents

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns all contents of the string tensor, in order by flattened index. If you need to get all contents in the tensor, this should be more efficient than using GetElement(...) to retrieve all strings individually. This copies the tensor's contents; modifying the returned slice will not modify the tensor.

```APIDOC
## func (*StringTensor) GetContents

### Description
Returns all contents of the string tensor, in order by flattened index. If you need to get all contents in the tensor, this should be more efficient than using GetElement(...) to retrieve all strings individually. This copies the tensor's contents; modifying the returned slice will not modify the tensor.

### Method
FUNCTION

### Endpoint
GetContents

### Parameters
None.

### Response
- **[]string** - The contents of the tensor.
- **error** - Returns an error if retrieval fails.
```

--------------------------------

### func IsTrainingSupported() bool

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Always returns false.

```APIDOC
## func IsTrainingSupported

### Description
Always returns false.

### Function Signature
`func IsTrainingSupported() bool`

### Return Value
- **bool** - Always returns false.
```

--------------------------------

### func GetInputOutputInfoWithOptions(path string, options *SessionOptions) ([]InputOutputInfo, []InputOutputInfo, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Retrieves input and output information for an ONNX model file using custom session options.

```APIDOC
## func GetInputOutputInfoWithOptions(path string, options *SessionOptions) ([]InputOutputInfo, []InputOutputInfo, error)

### Description
Retrieves input and output information for an ONNX model file using custom session options.

### Signature
```go
func GetInputOutputInfoWithOptions(path string, options *SessionOptions) ([]InputOutputInfo, []InputOutputInfo, error)
```

### Parameters
- **path** (string) - Required - The file path to the ONNX model.
- **options** (*SessionOptions) - Required - Session options to use.

### Returns
- **[]InputOutputInfo** - List of input information.
- **[]InputOutputInfo** - List of output information.
- **error** - Returns nil on success, or an error if retrieval fails.
```

--------------------------------

### func (*Session[T]) Run() error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Runs the session with the configured inputs and outputs.

```APIDOC
## func (*Session[T]) Run

### Description
Runs the session with the configured inputs and outputs.

### Signature
func (s *Session[T]) Run() error

### Parameters
None

### Returns
- **error** - An error if the run fails.
```

--------------------------------

### GetEpDevices

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns the list of OrtEpDevice instances known to the runtime, including those from plugin execution providers.

```APIDOC
## GetEpDevices

### Description
GetEpDevices returns the list of OrtEpDevice instances known to the runtime, including those contributed by plugin execution providers loaded via RegisterExecutionProviderLibrary. The returned EpDevices remain valid until the corresponding plugin library is unregistered or the environment is destroyed.

### Signature
```go
func GetEpDevices() ([]EpDevice, error)
```

### Returns
- **([]EpDevice, error)** - A slice of EpDevice handles and an error if any.
```

--------------------------------

### NewLoraAdapterWithAllocator

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

The same as NewLoraAdapter, but takes an allocator to hold the adapter's parameters. Passing a device allocator, such as one returned by a session's CreateAllocator function, copies the parameters to the device once at load time rather than at each Run. Passing nil behaves like NewLoraAdapter. The allocator must not be destroyed before the returned LoraAdapter is.

```APIDOC
## func NewLoraAdapterWithAllocator

### Description
The same as NewLoraAdapter, but takes an allocator to hold the adapter's parameters. Passing a device allocator, such as one returned by a session's CreateAllocator function, copies the parameters to the device once at load time rather than at each Run. Passing nil behaves like NewLoraAdapter. The allocator must not be destroyed before the returned LoraAdapter is.

### Method
NewLoraAdapterWithAllocator

### Signature
func NewLoraAdapterWithAllocator(adapterFilePath string, allocator *Allocator) (*LoraAdapter, error)

### Parameters
- **adapterFilePath** (string) - Required - Path to the .onnx_adapter file.
- **allocator** (\*Allocator) - Optional - Allocator to hold the adapter's parameters. Passing nil behaves like NewLoraAdapter.

### Returns
- **\*LoraAdapter** - A new LoraAdapter instance.
- **error** - An error if loading fails.
```

--------------------------------

### NewTrainingSessionWithOnnxData

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new training session with ONNX data.

```APIDOC
## NewTrainingSessionWithOnnxData

### Description
Creates a new training session with ONNX data.

### Method
NewTrainingSessionWithOnnxData

### Signature
func NewTrainingSessionWithOnnxData(checkpointData, trainingData, evalData, optimizerData []byte, ...) (*TrainingSession, error)

### Parameters
- **checkpointData** ([]byte) - Required - Checkpoint data.
- **trainingData** ([]byte) - Required - Training data.
- **evalData** ([]byte) - Required - Evaluation data.
- **optimizerData** ([]byte) - Required - Optimizer data.

### Returns
- **TrainingSession** - The new training session.
- **error** - An error if creation fails.
```

--------------------------------

### func IsInitialized() bool

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns false if the onnxruntime package is not initialized.

```APIDOC
## func IsInitialized

### Description
Returns false if the onnxruntime package is not initialized. Called internally by several functions, to avoid segfaulting if InitializeEnvironment hasn't been called yet.

### Function Signature
`func IsInitialized() bool`

### Return Value
- **bool** - Returns true if the package is initialized, false otherwise.
```

--------------------------------

### func CreateAndRegisterAllocatorV2(providerType string, memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg, ...) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates and registers an allocator with additional options.

```APIDOC
## func CreateAndRegisterAllocatorV2(providerType string, memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg, ...) error

### Description
Creates and registers an allocator with additional options.

### Signature
```go
func CreateAndRegisterAllocatorV2(providerType string, memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg, ...) error
```

### Parameters
- **providerType** (string) - Required - Provider type.
- **memInfo** (*C.OrtMemoryInfo) - Required - Memory info.
- **arenaCfg** (*ArenaCfg) - Required - Arena configuration.
- **...** - Optional - Additional options.

### Returns
- **error** - Returns nil on success, or an error if registration fails.
```

--------------------------------

### AdvancedSession.RunWithOptions

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Runs the session using the provided RunOptions.

```APIDOC
## AdvancedSession.RunWithOptions

### Description
RunWithOptions runs the session using the provided RunOptions.

### Function Signature
`func (s *AdvancedSession) RunWithOptions(opts *RunOptions) error`

### Parameters
- **s** (*AdvancedSession) - The session to run.
- **opts** (*RunOptions) - Required - The run options to use.

### Returns
- **error** - An error if the operation fails.

```

--------------------------------

### NewArenaCfgV2

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a configuration object for an arena-based allocator using string-based configuration keys and size_t values.

```APIDOC
## NewArenaCfgV2

### Description
Creates a configuration object for an arena-based allocator using string-based configuration keys and size_t values.

### Function Signature
`func NewArenaCfgV2(configs map[string]int) (*ArenaCfg, error)`

### Parameters
- **configs** (map[string]int) - Required - Configuration keys and values for the arena allocator.

### Returns
- **(*ArenaCfg, error)** - A pointer to the created ArenaCfg and an error if any.
```

--------------------------------

### NewLoraAdapterWithData

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

The same as NewLoraAdapter, but takes a slice of bytes containing the .onnx_adapter data rather than a file path.

```APIDOC
## func NewLoraAdapterWithData

### Description
The same as NewLoraAdapter, but takes a slice of bytes containing the .onnx_adapter data rather than a file path.

### Method
NewLoraAdapterWithData

### Signature
func NewLoraAdapterWithData(adapterData []byte) (*LoraAdapter, error)

### Parameters
- **adapterData** ([]byte) - Required - Slice of bytes containing the .onnx_adapter data.

### Returns
- **\*LoraAdapter** - A new LoraAdapter instance.
- **error** - An error if loading fails.
```

--------------------------------

### func InitializeEnvironment(opts ...EnvironmentOption) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Call this function, optionally with one or more EnvironmentOption, to initialize the internal onnxruntime environment.

```APIDOC
## func InitializeEnvironment

### Description
Call this function, optionally with one or more EnvironmentOption, to initialize the internal onnxruntime environment. If this doesn't return an error, the caller will be responsible for calling DestroyEnvironment to free the onnxruntime state when no longer needed.

### Function Signature
`func InitializeEnvironment(opts ...EnvironmentOption) error`

### Parameters
- **opts** (...EnvironmentOption) - Optional - One or more environment options.

### Return Value
- **error** - Returns an error if initialization fails.
```

--------------------------------

### DynamicAdvancedSession.RunWithOptions

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Runs the session with the given input and output tensors and run options.

```APIDOC
## DynamicAdvancedSession.RunWithOptions

### Description
Runs the session with the given input and output tensors and run options.

### Method
Function

### Endpoint
func (s *DynamicAdvancedSession) RunWithOptions(inputs, outputs []Value, opts *RunOptions) error

### Parameters
- **s** (*DynamicAdvancedSession) - The receiver.
- **inputs** ([]Value) - Required - The input tensors.
- **outputs** ([]Value) - Required - The output tensors.
- **opts** (*RunOptions) - Required - The run options.

### Response
#### Success Response
- **error** (error) - An error if the run fails.
```

--------------------------------

### func WithLogLevelInfo() EnvironmentOption

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns an EnvironmentOption that sets the log level to info.

```APIDOC
## func WithLogLevelInfo() EnvironmentOption

### Description
Returns an EnvironmentOption that sets the log level to info.

### Signature
```go
func WithLogLevelInfo() EnvironmentOption
```

### Returns
- **EnvironmentOption** - The option.
```

--------------------------------

### func IsInitialized() bool

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Checks whether the ONNX Runtime environment has been initialized.

```APIDOC
## func IsInitialized() bool

### Description
Returns true if the ONNX Runtime environment has been initialized.

### Signature
```go
func IsInitialized() bool
```

### Returns
- **bool** - True if initialized, false otherwise.
```

--------------------------------

### NewLoraAdapter

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Loads a LoRA adapter file (in onnxruntime's .onnx_adapter format) from the given path. The adapter's parameters stay on the CPU, and are only copied to a device if the model requires it at inference time. The caller must call Destroy() on the returned LoraAdapter when it's no longer needed.

```APIDOC
## func NewLoraAdapter

### Description
NewLoraAdapter loads the LoRA adapter file (in onnxruntime's .onnx_adapter format) at the given path. The adapter's parameters stay on the CPU, and are only copied to a device if the model requires it at inference time. The caller must call Destroy() on the returned LoraAdapter when it's no longer needed.

### Method
NewLoraAdapter

### Signature
func NewLoraAdapter(adapterFilePath string) (*LoraAdapter, error)

### Parameters
- **adapterFilePath** (string) - Required - Path to the .onnx_adapter file.

### Returns
- **\*LoraAdapter** - A new LoraAdapter instance.
- **error** - An error if loading fails.
```

--------------------------------

### func CreateAndRegisterAllocator(memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates an allocator and registers it with the environment, enabling sharing between multiple sessions.

```APIDOC
## func CreateAndRegisterAllocator

### Description
Creates an allocator and registers it with the environment, enabling sharing between multiple sessions.

### Function Signature
`func CreateAndRegisterAllocator(memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg) error`

### Parameters
- **memInfo** (*C.OrtMemoryInfo) - Required - The memory info for the allocator.
- **arenaCfg** (*ArenaCfg) - Required - The arena configuration for the allocator.

### Return Value
- **error** - Returns an error if the operation fails.
```

--------------------------------

### RunOptions.AddRunConfigEntry

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Sets a run configuration key to the given value. See the onnxruntime_run_options_config_keys.h file for valid keys and values. If the key was already set, this will overwrite its old setting.

```APIDOC
## RunOptions.AddRunConfigEntry

### Description
AddRunConfigEntry sets a run configuration key to the given value. See the onnxruntime_run_options_config_keys.h file in the onnxruntime sources for documentation on valid keys and values. If the key was already set, this will overwrite its old setting with the given value.

### Method Signature
```go
func (o *RunOptions) AddRunConfigEntry(key, value string) error
```

### Parameters
- **o** (*RunOptions) - The RunOptions instance.
- **key** (string) - Required - The configuration key.
- **value** (string) - Required - The value to set.

### Returns
- **error** (error) - An error if the operation fails.
```

--------------------------------

### NewArenaCfg

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a configuration object for an arena-based allocator with specified memory limits and strategy.

```APIDOC
## NewArenaCfg

### Description
Creates a configuration object for an arena-based allocator. Use 0 for ORT default maxMem, -1 for ORT default initialChunkSize and maxDeadBytesPerChunk, and -1 for ORT default arenaExtendStrategy (or 0 for kNextPowerOfTwo, 1 for kSameAsRequested).

### Function Signature
`func NewArenaCfg(maxMem int, arenaExtendStrategy, initialChunkSize, maxDeadBytesPerChunk int) (*ArenaCfg, error)`

### Parameters
- **maxMem** (int) - Required - Maximum memory for the arena. Use 0 for ORT default.
- **arenaExtendStrategy** (int) - Required - Use -1 for ORT default, 0 = kNextPowerOfTwo, 1 = kSameAsRequested.
- **initialChunkSize** (int) - Required - Use -1 for ORT default.
- **maxDeadBytesPerChunk** (int) - Required - Use -1 for ORT default.

### Returns
- **(*ArenaCfg, error)** - A pointer to the created ArenaCfg and an error if any.
```

--------------------------------

### DynamicAdvancedSession.RunWithBinding

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Runs the session using the given IoBinding instance. The IoBinding must have been created from this session's CreateIoBinding() function.

```APIDOC
## DynamicAdvancedSession.RunWithBinding

### Description
Runs the session using the given IoBinding instance. The IoBinding must have been created from this session's CreateIoBinding() function.

### Method
Function

### Endpoint
func (s *DynamicAdvancedSession) RunWithBinding(b *IoBinding) error

### Parameters
- **s** (*DynamicAdvancedSession) - The receiver.
- **b** (*IoBinding) - Required - The I/O binding to use.

### Response
#### Success Response
- **error** (error) - An error if the run fails.
```

--------------------------------

### func (o *RunOptions) AddRunConfigEntry(key, value string) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Adds a run configuration entry.

```APIDOC
## func (o *RunOptions) AddRunConfigEntry(key, value string) error

### Description
Adds a key-value pair to the run configuration.

### Signature
`func (o *RunOptions) AddRunConfigEntry(key, value string) error`

### Parameters
- **key** (string) - The configuration key.
- **value** (string) - The configuration value.

### Returns
- **error** - An error if the operation fails.
```

--------------------------------

### NewAdvancedSession

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Loads an ONNX network from a file path and initializes an AdvancedSession instance.

```APIDOC
## NewAdvancedSession

### Description
Loads the ONNX network at the given path, and initializes an AdvancedSession instance. If this returns successfully, the caller must call Destroy() on the returned session when it is no longer needed. The input and output tensors MUST outlive this session, and calling session.Destroy() will not destroy the input or output tensors. If the provided SessionOptions pointer is nil, then the new session will use default options.

### Function Signature
`func NewAdvancedSession(onnxFilePath string, inputNames, outputNames []string, inputs, outputs []Value, options *SessionOptions) (*AdvancedSession, error)`

### Parameters
- **onnxFilePath** (string) - Required - Path to the ONNX model file.
- **inputNames** ([]string) - Required - Names of the input tensors.
- **outputNames** ([]string) - Required - Names of the output tensors.
- **inputs** ([]Value) - Required - Input tensors.
- **outputs** ([]Value) - Required - Output tensors.
- **options** (*SessionOptions) - Optional - Session options; nil for defaults.

### Returns
- **(*AdvancedSession, error)** - The created session and an error if any.

```

--------------------------------

### func NewArenaCfgV2(configs map[string]int) (*ArenaCfg, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new ArenaCfg using a configuration map.

```APIDOC
## func NewArenaCfgV2(configs map[string]int) (*ArenaCfg, error)

### Description
Creates a new ArenaCfg using a configuration map.

### Signature
```go
func NewArenaCfgV2(configs map[string]int) (*ArenaCfg, error)
```

### Parameters
- **configs** (map[string]int) - Required - Configuration map.

### Returns
- **(*ArenaCfg, error)** - A new ArenaCfg or an error.
```

--------------------------------

### DynamicSession.Run

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Runs the model with the provided input and output tensors.

```APIDOC
## DynamicSession.Run

### Description
Runs the model with the provided input and output tensors.

### Signature
```go
func (s *DynamicSession[in, out]) Run(inputs []*Tensor[in], outputs []*Tensor[out]) error
```

### Parameters
- **inputs** ([]*Tensor[in]) - Required - Input tensors for the model.
- **outputs** ([]*Tensor[out]) - Required - Output tensors to receive the results.

### Returns
- **error** - An error if the run fails.
```

--------------------------------

### DynamicAdvancedSession.CreateIoBinding

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates and returns an IoBinding instance associated with the session. The I/O binding can be used to avoid unnecessary copies to or from device memory. The returned IoBinding must be freed using Destroy() when no longer needed.

```APIDOC
## DynamicAdvancedSession.CreateIoBinding

### Description
Creates and returns an IoBinding instance associated with the session. The I/O binding can be used to avoid unecessary copies to or from device memory, for sessions on different devices. The returned IoBinding must be freed using Destroy() when it is no longer needed.

### Method
Function

### Endpoint
func (s *DynamicAdvancedSession) CreateIoBinding() (*IoBinding, error)

### Parameters
- **s** (*DynamicAdvancedSession) - The receiver.

### Response
#### Success Response
- **binding** (*IoBinding) - The created I/O binding.
- **error** (error) - An error if creation fails.
```

--------------------------------

### AppendExecutionProviderOpenVINO

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Enables the OpenVINO backend for the given session options on supported platforms.

```APIDOC
## AppendExecutionProviderOpenVINO

### Description
Enables the OpenVINO backend for the given session options on supported platforms. See https://onnxruntime.ai/docs/execution-providers/OpenVINO-ExecutionProvider.html#summary-of-options for a list of supported keys and values that can be passed in the options map.

### Method
func (o *SessionOptions) AppendExecutionProviderOpenVINO(options map[string]string) error

### Parameters
- **options** (map[string]string) - Required - Options for the OpenVINO provider. See the provided link for supported keys and values.

### Returns
- **error** - Returns an error if the operation fails.
```

--------------------------------

### WithLogLevelVerbose

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

EnvironmentOption that sets ORT logging to emit verbose informational messages and greater severity.

```APIDOC
## WithLogLevelVerbose

### Description
WithLogLevelVerbose is an EnvironmentOption that will set the ORT Environment logging to emit verbose informational messages (least severe) along with all messages of greater severity.

### Signature
```go
func WithLogLevelVerbose() EnvironmentOption
```

### Returns
- **EnvironmentOption** - A functional option to set the logging level.
```

--------------------------------

### func CreateAndRegisterAllocatorV2(providerType string, memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg, options map[string]string) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates an allocator of a specific provider type and registers it with the environment.

```APIDOC
## func CreateAndRegisterAllocatorV2

### Description
Creates an allocator of a specific provider type and registers it with the environment.

### Function Signature
`func CreateAndRegisterAllocatorV2(providerType string, memInfo *C.OrtMemoryInfo, arenaCfg *ArenaCfg, options map[string]string) error`

### Parameters
- **providerType** (string) - Required - The provider type for the allocator.
- **memInfo** (*C.OrtMemoryInfo) - Required - The memory info for the allocator.
- **arenaCfg** (*ArenaCfg) - Required - The arena configuration for the allocator.
- **options** (map[string]string) - Required - Additional options for the allocator.

### Return Value
- **error** - Returns an error if the operation fails.
```

--------------------------------

### NewDynamicSession

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Deprecated constructor for creating a DynamicSession. Use NewDynamicAdvancedSession instead.

```APIDOC
## NewDynamicSession

### Description
Deprecated: See the notes on Session[T]. Use NewDynamicAdvancedSession instead.

### Signature
```go
func NewDynamicSession[in TensorData, out TensorData](onnxFilePath string, inputNames, outputNames []string) (*DynamicSession[in, out], error)
```

### Parameters
- **onnxFilePath** (string) - Required - Path to the ONNX model file.
- **inputNames** ([]string) - Required - Names of the input tensors.
- **outputNames** ([]string) - Required - Names of the output tensors.

### Returns
- **(*DynamicSession[in, out], error)** - A new DynamicSession instance and an error if any.
```

--------------------------------

### func NewLoraAdapter(adapterFilePath string) (*LoraAdapter, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new LoraAdapter from a file path.

```APIDOC
## func NewLoraAdapter(adapterFilePath string) (*LoraAdapter, error)

### Description
Creates a new LoraAdapter by loading adapter data from the specified file path.

### Signature
`func NewLoraAdapter(adapterFilePath string) (*LoraAdapter, error)`

### Parameters
- **adapterFilePath** (string) - The path to the adapter file.

### Returns
- **\*LoraAdapter** - A pointer to the newly created LoraAdapter.
- **error** - An error if creation fails.
```

--------------------------------

### func NewLoraAdapterWithData(adapterData []byte) (*LoraAdapter, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new LoraAdapter from raw byte data.

```APIDOC
## func NewLoraAdapterWithData(adapterData []byte) (*LoraAdapter, error)

### Description
Creates a new LoraAdapter from the provided byte slice containing adapter data.

### Signature
`func NewLoraAdapterWithData(adapterData []byte) (*LoraAdapter, error)`

### Parameters
- **adapterData** ([]byte) - The raw adapter data.

### Returns
- **\*LoraAdapter** - A pointer to the newly created LoraAdapter.
- **error** - An error if creation fails.
```

--------------------------------

### func NewRunOptions() (*RunOptions, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new RunOptions object.

```APIDOC
## func NewRunOptions() (*RunOptions, error)

### Description
Creates a new RunOptions with default settings.

### Signature
`func NewRunOptions() (*RunOptions, error)`

### Returns
- **\*RunOptions** - A pointer to the newly created RunOptions.
- **error** - An error if creation fails.
```

--------------------------------

### func NewCUDAProviderOptions() (*CUDAProviderOptions, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates new CUDA provider options.

```APIDOC
## func NewCUDAProviderOptions() (*CUDAProviderOptions, error)

### Description
Creates new CUDA provider options.

### Signature
```go
func NewCUDAProviderOptions() (*CUDAProviderOptions, error)
```

### Returns
- **(*CUDAProviderOptions, error)** - A new CUDAProviderOptions or an error.
```

--------------------------------

### TrainingSession.OptimizerStep

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Performs an optimizer step.

```APIDOC
## TrainingSession.OptimizerStep

### Description
Performs an optimizer step.

### Method
OptimizerStep

### Signature
func (s *TrainingSession) OptimizerStep() error

### Returns
- **error** - An error if the operation fails.
```

--------------------------------

### func NewLoraAdapterWithAllocator(adapterFilePath string, allocator *Allocator) (*LoraAdapter, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new LoraAdapter from a file path using a specified allocator.

```APIDOC
## func NewLoraAdapterWithAllocator(adapterFilePath string, allocator *Allocator) (*LoraAdapter, error)

### Description
Creates a new LoraAdapter by loading adapter data from the specified file path, using the provided allocator.

### Signature
`func NewLoraAdapterWithAllocator(adapterFilePath string, allocator *Allocator) (*LoraAdapter, error)`

### Parameters
- **adapterFilePath** (string) - The path to the adapter file.
- **allocator** (\*Allocator) - The allocator to use.

### Returns
- **\*LoraAdapter** - A pointer to the newly created LoraAdapter.
- **error** - An error if creation fails.
```

--------------------------------

### AppendExecutionProviderV2

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Attaches a plugin execution provider to these session options using one or more OrtEpDevice instances obtained from GetEpDevices.

```APIDOC
## AppendExecutionProviderV2

### Description
AppendExecutionProviderV2 attaches a plugin execution provider to these session options using one or more OrtEpDevice instances obtained from GetEpDevices. All provided devices must belong to the same execution provider (they are different hardware targets within that EP). This is the plugin-aware path; use it for any execution provider loaded through RegisterExecutionProviderLibrary (QNN, newer OpenVINO, etc.). For execution providers compiled into libonnxruntime, use the dedicated wrappers (AppendExecutionProviderCUDA, AppendExecutionProviderCoreMLV2, ...) or the V1 string-based AppendExecutionProvider. Wraps the C API SessionOptionsAppendExecutionProvider_V2.

### Method
func (o *SessionOptions) AppendExecutionProviderV2(devices []EpDevice, options map[string]string) error

### Parameters
- **devices** ([]EpDevice) - Required - One or more OrtEpDevice instances obtained from GetEpDevices. All devices must belong to the same execution provider.
- **options** (map[string]string) - Required - Options for the execution provider.

### Returns
- **error** - Returns an error if the operation fails.
```

--------------------------------

### WithLogLevelInfo

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

EnvironmentOption that sets ORT logging to emit informational messages and greater severity.

```APIDOC
## WithLogLevelInfo

### Description
WithLogLevelInfo is an EnvironmentOption that will set the ORT Environment logging to emit informational messages along with all messages of greater severity.

### Signature
```go
func WithLogLevelInfo() EnvironmentOption
```

### Returns
- **EnvironmentOption** - A functional option to set the logging level.
```

--------------------------------

### func IsTrainingSupported() bool

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Checks if training is supported.

```APIDOC
## func IsTrainingSupported() bool

### Description
Checks if training is supported.

### Signature
```go
func IsTrainingSupported() bool
```

### Returns
- **bool** - True if training is supported, false otherwise.
```

--------------------------------

### SessionOptions.AppendExecutionProviderV2

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Appends an execution provider with device and options to the session options.

```APIDOC
## SessionOptions.AppendExecutionProviderV2

### Description
Appends an execution provider with device and options to the session options.

### Method
AppendExecutionProviderV2

### Signature
func (o *SessionOptions) AppendExecutionProviderV2(devices []EpDevice, options map[string]string) error

### Parameters
- **devices** ([]EpDevice) - Required - List of devices for the provider.
- **options** (map[string]string) - Required - Provider-specific options.

### Returns
- **error** - An error if the operation fails.
```

--------------------------------

### func NewDynamicSession[in TensorData, out TensorData](onnxFilePath string, inputNames, outputNames []string) (*DynamicSession[in, out], error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Creates a new DynamicSession with generic input and output tensor types.

```APIDOC
## func NewDynamicSession[in TensorData, out TensorData](onnxFilePath string, inputNames, outputNames []string) (*DynamicSession[in, out], error)

### Description
Creates a new DynamicSession with generic input and output tensor types.

### Signature
```go
func NewDynamicSession[in TensorData, out TensorData](onnxFilePath string, inputNames, outputNames []string) (*DynamicSession[in, out], error)
```

### Parameters
- **onnxFilePath** (string) - Required - Path to the ONNX model file.
- **inputNames** ([]string) - Required - Names of the model inputs.
- **outputNames** ([]string) - Required - Names of the model outputs.

### Returns
- **(*DynamicSession[in, out], error)** - A new DynamicSession or an error.
```

--------------------------------

### func GetVersion() string

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

GetVersion return version of the Onnxruntime library for logging.

```APIDOC
## func GetVersion

### Description
GetVersion return version of the Onnxruntime library for logging.

### Function Signature
`func GetVersion() string`

### Return Value
- **string** - The version of the Onnxruntime library.
```

--------------------------------

### func (m *ModelMetadata) GetDescription() (string, error)

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns the description of the model.

```APIDOC
## func (m *ModelMetadata) GetDescription() (string, error)

### Description
Returns the description of the model.

### Signature
`func (m *ModelMetadata) GetDescription() (string, error)`

### Returns
- **string** - The description.
- **error** - An error if retrieval fails.
```

--------------------------------

### NewLoraAdapterWithDataAndAllocator

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

The same as NewLoraAdapterWithAllocator, but takes a slice of bytes containing the .onnx_adapter data rather than a file path.

```APIDOC
## func NewLoraAdapterWithDataAndAllocator

### Description
The same as NewLoraAdapterWithAllocator, but takes a slice of bytes containing the .onnx_adapter data rather than a file path.

### Method
NewLoraAdapterWithDataAndAllocator

### Signature
func NewLoraAdapterWithDataAndAllocator(adapterData []byte, allocator *Allocator) (*LoraAdapter, error)

### Parameters
- **adapterData** ([]byte) - Required - Slice of bytes containing the .onnx_adapter data.
- **allocator** (\*Allocator) - Optional - Allocator to hold the adapter's parameters. Passing nil behaves like NewLoraAdapter.

### Returns
- **\*LoraAdapter** - A new LoraAdapter instance.
- **error** - An error if loading fails.
```

--------------------------------

### func RegisterExecutionProviderLibrary(registrationName, libraryPath string) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Registers an execution provider library with the environment.

```APIDOC
## func RegisterExecutionProviderLibrary

### Description
Registers an execution provider library with the environment.

### Function Signature
`func RegisterExecutionProviderLibrary(registrationName, libraryPath string) error`

### Parameters
- **registrationName** (string) - Required - The registration name for the library.
- **libraryPath** (string) - Required - The path to the library.

### Return Value
- **error** - Returns an error if the operation fails.
```

--------------------------------

### func (d EpDevice) EpName() string

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Returns the name of the execution provider device.

```APIDOC
## func (d EpDevice) EpName() string

### Description
Returns the name of the execution provider device.

### Signature
`func (d EpDevice) EpName() string`

### Returns
- **string** - The execution provider name.
```

--------------------------------

### func (*SessionOptions) AppendExecutionProviderCoreML(flags uint32) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Enables the CoreML backend on supported platforms. Deprecated, use AppendExecutionProviderCoreMLV2 instead.

```APIDOC
## func (*SessionOptions) AppendExecutionProviderCoreML

### Description
Enables the CoreML backend for the given session options on supported platforms. The meanings of the flag bits are currently defined in the coreml_provider_factory.h file which is provided in the include/ directory of the onnxruntime releases for Apple platforms. AppendExecutionProviderCoreML is now deprecated. Please use AppendExecutionProviderCoreMLV2 instead. See: https://onnxruntime.ai/docs/execution-providers/CoreML-ExecutionProvider.html

### Signature
func (o *SessionOptions) AppendExecutionProviderCoreML(flags uint32) error

### Parameters
- **flags** (uint32) - Required - Flags for CoreML provider.

### Returns
- **error** - An error if the operation fails.
```

--------------------------------

### func RegisterExecutionProviderLibrary(registrationName, libraryPath string) error

Source: https://pkg.go.dev/github.com/yalue/onnxruntime_go

Registers an execution provider library.

```APIDOC
## func RegisterExecutionProviderLibrary(registrationName, libraryPath string) error

### Description
Registers an execution provider library.

### Signature
```go
func RegisterExecutionProviderLibrary(registrationName, libraryPath string) error
```

### Parameters
- **registrationName** (string) - Required - Registration name.
- **libraryPath** (string) - Required - Path to the library.

### Returns
- **error** - Returns nil on success, or an error if registration fails.
```
Tokens:
Raw