ONNX Runtime

https://onnxruntime.ai/docs/api/c/
Admin
ONNX Runtime is a high-performance inference and training graph execution engine for deep learning...
Tokens:717,651
Snippets:6,076
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GetStartVersion

Source: https://onnxruntime.ai/docs/api/c/struct_ort_custom_op.html

Function pointer to get the start version of the custom operator.

```APIDOC
## GetStartVersion

### Description
Returns the start version of the custom operator.

### Signature
```c
int (*OrtCustomOp::GetStartVersion)(const struct OrtCustomOp *op);
```

### Parameters
- **op** (const struct OrtCustomOp *) - Pointer to the custom operator.

### Returns
- **int** - The start version.
```

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

### OrtCustomOp::GetStartVersion

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the start version of the custom operator.

```APIDOC
## [C] OrtCustomOp::GetStartVersion

### Description
Gets the start version of the custom operator.

### Method
C function pointer

### Endpoint
OrtCustomOp::GetStartVersion

### Parameters
#### Function Pointer Signature
- **op** (const struct OrtCustomOp*) - Required - Pointer to the custom operator.

### Returns
- **int** - Start version.

### Example
```c
int start_version = op->GetStartVersion(op);
```
```

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

### RunOptions::GetConfigEntry

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__cxx__api_8h_source.html

Gets a configuration entry.

```APIDOC
## RunOptions::GetConfigEntry

### Description
Gets a configuration entry.

### Method
GetConfigEntry

### Signature
`const char* GetConfigEntry(const char* config_key);`

### Parameters
- **config_key** (const char*) - Required - The configuration key.

### Returns
const char* - The configuration value, or nullptr if not found.

```

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

### Training C API sample: load checkpoint, create training session, train, export, save

Source: https://onnxruntime.ai/docs/api/c/training_c_cpp_api.html

Shows the typical usage of the ONNX Runtime Training C API. It initializes the API, creates an environment and session options, loads a checkpoint, creates a training session, runs a training loop with TrainStep, OptimizerStep, and LazyResetGrad, exports the model for inferencing, saves the checkpoint, and releases resources. Note: the OrtCheckpointState must outlive the OrtTrainingSession.

```c
#include <onnxruntime_training_api.h>
OrtApi* g_ort_api = OrtGetApiBase()->GetApi(ORT_API_VERSION);
OrtTrainingApi* g_ort_training_api = g_ort_api->GetTrainingApi(ORT_API_VERSION);
OrtEnv* env = NULL;
g_ort_api->CreateEnv(logging_level, logid, &env);
OrtSessionOptions* session_options = NULL;
g_ort_api->CreateSessionOptions(&session_options);
OrtCheckpointState* state = NULL;
g_ort_training_api->LoadCheckpoint(path_to_checkpoint, &state);
OrtTrainingSession* training_session = NULL;
g_ort_training_api->CreateTrainingSession(env, session_options, training_model_path,
state, eval_model_path, optimizer_model_path,
&training_session);
// Training loop
{
g_ort_training_api->TrainStep(...);
g_ort_training_api->OptimizerStep(...);
g_ort_training_api->LazyResetGrad(...);
}
g_ort_training_api->ExportModelForInferencing(training_session, inference_model_path, ...);
g_ort_training_api->SaveCheckpoint(state, path_to_checkpoint, false);
g_ort_training_api->ReleaseTrainingSession(training_session);
g_ort_training_api->ReleaseCheckpointState(state);
```

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

### CreateEnvWithOptions

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api-members.html

Creates an environment with options.

```APIDOC
## CreateEnvWithOptions

### Description
Creates an environment with options.

### Method
CreateEnvWithOptions

### Signature
OrtStatus* CreateEnvWithOptions(const OrtEnvCreationOptions *options, OrtEnv **out)

### Parameters
- **options** (const OrtEnvCreationOptions*) - Required - Environment creation options.
- **out** (OrtEnv**) - Required - Output pointer to the created environment.

### Returns
OrtStatus* - Status of the operation.
```

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

### Initialize graphics interop for D3D12

Source: https://onnxruntime.ai/docs/api/c/group___global.html

