saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/js/interfaces/InferenceSession.SessionOptions.html
Yulong Wang 5f7a25509c
[doc] update document for JavaScript API reference (#9080) 
* add js api reference doc

* add landing page

* trivial revise

* update documents
2021-09-20 20:57:54 -05:00

48 lines
No EOL
22 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SessionOptions | ONNX Runtime JavaScript API</title><meta name="description" content="Documentation for ONNX Runtime JavaScript API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ONNX Runtime JavaScript API</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">ONNX Runtime JavaScript API</a></li><li><a href="../modules/InferenceSession.html">InferenceSession</a></li><li><a href="InferenceSession.SessionOptions.html">SessionOptions</a></li></ul><h1>Interface SessionOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>A set of configurations for session behavior.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SessionOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableCpuMemArena" class="tsd-kind-icon">enable<wbr/>Cpu<wbr/>Mem<wbr/>Arena</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableMemPattern" class="tsd-kind-icon">enable<wbr/>Mem<wbr/>Pattern</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableProfiling" class="tsd-kind-icon">enable<wbr/>Profiling</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#executionMode" class="tsd-kind-icon">execution<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#executionProviders" class="tsd-kind-icon">execution<wbr/>Providers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#extra" class="tsd-kind-icon">extra</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#graphOptimizationLevel" class="tsd-kind-icon">graph<wbr/>Optimization<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#interOpNumThreads" class="tsd-kind-icon">inter<wbr/>Op<wbr/>Num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#intraOpNumThreads" class="tsd-kind-icon">intra<wbr/>Op<wbr/>Num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logId" class="tsd-kind-icon">log<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logSeverityLevel" class="tsd-kind-icon">log<wbr/>Severity<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logVerbosityLevel" class="tsd-kind-icon">log<wbr/>Verbosity<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#profileFilePrefix" class="tsd-kind-icon">profile<wbr/>File<wbr/>Prefix</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enableCpuMemArena" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Cpu<wbr/>Mem<wbr/>Arena</h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Cpu<wbr/>Mem<wbr/>Arena<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L81">inference-session.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether enable CPU memory arena.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enableMemPattern" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Mem<wbr/>Pattern</h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Mem<wbr/>Pattern<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L88">inference-session.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether enable memory pattern.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="enableProfiling" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Profiling</h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Profiling<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L102">inference-session.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Wether enable profiling.</p>
</div><div><p>This setting is a placeholder for a future use.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="executionMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> execution<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">execution<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;sequential&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;parallel&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L95">inference-session.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Execution mode.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="executionProviders" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> execution<wbr/>Providers</h3><div class="tsd-signature tsd-kind-icon">execution<wbr/>Providers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">readonly </span><a href="../modules/InferenceSession.html#ExecutionProviderConfig" class="tsd-signature-type" data-tsd-kind="Type alias">ExecutionProviderConfig</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L53">inference-session.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array of execution provider options.</p>
</div><div><p>An execution provider option can be a string indicating the name of the execution provider,
or an object of corresponding type.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="extra" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> extra</h3><div class="tsd-signature tsd-kind-icon">extra<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L153">inference-session.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Store configurations for a session. See
<a href="https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/session/">https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/session/</a>
onnxruntime_session_options_config_keys.h</p>
</div><div><p>This setting is available only in WebAssembly backend. Will support Node.js binding and react-native later</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-js"><span class="hl-0">extra</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-0">set_denormal_as_zero</span><span class="hl-1">: </span><span class="hl-2">&quot;1&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">disable_prepacking</span><span class="hl-1">: </span><span class="hl-2">&quot;1&quot;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">optimization</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-0">enable_gelu_approximation</span><span class="hl-1">: </span><span class="hl-2">&quot;1&quot;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="graphOptimizationLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> graph<wbr/>Optimization<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">graph<wbr/>Optimization<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;disabled&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;basic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;extended&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;all&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L74">inference-session.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The optimization level.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="interOpNumThreads" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> inter<wbr/>Op<wbr/>Num<wbr/>Threads</h3><div class="tsd-signature tsd-kind-icon">inter<wbr/>Op<wbr/>Num<wbr/>Threads<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L67">inference-session.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The inter OP threads number.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="intraOpNumThreads" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> intra<wbr/>Op<wbr/>Num<wbr/>Threads</h3><div class="tsd-signature tsd-kind-icon">intra<wbr/>Op<wbr/>Num<wbr/>Threads<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L60">inference-session.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The intra OP threads number.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="logId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">log<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L116">inference-session.ts:116</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Log ID.</p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="logSeverityLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Severity<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">log<wbr/>Severity<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L124">inference-session.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Log severity level. See
<a href="https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/common/logging/severity.h">https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/common/logging/severity.h</a></p>
</div><div><p>This setting is available only in ONNXRuntime (Node.js binding and react-native) or WebAssembly backend</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="logVerbosityLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Verbosity<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">log<wbr/>Verbosity<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L131">inference-session.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Log verbosity level.</p>
</div><div><p>This setting is available only in WebAssembly backend. Will support Node.js binding and react-native later</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="profileFilePrefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> profile<wbr/>File<wbr/>Prefix</h3><div class="tsd-signature tsd-kind-icon">profile<wbr/>File<wbr/>Prefix<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L109">inference-session.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>File prefix for profiling.</p>
</div><div><p>This setting is a placeholder for a future use.</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/Env.html">Env</a></li><li class="current tsd-kind-namespace"><a href="../modules/InferenceSession.html">Inference<wbr/>Session</a></li><li class=" tsd-kind-namespace"><a href="../modules/Tensor.html">Tensor</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="InferenceSession.SessionOptions.html" class="tsd-kind-icon">Session<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableCpuMemArena" class="tsd-kind-icon">enable<wbr/>Cpu<wbr/>Mem<wbr/>Arena</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableMemPattern" class="tsd-kind-icon">enable<wbr/>Mem<wbr/>Pattern</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#enableProfiling" class="tsd-kind-icon">enable<wbr/>Profiling</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#executionMode" class="tsd-kind-icon">execution<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#executionProviders" class="tsd-kind-icon">execution<wbr/>Providers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#extra" class="tsd-kind-icon">extra</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#graphOptimizationLevel" class="tsd-kind-icon">graph<wbr/>Optimization<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#interOpNumThreads" class="tsd-kind-icon">inter<wbr/>Op<wbr/>Num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#intraOpNumThreads" class="tsd-kind-icon">intra<wbr/>Op<wbr/>Num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logId" class="tsd-kind-icon">log<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logSeverityLevel" class="tsd-kind-icon">log<wbr/>Severity<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#logVerbosityLevel" class="tsd-kind-icon">log<wbr/>Verbosity<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.SessionOptions.html#profileFilePrefix" class="tsd-kind-icon">profile<wbr/>File<wbr/>Prefix</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in a new issue View git blame Copy permalink