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 上更新