Example usage for D3D12: obtains the interop API, fills an OrtGraphicsInteropConfig with ORT_API_VERSION and ORT_GRAPHICS_API_D3D12, sets the command queue, and calls InitGraphicsInteropForEpDevice. The version field must be set to ORT_API_VERSION for forward compatibility.

```cpp
const OrtInteropApi* interop_api = ort_api->GetInteropApi();
OrtGraphicsInteropConfig config = {0};
config.version = ORT_API_VERSION;
config.graphics_api = ORT_GRAPHICS_API_D3D12;
config.command_queue = my_d3d12_command_queue; // ID3D12CommandQueue*
status = interop_api->InitGraphicsInteropForEpDevice(ep_device, &config);
```

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

### GetValueType

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the ONNXType of an OrtValue.

```APIDOC
## GetValueType

### Description
Gets the ONNXType of an OrtValue.

### Method
GetValueType

### Parameters
- **value** (const OrtValue*) - Required - The value to query.
- **out** (enum ONNXType*) - Required - Pointer to store the type.

### Returns
OrtStatus* - Status of the operation.
```

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

### SessionGetModelMetadata

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets OrtModelMetadata from an OrtSession.

```APIDOC
## SessionGetModelMetadata

### Description
Gets OrtModelMetadata from an OrtSession.

### Method
SessionGetModelMetadata

### Signature
OrtStatus * SessionGetModelMetadata(const OrtSession *session, OrtModelMetadata **out)

### Parameters
- **session** (const OrtSession*) - Required - The session.
- **out** (OrtModelMetadata**) - Required - Pointer to store the metadata.

### Returns
OrtStatus* - Status of the operation.
```

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

### Training C++ API sample: load checkpoint, train, and save

Source: https://onnxruntime.ai/docs/api/c/training_c_cpp_api.html

Shows the basic workflow for training with ONNX Runtime C++ API: load a checkpoint, create a TrainingSession, run training steps, export the model for inference, and save the checkpoint. The CheckpointState must outlive the TrainingSession.

```cpp
#include <onnxruntime_training_cxx_api.h>
Ort::Env env;
Ort::SessionOptions session_options;
auto state = Ort::CheckpointState::LoadCheckpoint(path_to_checkpoint);
auto training_session = Ort::TrainingSession(env, session_options, state, training_model_path,
eval_model_path, optimizer_model_path);
// Training Loop
{
training_session.TrainStep(...);
training_session.OptimizerStep(...);
training_session.LazyResetGrad(...);
}
training_session->ExportModelForInferencing(inference_model_path, ...);
Ort::CheckpointState::SaveCheckpoint(state, path_to_checkpoint, false);
```

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

### CreateEnvWithOptions

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Creates an ONNX Runtime environment with the specified options.

```APIDOC
## CreateEnvWithOptions

### Description
Create an OrtEnv instance with the given options.

### Method
C API Function

### Signature
OrtStatus* CreateEnvWithOptions(const OrtEnvCreationOptions* options, OrtEnv** out)

### Parameters
- **options** (const OrtEnvCreationOptions*) - Input - The environment creation options.
- **out** (OrtEnv**) - Output - Pointer to receive the created environment.

### Returns
OrtStatus* - Status code indicating success or failure.
```

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

### GetAllocatorWithDefaultOptions

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the default allocator.

```APIDOC
## GetAllocatorWithDefaultOptions

### Description
Gets the default allocator.

### Method
C function

### Signature
OrtStatus *GetAllocatorWithDefaultOptions(OrtAllocator **out)

### Parameters
- **out** (OrtAllocator**) - Required - Pointer to receive the default allocator.

### Returns
OrtStatus* - Status of the operation.
```

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

### MemoryInfoGetType

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the OrtAllocatorType from an OrtMemoryInfo.

```APIDOC
## MemoryInfoGetType

### Description
Retrieves the OrtAllocatorType from an OrtMemoryInfo.

### Method
C function

### Signature
OrtStatus *MemoryInfoGetType(const OrtMemoryInfo *ptr, OrtAllocatorType *out)

### Parameters
- **ptr** (const OrtMemoryInfo*) - Required - Pointer to the OrtMemoryInfo.
- **out** (OrtAllocatorType*) - Required - Pointer to receive the allocator type.

### Returns
OrtStatus* - Status of the operation.
```

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

