Transformers.js 文档
backends/onnx
并获得增强的文档体验
开始使用
backends/onnx
根据环境选择正确版本的 ONNX Runtime 的处理文件。理想情况下,我们只在需要时才导入 onnxruntime-web
和 onnxruntime-node
包,但动态导入似乎不适用于当前的 webpack 版本和/或配置。这可能是由于顶级 await 语句的实验性质。因此,我们只导入这两个包,并根据环境使用适当的包。
- 在 Node 中运行时,我们使用
onnxruntime-node
。 - 在浏览器中运行时,我们使用
onnxruntime-web
(不捆绑onnxruntime-node
)。
此模块未直接导出,但可以通过环境变量访问
import { env } from '@huggingface/transformers';
console.log(env.backends.onnx);
- backends/onnx
- 静态
.deviceToExecutionProviders([device])
⇒Array.<ONNXExecutionProviders>
.createInferenceSession(buffer_or_path, session_options, session_config)
⇒*
.isONNXTensor(x)
⇒boolean
.isONNXProxy()
⇒boolean
- 内部
~defaultDevices
:Array.<ONNXExecutionProviders>
~wasmInitPromise
:Promise<any>
|null
~DEVICE_TO_EXECUTION_PROVIDER_MAPPING
:*
~supportedDevices
:*
~ONNX_ENV
:*
~ONNXExecutionProviders
:*
- 静态
backends/onnx.deviceToExecutionProviders([device]) ⇒ <code> Array. < ONNXExecutionProviders > </code>
将设备映射到给定设备的执行提供程序。
类型:backends/onnx
的静态方法
返回:Array.<ONNXExecutionProviders>
- 用于给定设备的执行提供程序。
参数量 | 类型 | 默认 | 描述 |
---|---|---|---|
[device] | * |
| (可选)用于运行推理的设备。 |
backends/onnx.createInferenceSession(buffer_or_path, session_options, session_config) ⇒ <code> * </code>
创建 ONNX 推理会话。
类型:backends/onnx
的静态方法
返回:*
- ONNX 推理会话。
参数量 | 类型 | 描述 |
---|---|---|
buffer_or_path | Uint8Array | string | ONNX 模型缓冲区或路径。 |
session_options | * | ONNX 推理会话选项。 |
session_config | Object | ONNX 推理会话配置。 |
backends/onnx.isONNXTensor(x) ⇒ <code> boolean </code>
检查对象是否是 ONNX 张量。
类型:backends/onnx
的静态方法
返回:boolean
- 对象是否是 ONNX 张量。
参数量 | 类型 | 描述 |
---|---|---|
x | 任何 | 要检查的对象 |
backends/onnx.isONNXProxy() ⇒ <code> boolean </code>
检查 ONNX 的 WASM 后端是否正在代理。
类型:backends/onnx
的静态方法
返回:boolean
- ONNX 的 WASM 后端是否正在代理。
backends/onnx~defaultDevices : <code> Array. < ONNXExecutionProviders > </code>
类型:backends/onnx
的内部属性
backends/onnx~wasmInitPromise : <code> Promise < any > </code> | <code> null </code>
为防止多次调用 initWasm()
,我们将第一次调用存储在一个 Promise 中,当第一个 InferenceSession 创建时,该 Promise 将被解析。后续调用将在创建自己的 InferenceSession 之前等待此 Promise 解析。
类型:backends/onnx
的内部属性
backends/onnx~DEVICE_TO_EXECUTION_PROVIDER_MAPPING : <code> * </code>
类型:backends/onnx
的内部常量
backends/onnx~supportedDevices : <code> * </code>
支持的设备列表,按优先级/性能排序。
类型:backends/onnx
的内部常量
backends/onnx~ONNX_ENV : <code> * </code>
类型:backends/onnx
的内部常量
backends/onnx~ONNXExecutionProviders : <code> * </code>
类型:backends/onnx
的内部类型定义
< > 在 GitHub 上更新