接口 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";
    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?

属性

Optional enableCpuMemArena

enableCpuMemArena?: boolean

是否启用 CPU 内存区域 (memory arena)。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

Optional enableGraphCapture

enableGraphCapture?: boolean

是否启用图捕获。此设置仅在 ONNXRuntime Web 的 WebGPU EP 中可用。

Optional enableMemPattern

enableMemPattern?: boolean

是否启用内存模式。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

Optional enableProfiling

enableProfiling?: boolean

是否启用性能分析。

此设置是未来使用的占位符。

Optional executionMode

executionMode?: "sequential" | "parallel"

执行模式。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

Optional executionProviders

executionProviders?: readonly ExecutionProviderConfig[]

执行提供程序选项的数组。

执行提供程序选项可以是表示执行提供程序名称的字符串，或对应类型的对象。

Optional externalData

externalData?: readonly ExternalDataFileType[]

指定表示外部数据的文件列表。

Optional 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"
  }
}

Optional freeDimensionOverrides

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

自由维度覆盖。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

类型声明

  • [dimensionName: string]: number

Optional graphOptimizationLevel

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

优化级别。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

Optional interOpNumThreads

interOpNumThreads?: number

inter OP 线程数。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）中可用。

Optional intraOpNumThreads

intraOpNumThreads?: number

intra OP 线程数。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）中可用。

Optional logId

logId?: string

日志 ID。

此设置仅在 ONNXRuntime（Node.js 绑定和 react-native）或 WebAssembly 后端中可用

Optional 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 后端中可用

Optional logVerbosityLevel

logVerbosityLevel?: number

日志详细级别。

此设置仅在 WebAssembly 后端中可用。稍后将支持 Node.js 绑定和 react-native

Optional optimizedModelFilePath

optimizedModelFilePath?: string

优化后的模型文件路径。

如果指定此设置，将导出优化后的模型。在浏览器中，将创建一个 Blob 并弹出下载窗口。

Optional preferredOutputLocation

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

指定字符串作为所有输出的首选数据位置，或使用输出名称作为键、首选数据位置作为对应值的对象。

此设置仅在 ONNXRuntime Web 的 WebGL 和 WebGPU EP 中可用。

类型声明

Optional profileFilePrefix

profileFilePrefix?: string

性能分析的文件前缀。

此设置是未来使用的占位符。

设置

成员可见性

主题

本页内容

使用 TypeDoc 生成