### EpDevice::EpOptions() const

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_ep_device.html

Returns the options of the execution provider.

```APIDOC
## EpDevice::EpOptions() const

### Description
Returns the options of the execution provider.

### Method
Member function

### Signature
ConstKeyValuePairs EpOptions() const

### Parameters
None

### Returns
- **ConstKeyValuePairs** - The options key-value pairs of the execution provider.
```

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

### Env::Env(const OrtEnvCreationOptions*)

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__cxx__api_8h_source.html

Creates an environment with the specified options.

```APIDOC
## Env::Env(const OrtEnvCreationOptions *options)

### Description
Wraps OrtApi::CreateEnvWithOptions. Creates an environment with the specified options.

### Method
Constructor

### Parameters
- **options** (const OrtEnvCreationOptions*) - Required - The environment creation options.

### Returns
- **Env** - The created environment.
```

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

### MemoryInfoGetMemType

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the OrtMemType from an OrtMemoryInfo.

```APIDOC
## MemoryInfoGetMemType

### Description
Retrieves the OrtMemType from an OrtMemoryInfo.

### Method
C function

### Signature
OrtStatus *MemoryInfoGetMemType(const OrtMemoryInfo *ptr, OrtMemType *out)

### Parameters
- **ptr** (const OrtMemoryInfo*) - Required - Pointer to the OrtMemoryInfo.
- **out** (OrtMemType*) - Required - Pointer to receive the memory type.

### Returns
OrtStatus* - Status of the operation.
```

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

### MemoryInfoGetName

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the name from an OrtMemoryInfo.

```APIDOC
## MemoryInfoGetName

### Description
Retrieves the name from an OrtMemoryInfo.

### Method
C function

### Signature
OrtStatus *MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)

### Parameters
- **ptr** (const OrtMemoryInfo*) - Required - Pointer to the OrtMemoryInfo.
- **out** (const char**) - Required - Pointer to receive the name string.

### Returns
OrtStatus* - Status of the operation.
```

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

### DefaultInit implementation without ORT_API_MANUAL_INIT

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__cxx__api_8h_source.html

Provides the definition of detail::Global::DefaultInit when ORT_API_MANUAL_INIT is not defined. It calls OrtGetApiBase()->GetApi(ORT_API_VERSION) to obtain the API pointer. Includes a #pragma detect_mismatch to ensure consistent definitions across compilation units.

```cpp
#ifdef _MSC_VER
// If you get a linker error about a mismatch here, you are trying to link
// two compilation units that have different definitions for
// ORT_API_MANUAL_INIT together. All compilation units must agree on the
// definition of ORT_API_MANUAL_INIT.
#pragma detect_mismatch("ORT_API_MANUAL_INIT", "disabled")
#endif

inline const OrtApi* detail::Global::DefaultInit() noexcept {
  return OrtGetApiBase()->GetApi(ORT_API_VERSION);
}
```

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

### Manual initialization example for custom operator library (mycustomop.cc)

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__cxx__api_8h_source.html

Shows how to manually initialize the ONNX Runtime C++ API in a custom operator library that is not linked to onnxruntime. Requires defining ORT_API_MANUAL_INIT before including the header and undefining it after. The RegisterCustomOps function calls Ort::InitApi with the API pointer from the provided api_base.

```cpp
#define ORT_API_MANUAL_INIT
#include <onnxruntime_cxx_api.h>
#undef ORT_API_MANUAL_INIT

OrtStatus* ORT_API_CALL RegisterCustomOps(OrtSessionOptions* options, const OrtApiBase* api_base) {
  Ort::InitApi(api_base->GetApi(ORT_API_VERSION));
  // ...
}
```

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

### GetDimensions

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the dimensions from an OrtTensorTypeAndShapeInfo.

```APIDOC
## GetDimensions

### Description
Gets the dimensions from an OrtTensorTypeAndShapeInfo.

### Method
OrtStatus *

### Signature
OrtStatus * GetDimensions (const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)

### Parameters
- **info** (const OrtTensorTypeAndShapeInfo *) - Input - The info object to query.
- **dim_values** (int64_t *) - Output - Array to receive the dimension values.
- **dim_values_length** (size_t) - Input - Length of the output array.

### Returns
OrtStatus * - Status of the operation.
```

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

