包 ai.onnxruntime

ONNX Runtime 的 Java 接口。

提供对与 C 库相同的执行后端的访问。通过此 API 访问时，Java 中无法表示的类型（如 fp16）会转换为最接近的 Java 原生类型。

需要两个共享库：onnxruntime 和 onnxruntime4j_jni。加载器位于 OnnxRuntime 中，逻辑按以下顺序执行：

1. 用户可以通过形式为 onnxruntime.native.LIB_NAME.skip 且值为 true 的属性，通知系统跳过某个共享库的加载。这意味着用户已决定通过其他方式加载该库。
2. 用户可以通过形式为 onnxruntime.native.path 的属性指定所有原生库文件的显式位置。这会使用 System.load(java.lang.String) 方法。
3. 用户可以通过形式为 onnxruntime.native.LIB_NAME.path 的属性指定共享库文件的显式位置。这会使用 System.load(java.lang.String) 方法。
4. 自动发现共享库
   1. 如果共享库存在于类路径（classpath）资源中，则通过临时文件使用 System.load(java.lang.String) 进行加载。理想情况下，在将包含共享库的 JAR 包/依赖项添加到类路径时，这应该是默认的使用场景。
   2. 如果共享库不存在于类路径资源中，则使用 System.loadLibrary(java.lang.String) 加载，该方法通常会在文件系统的其他位置查找库。该方法的语义和行为取决于系统/JVM。通常，使用 java.library.path 属性来指定原生库的位置。

为了进行故障排除，所有共享库加载事件都会以 FINE 级别报告给 Java 日志。

请注意，CUDA、ROCM、DNNL、OpenVINO 和 TensorRT 均为“共享库执行提供程序”，必须存储在包含 ONNX Runtime 核心原生库的目录中，或者作为类路径资源存储。这是因为这些提供程序是由 ONNX Runtime 原生库自身加载的，Java API 无法控制其加载位置。

接口摘要

接口	描述
OnnxValue	ONNX 模型输入和输出值的顶级接口。
OrtFlags	用于位集枚举的接口，应聚合成单个整数。
OrtProviderOptions.OrtProviderSupplier	映射 Java supplier 的函数接口，但可以抛出 OrtException。
ValueInfo	用于描述 OnnxValue 的信息对象的接口。

类概要

类	描述
MapInfo	描述 OnnxMap 对象或输出节点。
NodeInfo	ONNX 模型输入或输出节点的信息。
OnnxMap	由 OrtSession.run(Map) 返回的映射容器。
OnnxModelMetadata	包含与 ONNX 模型关联的元数据。
OnnxSequence	一组类型相同的 OnnxValue 序列。
OnnxSparseTensor	包装 OnnxSparseTensor 的 Java 对象。
OnnxSparseTensor.BlockSparseTensor	块稀疏张量的 Java 端表示。
OnnxSparseTensor.COOTensor	COO 稀疏张量的 Java 端表示。
OnnxSparseTensor.CSRCTensor	CSRC 稀疏张量的 Java 端表示。
OnnxSparseTensor.SparseTensor<T extends java.nio.Buffer>	Java 稀疏张量的抽象基类
OnnxTensor	包装 OnnxTensor 的 Java 对象。
OnnxTensorLike	目前由 OnnxTensor 和 OnnxSparseTensor 实现。
OrtEnvironment	ONNX Runtime 系统的宿主对象。
OrtEnvironment.ThreadingOptions	控制环境中的全局线程池。
OrtEpDevice	执行提供程序信息和硬件设备的元组。
OrtHardwareDevice	特定设备的硬件信息。
OrtLoraAdapter	适配器容器，可提供给 OrtSession.RunOptions.addActiveLoraAdapter(OrtLoraAdapter)，以便将适配器应用于模型的特定执行。
OrtModelCompilationOptions	用于编译 ONNX 模型的配置选项。
OrtProviderOptions	执行提供程序选项类的抽象基类。
OrtSession	包装 ONNX 模型并允许推理调用。
OrtSession.Result	一个 AutoCloseable 包装器，包裹着包含 OnnxValue 的 Map。
OrtSession.RunOptions	用于控制对 OrtSession.run(java.util.Map<java.lang.String, ? extends ai.onnxruntime.OnnxTensorLike>) 调用的日志记录和终止。
OrtSession.SessionOptions	表示用于构建此会话的选项。
OrtTrainingSession	包装 ONNX 训练模型，允许进行训练和推理调用。
OrtUtil	用于与 Java 数组交互的实用代码。
SequenceInfo	描述 OnnxSequence，包括其元素类型（如果已知）。
TensorInfo	描述 OnnxTensor，包括其大小、形状和元素类型。

枚举摘要

枚举	描述
OnnxJavaType	一个表示 ONNX Runtime 支持的 Java 基本类型（以及 String）的枚举。
OnnxMap.OnnxMapValueType	表示存储在 OnnxMap 中的值对应的 Java 枚举类型。
OnnxSparseTensor.SparseTensorType	稀疏张量的类型。
OnnxValue.OnnxValueType	OnnxValue 的类型，映射 C API 中的 ID。
OrtEnvironment.OrtCompiledModelCompatibility	表示已编译模型与一组 OrtEpDevice 的兼容性的枚举。
OrtException.OrtErrorCode	映射 onnxruntime_c_api.h 中的 OrtErrorCode 结构，并增加了 Java 端错误的条目。
OrtHardwareDevice.OrtHardwareDeviceType	硬件设备类型。
OrtLoggingLevel	日志严重级别。
OrtModelCompilationOptions.OrtCompileApiFlags	表示编译模型时所用选项的标志。
OrtProvider	通过 Java API 可用的执行提供程序。
OrtSession.SessionOptions.ExecutionMode	要使用的执行模式。
OrtSession.SessionOptions.OptLevel	要使用的优化级别。
TensorInfo.OnnxTensorType	ONNX 运行时支持的原生元素类型。

异常摘要

Exception	描述
OrtException	包含本机 onnxruntime 产生的错误消息和代码的异常。