mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-14 18:12:05 +00:00
20 lines
9.7 KiB
HTML
20 lines
9.7 KiB
HTML
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>WebAssemblyFlags | 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/Env.html">Env</a></li><li><a href="Env.WebAssemblyFlags.html">WebAssemblyFlags</a></li></ul><h1>Interface WebAssemblyFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">WebAssemblyFlags</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="Env.WebAssemblyFlags.html#initTimeout" class="tsd-kind-icon">init<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#numThreads" class="tsd-kind-icon">num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#proxy" class="tsd-kind-icon">proxy</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#simd" class="tsd-kind-icon">simd</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#wasmPaths" class="tsd-kind-icon">wasm<wbr/>Paths</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="initTimeout" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> init<wbr/>Timeout</h3><div class="tsd-signature tsd-kind-icon">init<wbr/>Timeout<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/env.ts#L38">env.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Set or get a number specifying the timeout for initialization of WebAssembly backend, in milliseconds. A zero
|
||
|
|
value indicates no timeout is set.</p>
|
||
|
|
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>0</code></p>
|
||
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="numThreads" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> num<wbr/>Threads</h3><div class="tsd-signature tsd-kind-icon">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/env.ts#L21">env.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>set or get number of thread(s). If omitted or set to 0, number of thread(s) will be determined by system. If set
|
||
|
|
to 1, no worker thread will be spawned.</p>
|
||
|
|
</div><div><p>This setting is available only when WebAssembly multithread feature is available in current context.</p>
|
||
|
|
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>0</code></p>
|
||
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="proxy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy</h3><div class="tsd-signature tsd-kind-icon">proxy<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/env.ts#L51">env.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Set or get a boolean value indicating whether to proxy the execution of main thread to a worker thread.</p>
|
||
|
|
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>false</code></p>
|
||
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="simd" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> simd</h3><div class="tsd-signature tsd-kind-icon">simd<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/env.ts#L30">env.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>set or get a boolean value indicating whether to enable SIMD. If set to false, SIMD will be forcely disabled.</p>
|
||
|
|
</div><div><p>This setting is available only when WebAssembly SIMD feature is available in current context.</p>
|
||
|
|
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>true</code></p>
|
||
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="wasmPaths" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> wasm<wbr/>Paths</h3><div class="tsd-signature tsd-kind-icon">wasm<wbr/>Paths<span class="tsd-signature-symbol">?:</span> <a href="../modules/Env.html#WasmPrefixOrFilePaths" class="tsd-signature-type" data-tsd-kind="Type alias">WasmPrefixOrFilePaths</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L44">env.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Set a custom URL prefix to the .wasm files or a set of overrides for each .wasm file. The override path should be
|
||
|
|
an absolute path.</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="current tsd-kind-namespace"><a href="../modules/Env.html">Env</a></li><li class=" 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="Env.WebAssemblyFlags.html" class="tsd-kind-icon">Web<wbr/>Assembly<wbr/>Flags</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#initTimeout" class="tsd-kind-icon">init<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#numThreads" class="tsd-kind-icon">num<wbr/>Threads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#proxy" class="tsd-kind-icon">proxy</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#simd" class="tsd-kind-icon">simd</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebAssemblyFlags.html#wasmPaths" class="tsd-kind-icon">wasm<wbr/>Paths</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>
|