### Env::GetHardwareDevices()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_env.html

Gets the list of available hardware devices.

```APIDOC
## Env::GetHardwareDevices()

### Description
Get the list of available hardware devices.

### Method
- **std::vector<ConstHardwareDevice> GetHardwareDevices() const**

### Returns
- **std::vector<ConstHardwareDevice>** - A vector of ConstHardwareDevice objects.
```

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

### CastTypeInfoToTensorInfo

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets an OrtTensorTypeAndShapeInfo from an OrtTypeInfo.

```APIDOC
## CastTypeInfoToTensorInfo

### Description
Gets an OrtTensorTypeAndShapeInfo from an OrtTypeInfo.

### Method
OrtStatus *

### Signature
OrtStatus * CastTypeInfoToTensorInfo (const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)

### Parameters
- **type_info** (const OrtTypeInfo *) - Input - The type info to cast.
- **out** (const OrtTensorTypeAndShapeInfo **) - Output - Pointer to receive the tensor type and shape info.

### Returns
OrtStatus * - Status of the operation.
```

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

### CreateHardwareDevice

Source: https://onnxruntime.ai/docs/api/c/struct_ort_ep_api.html

Create an OrtHardwareDevice.

```APIDOC
## CreateHardwareDevice

### Description
Create an OrtHardwareDevice.

### Method
C function

### Signature
OrtStatus *CreateHardwareDevice(OrtHardwareDeviceType type, uint32_t vendor_id, uint32_t device_id, const char *vendor_name, const OrtKeyValuePairs *metadata, OrtHardwareDevice **hardware_device)

### Parameters
- **type** (OrtHardwareDeviceType) - Required - The hardware device type.
- **vendor_id** (uint32_t) - Required - The vendor ID.
- **device_id** (uint32_t) - Required - The device ID.
- **vendor_name** (const char*) - Required - The vendor name.
- **metadata** (const OrtKeyValuePairs*) - Required - Metadata.
- **hardware_device** (OrtHardwareDevice**) - Required - Output pointer to the created hardware device.

### Returns
OrtStatus* - Status of the operation.
```

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

### GetCustomOpDomains

Source: https://onnxruntime.ai/docs/api/c/struct_ort_ep_factory.html

Gets the EP-specific OrtCustomOpDomains.

```APIDOC
## [GET] GetCustomOpDomains

### Description
Gets the EP-specific OrtCustomOpDomains.

### Method
GET

### Endpoint
GetCustomOpDomains

### Parameters
#### Path Parameters
- **this_ptr** (OrtEpFactory*) - Required - Pointer to the OrtEpFactory instance.
- **domains** (OrtCustomOpDomain**) - Required - Output array of domains.
- **num_domains** (size_t) - Required - Number of domains to retrieve.

### Response
#### Success Response (200)
- **OrtStatus*** - Status code indicating success or failure.

#### Response Example
```json
{
  "status": "OK"
}
```
```

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

### Env::GetEpDevices()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_env.html

Gets the list of execution provider devices.

```APIDOC
## Env::GetEpDevices()

### Description
Gets the list of execution provider devices associated with the environment.

### Method
- **std::vector<ConstEpDevice> GetEpDevices() const**

### Returns
- **std::vector<ConstEpDevice>** - A vector of ConstEpDevice objects.
```

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

### GetParametersSize

Source: https://onnxruntime.ai/docs/api/c/struct_ort_training_api-members.html

Gets the size of the parameters.

```APIDOC
## GetParametersSize

### Description
Gets the size of the parameters.

### Method
N/A (C API function)

### Parameters
- `sess` (OrtTrainingSession*) - Required - Pointer to the training session.
- `out` (size_t*) - Required - Pointer to receive the size.
- `trainable_only` (bool) - Required - Whether to consider only trainable parameters.

### Returns
void
```

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

### GetCompileApi

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the Compile API instance.

```APIDOC
## GetCompileApi

### Description
Gets the Compile API instance.

### Method
GetCompileApi

### Signature
const OrtCompileApi *(* GetCompileApi)(void)

### Parameters
None

### Returns
const OrtCompileApi* - The Compile API instance.
```

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

