介面 SessionOptions

會話行為的一組配置。

interface SessionOptions {
    enableCpuMemArena?: boolean;
    enableGraphCapture?: boolean;
    enableMemPattern?: boolean;
    enableProfiling?: boolean;
    executionMode?: "sequential" | "parallel";
    executionProviders?: readonly ExecutionProviderConfig[];
    externalData?: readonly ExternalDataFileType[];
    extra?: Record<string, unknown>;
    freeDimensionOverrides?: {
        [dimensionName: string]: number;
    };
    graphOptimizationLevel?: "basic" | "all" | "disabled" | "extended" | "layout";
    interOpNumThreads?: number;
    intraOpNumThreads?: number;
    logId?: string;
    logSeverityLevel?: 0 | 2 | 1 | 3 | 4;
    logVerbosityLevel?: number;
    optimizedModelFilePath?: string;
    preferredOutputLocation?: DataLocation | {
        [outputName: string]: OnnxValueDataLocation;
    };
    profileFilePrefix?: string;
}

層級 (檢視完整內容)

屬性

enableCpuMemArena? enableGraphCapture? enableMemPattern? enableProfiling? executionMode? executionProviders? externalData? extra? freeDimensionOverrides? graphOptimizationLevel? interOpNumThreads? intraOpNumThreads? logId? logSeverityLevel? logVerbosityLevel? optimizedModelFilePath? preferredOutputLocation? profileFilePrefix?

屬性

可選 enableCpuMemArena

enableCpuMemArena?: boolean

是否啟用 CPU 記憶體區域。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 enableGraphCapture

enableGraphCapture?: boolean

是否啟用圖捕獲。此設定僅在 ONNXRuntime Web 的 WebGPU EP 中可用。

可選 enableMemPattern

enableMemPattern?: boolean

是否啟用記憶體模式。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 enableProfiling

enableProfiling?: boolean

是否啟用效能分析。

此設定為未來用途的佔位符。

可選 executionMode

executionMode?: "sequential" | "parallel"

執行模式。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 executionProviders

executionProviders?: readonly ExecutionProviderConfig[]

執行提供程式選項陣列。

執行提供程式選項可以是表示執行提供程式名稱的字串，也可以是相應型別的物件。

可選 externalData

externalData?: readonly ExternalDataFileType[]

指定表示外部資料的檔案列表。

可選 extra

extra?: Record<string, unknown>

儲存會話的配置。請參閱 https://github.com/microsoft/onnxruntime/blob/main/include/onnxruntime/core/session/ onnxruntime_session_options_config_keys.h

此設定僅在 WebAssembly 後端中可用。稍後將支援 Node.js 繫結和 React Native。

示例

extra: {
  session: {
    set_denormal_as_zero: "1",
    disable_prepacking: "1"
  },
  optimization: {
    enable_gelu_approximation: "1"
  }
}

可選 freeDimensionOverrides

freeDimensionOverrides?: {
    [dimensionName: string]: number;
}

自由維度覆蓋。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

型別宣告

  • [dimensionName: string]: number

可選 graphOptimizationLevel

graphOptimizationLevel?: "basic" | "all" | "disabled" | "extended" | "layout"

最佳化級別。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 interOpNumThreads

interOpNumThreads?: number

inter OP 執行緒數。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）中可用。

可選 intraOpNumThreads

intraOpNumThreads?: number

intra OP 執行緒數。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）中可用。

可選 logId

logId?: string

日誌 ID。

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 logSeverityLevel

logSeverityLevel?: 0 | 2 | 1 | 3 | 4

日誌嚴重性級別。請參閱 https://github.com/microsoft/onnxruntime/blob/main/include/onnxruntime/core/common/logging/severity.h

此設定僅在 ONNXRuntime（Node.js 繫結和 React Native）或 WebAssembly 後端中可用

可選 logVerbosityLevel

logVerbosityLevel?: number

日誌詳細級別。

此設定僅在 WebAssembly 後端中可用。稍後將支援 Node.js 繫結和 React Native。

可選 optimizedModelFilePath

optimizedModelFilePath?: string

最佳化後的模型檔案路徑。

如果指定此設定，將轉儲最佳化後的模型。在瀏覽器中，將彈出一個視窗並建立一個 blob。

可選 preferredOutputLocation

preferredOutputLocation?: DataLocation | {
    [outputName: string]: OnnxValueDataLocation;
}

指定一個字串作為所有輸出的首選資料位置，或指定一個使用輸出名稱作為鍵、首選資料位置作為對應值的物件。

此設定僅在 ONNXRuntime Web 的 WebGL 和 WebGPU EP 中可用。

型別宣告

可選 profileFilePrefix

profileFilePrefix?: string

效能分析檔案字首。

此設定為未來用途的佔位符。

設定

成員可見性

主題

本頁內容

使用 TypeDoc 生成