### Run

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api-members.html

Runs a session with the given inputs and outputs.

```APIDOC
## OrtApi::Run

### Description
Runs a session with the given inputs and outputs.

### Method
N/A (C API function)

### Endpoint
OrtApi::Run(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *inputs, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **outputs)

### Parameters
- **session** (OrtSession*) - Required - Session to run.
- **run_options** (const OrtRunOptions*) - Required - Run options.
- **input_names** (const char* const*) - Required - Array of input names.
- **inputs** (const OrtValue* const*) - Required - Array of input values.
- **input_len** (size_t) - Required - Number of inputs.
- **output_names** (const char* const*) - Required - Array of output names.
- **output_names_len** (size_t) - Required - Number of output names.
- **outputs** (OrtValue**) - Required - Array to receive output values.

### Response
No return value.
```

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

### SessionGetOverridableInitializerName

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the name of an overridable initializer.

```APIDOC
## SessionGetOverridableInitializerName

### Description
Gets the name of an overridable initializer.

### Method
SessionGetOverridableInitializerName

### Signature
OrtStatus * SessionGetOverridableInitializerName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)

### Parameters
- **session** (const OrtSession*) - Required - The session.
- **index** (size_t) - Required - Index of the initializer.
- **allocator** (OrtAllocator*) - Required - Allocator for the returned string.
- **value** (char**) - Required - Pointer to store the name.

### Returns
OrtStatus* - Status of the operation.
```

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

### CreateEnv

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api-members.html

Creates an environment.

```APIDOC
## CreateEnv

### Description
Creates an environment.

### Method
CreateEnv

### Signature
OrtStatus* CreateEnv(OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)

### Parameters
- **log_severity_level** (OrtLoggingLevel) - Required - Logging severity level.
- **logid** (const char*) - Required - Log identifier.
- **out** (OrtEnv**) - Required - Output pointer to the created environment.

### Returns
OrtStatus* - Status of the operation.
```

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

### GetAvailableProviders

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the names of all available providers.

```APIDOC
## [GET] GetAvailableProviders

### Description
Get the names of all available providers.

### Method
GET

### Endpoint
GetAvailableProviders

### Parameters
#### Path Parameters
- **out_ptr** (char***) - Required - Output pointer to an array of provider name strings.
- **provider_length** (int*) - Required - Output pointer to the number of providers.

### Response
#### Success Response (200)
- **return** (OrtStatus*) - Status of the operation.

#### Response Example
```
char** providers;
int length;
OrtStatus* status = GetAvailableProviders(&providers, &length);
```
```

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

### Build()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_kernel_def_builder.html

Builds the kernel definition from the configured builder.

```APIDOC
## Build()

### Description
Builds the kernel definition from the configured builder.

### Method
Build

### Signature
KernelDef Ort::KernelDefBuilder::Build()

### Parameters
None.

### Returns
KernelDef - The constructed kernel definition.
```

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

### InitGraphicsInteropForEpDevice()

Source: https://onnxruntime.ai/docs/api/c/functions_func_i.html

Initializes graphics interop for a specific EP device.

```APIDOC
## [FUNCTION] InitGraphicsInteropForEpDevice()

### Description
Initializes graphics interop for a specific EP device.

### Belongs to
- OrtInteropApi

### Usage
This function is part of the ONNX Runtime C/C++ API and is used to initialize graphics interop for a specific execution provider device.
```

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

### OrtApi::GetOnnxTypeFromTypeInfo

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets ONNXType from OrtTypeInfo.

```APIDOC
## [GET] GetOnnxTypeFromTypeInfo

### Description
Gets ONNXType from OrtTypeInfo.

### Method
GET

### Endpoint
GetOnnxTypeFromTypeInfo

### Parameters
#### Path Parameters
- **type_info** (const OrtTypeInfo*) - Required - The type info.
- **out** (enum ONNXType*) - Required - Pointer to store the ONNXType.

### Response
#### Success Response (200)
- **OrtStatus*** - Status of the operation.

#### Response Example
```
OrtStatus* status = GetOnnxTypeFromTypeInfo(type_info, &type);
```
```

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

### CreateEnvWithOptions()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Creates an OrtEnv instance with the given options.

```APIDOC
## CreateEnvWithOptions()

### Description
Creates an OrtEnv instance with the given options. Invoking this function will return the same instance of the environment as that returned by a previous call to another env creation function; all arguments to this function will be ignored.

### Method
CreateEnvWithOptions

### Parameters
- **options** (const OrtEnvCreationOptions*) - [in] - The OrtEnvCreationOptions instance that contains creation options.
- **out** (OrtEnv**) - [out] - Output parameter set to the new OrtEnv instance. Must be freed with OrtApi::ReleaseEnv.

### Returns
If no error, nullptr will be returned. If there is an error, a pointer to an OrtStatus that contains error details will be returned. Use OrtApi::ReleaseStatus to free this pointer.

### Since
Version 1.24
```

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

### DeviceEpIncompatibilityDetails_GetNotes

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets notes from incompatibility details.

```APIDOC
## [POST] /DeviceEpIncompatibilityDetails_GetNotes

### Description
Gets notes from incompatibility details.

### Method
POST

### Endpoint
/DeviceEpIncompatibilityDetails_GetNotes

### Parameters
#### Path Parameters
- **details** (const OrtDeviceEpIncompatibilityDetails*) - Required - Pointer to the details.

#### Query Parameters
- **notes** (const char**) - Required - Output pointer to store notes.

### Request Example
{
  "details": "<OrtDeviceEpIncompatibilityDetails*>"
}

### Response
#### Success Response (200)
- **notes** (const char*) - Notes string.

#### Response Example
{
  "notes": "Some notes"
}
```

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

### KernelInfoGetAllocator

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets an allocator from kernel info.

```APIDOC
## KernelInfoGetAllocator

### Description
Gets an allocator from kernel info.

### Method
N/A (C API function)

### Endpoint
N/A

### Parameters
- **info** (const OrtKernelInfo*) - Required - Pointer to kernel info.
- **mem_type** (OrtMemType) - Required - Memory type.
- **out** (OrtAllocator**) - Required - Output pointer to the allocator.

### Request Example
N/A

### Response
#### Success Response
Returns OrtStatus* indicating success.

#### Response Example
N/A
```

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

### EpDevice::EpDevice(OrtEpFactory &ep_factory, ConstHardwareDevice &hardware_device, ConstKeyValuePairs ep_metadata={}, ConstKeyValuePairs ep_options={})

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_ep_device.html

Constructs an EpDevice by wrapping OrtEpApi::CreateEpDevice.

```APIDOC
## EpDevice::EpDevice(OrtEpFactory &ep_factory, ConstHardwareDevice &hardware_device, ConstKeyValuePairs ep_metadata={}, ConstKeyValuePairs ep_options={})

### Description
Constructs an EpDevice by wrapping OrtEpApi::CreateEpDevice.

### Method
Constructor

### Signature
EpDevice(OrtEpFactory &ep_factory, ConstHardwareDevice &hardware_device, ConstKeyValuePairs ep_metadata={}, ConstKeyValuePairs ep_options={})

### Parameters
- **ep_factory** (OrtEpFactory&) - The EP factory used to create the device.
- **hardware_device** (ConstHardwareDevice&) - The hardware device associated with the EP.
- **ep_metadata** (ConstKeyValuePairs) - Optional. Metadata key-value pairs for the EP.
- **ep_options** (ConstKeyValuePairs) - Optional. Options key-value pairs for the EP.

### Remarks
Wraps OrtEpApi::CreateEpDevice.
```

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

### KernelContext_GetResource

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets a resource from the kernel context.

```APIDOC
## KernelContext_GetResource

### Description
Gets a resource from the kernel context.

### Method
N/A (C API function)

### Endpoint
N/A

### Parameters
- **context** (const OrtKernelContext*) - Required - Pointer to the kernel context.
- **resource_version** (int) - Required - Resource version.
- **resource_id** (int) - Required - Resource ID.
- **resource** (void**) - Required - Output pointer to the resource.

### Request Example
N/A

### Response
#### Success Response
Returns OrtStatus* indicating success.

#### Response Example
N/A
```

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

### GetHardwareDevices()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_env.html

Gets the list of available hardware devices on the system.

```APIDOC
## GetHardwareDevices()

### Description
Gets the list of available hardware devices on the system. Enumerates hardware devices available on the system.

### Method
N/A (C++ method)

### Endpoint
N/A

### Parameters
None

### Returns
std::vector<ConstHardwareDevice> - A vector of hardware devices.

### Exceptions
- **Ort::Exception** - On error. Wraps OrtApi::GetHardwareDevices.
```

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

### GetSparseTensorValues

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the values of a sparse tensor.

```APIDOC
## [GET] GetSparseTensorValues

### Description
Gets a pointer to the values of a sparse tensor.

### Method
GET

### Endpoint
ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out)

### Parameters
#### Input Parameters
- **ort_value** (const OrtValue*) - Required - The OrtValue of the sparse tensor.

#### Output Parameters
- **out** (const void**) - Required - Pointer to receive the values pointer.

### Response
#### Success Response
Returns ORT_OK on success, or an error status on failure.
```

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

### CreateEnv()

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Creates an OrtEnv.

```APIDOC
## CreateEnv()

### Description
Creates an OrtEnv.

### Method
CreateEnv

### Parameters
- **log_severity_level** (OrtLoggingLevel) - [in] - The log severity level.
- **logid** (const char*) - [in] - The log identifier.
- **out** (OrtEnv**) - [out] - Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv.

### Returns
If no error, nullptr will be returned. If there is an error, a pointer to an OrtStatus that contains error details will be returned. Use OrtApi::ReleaseStatus to free this pointer.

### Note
Invoking this function will return the same instance of the environment as that returned by a previous call to another env creation function; all arguments to this function will be ignored.
```

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

### GetSparseTensorFormat

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the format of a sparse tensor.

```APIDOC
## [GET] GetSparseTensorFormat

### Description
Gets the format (COO, CSR, BlockSparse) of a sparse tensor.

### Method
GET

### Endpoint
ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out)

### Parameters
#### Input Parameters
- **ort_value** (const OrtValue*) - Required - The OrtValue of the sparse tensor.

#### Output Parameters
- **out** (enum OrtSparseFormat*) - Required - Pointer to receive the sparse format.

### Response
#### Success Response
Returns ORT_OK on success, or an error status on failure.
```

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

### TrainingSession Constructor (from CheckpointState and model paths)

Source: https://onnxruntime.ai/docs/api/c/class_ort_1_1_training_session-members.html

Constructs a TrainingSession using a checkpoint state and model file paths. This constructor initializes the training session with the provided environment, session options, checkpoint state, and optional eval and optimizer model paths.

```APIDOC
## TrainingSession(const Env &env, const SessionOptions &session_options, CheckpointState &checkpoint_state, const std::basic_string<char> &train_model_path, const std::optional<std::basic_string<char>> &eval_model_path=std::nullopt, const std::optional<std::basic_string<char>> &optimizer_model_path=std::nullopt)

### Description
Constructs a TrainingSession using a checkpoint state and model file paths. This constructor initializes the training session with the provided environment, session options, checkpoint state, and optional eval and optimizer model paths.

### Parameters
- **env** (const Env&) - Required - The ONNX Runtime environment.
- **session_options** (const SessionOptions&) - Required - Configuration options for the session.
- **checkpoint_state** (CheckpointState&) - Required - The checkpoint state to initialize the training session.
- **train_model_path** (const std::basic_string<char>&) - Required - Path to the training model.
- **eval_model_path** (const std::optional<std::basic_string<char>>&) - Optional - Path to the evaluation model.
- **optimizer_model_path** (const std::optional<std::basic_string<char>>&) - Optional - Path to the optimizer model.
```

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

### MemoryInfoGetId

Source: https://onnxruntime.ai/docs/api/c/onnxruntime__c__api_8h_source.html

Gets the ID of the memory info.

```APIDOC
## [GET] MemoryInfoGetId

### Description
Retrieves the ID of the given OrtMemoryInfo object.

### Method
GET

### Endpoint
MemoryInfoGetId

### Parameters
#### Parameters
- **ptr** (const OrtMemoryInfo*) - Required - The memory info object.
- **out** (int*) - Required - Output pointer to the ID.

### Request Example
```c
int id = 0;
OrtStatus* status = MemoryInfoGetId(info, &id);
```

### Response
#### Success Response
- **out** (int) - The ID of the memory info.

#### Response Example
```c
// id is set to the memory info ID
```
```

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

### HardwareDevice_Metadata

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Get hardware device metadata.

```APIDOC
## HardwareDevice_Metadata

### Description
Get hardware device metadata.

### Method
Function pointer

### Signature
const OrtKeyValuePairs* (*OrtApi::HardwareDevice_Metadata)(const OrtHardwareDevice *device)

### Parameters
- **device** (const OrtHardwareDevice*) - Required - The OrtHardwareDevice instance to query.

### Returns
An OrtKeyValuePairs instance containing the metadata for the device. Note: ORT owns the instance so the user must not call ReleaseKeyValuePairs with it.

### Since
Version 1.22.
```

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

### IoBinding()

Source: https://onnxruntime.ai/docs/api/c/functions_func_i.html

Creates an I/O binding object.

```APIDOC
## [FUNCTION] IoBinding()

### Description
Creates an I/O binding object.

### Belongs to
- Ort::IoBinding

### Usage
This function is part of the ONNX Runtime C/C++ API and is used to create an I/O binding object.
```

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

### OrtApi::GetErrorCode

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Get OrtErrorCode from OrtStatus.

```APIDOC
## GetErrorCode

### Description
Get OrtErrorCode from OrtStatus.

### Method
N/A (C function pointer)

### Endpoint
OrtApi::GetErrorCode

### Parameters
- **status** (const OrtStatus*) - Required - The status to get the error code from.

### Returns
OrtErrorCode that `status` was created with.
```

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

### Env::Env(OrtEnv*)

Source: https://onnxruntime.ai/docs/api/c/struct_ort_1_1_env.html

C Interop Helper. Constructs an Env from a raw OrtEnv pointer.

```APIDOC
## Env::Env(OrtEnv*)

### Description
C Interop Helper. Constructs an Env object from a raw OrtEnv pointer.

### Constructor
- **Env**(OrtEnv* p)

### Parameters
- **p** (OrtEnv*) - Required - Pointer to an existing OrtEnv object.
```

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

### MemoryInfoGetId

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the device id from an OrtMemoryInfo.

```APIDOC
## MemoryInfoGetId

### Description
Retrieves the device id from an OrtMemoryInfo.

### Method
C function

### Signature
OrtStatus *MemoryInfoGetId(const OrtMemoryInfo *ptr, int *out)

### Parameters
- **ptr** (const OrtMemoryInfo*) - Required - Pointer to the OrtMemoryInfo.
- **out** (int*) - Required - Pointer to receive the device id.

### Returns
OrtStatus* - Status of the operation.
```

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

### GetEpDevices

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the list of available OrtEpDevice instances.

```APIDOC
## GetEpDevices

### Description
Get the list of available OrtEpDevice instances.

### Signature
OrtStatus * GetEpDevices(const OrtEnv *env, const OrtEpDevice *const **ep_devices, size_t *num_ep_devices)

### Parameters
- **env** (const OrtEnv*) - Environment.
- **ep_devices** (const OrtEpDevice* const**) - Output array of EP devices.
- **num_ep_devices** (size_t*) - Output count of devices.

### Returns
OrtStatus* - Status of the operation.
```

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

### GetDimensionsCount

Source: https://onnxruntime.ai/docs/api/c/struct_ort_api.html

Gets the dimension count from an OrtTensorTypeAndShapeInfo.

```APIDOC
## GetDimensionsCount

### Description
Gets the dimension count from an OrtTensorTypeAndShapeInfo.

### Method
OrtStatus *

### Signature
OrtStatus * GetDimensionsCount (const OrtTensorTypeAndShapeInfo *info, size_t *out)

### Parameters
- **info** (const OrtTensorTypeAndShapeInfo *) - Input - The info object to query.
- **out** (size_t *) - Output - Pointer to receive the dimension count.

### Returns
OrtStatus * - Status of the operation.
```
Tokens:
Raw