saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-20 19:12:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[doc] update document for JavaScript API reference (#9080)

Browse source 
* add js api reference doc

* add landing page

* trivial revise

* update documents
This commit is contained in:
Yulong Wang 2021-09-20 18:57:54 -07:00 committed by GitHub
parent 54c667740f
commit 5f7a25509c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 2806 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/api/index.md
View file

@ -12,4 +12,5 @@ nav_order: 5
| <span class="fs-5"> [Objective C Docs](./objectivec/index.html){: .btn} </span> |
| <span class="fs-5"> [WinRT API Docs](https://docs.microsoft.com/windows/ai/windows-ml/api-reference){: .btn} </span>|
| <span class="fs-5"> [C# API Docs](./csharp-api){: .btn} </span>|
| <span class="fs-5"> [JavaScript API Docs](./js/index.html){: .btn} </span>|
| <span class="fs-5"> [Other API Docs](./other-apis){: .btn} </span>|

10
docs/api/js-api.md Normal file
View file

@ -0,0 +1,10 @@
---
title: JavaScript API
parent: API Docs
nav_order: 6
---
# ONNX Runtime JavaScript API
{: .no_toc }
<span class="fs-5"> [Go to the JavaScript API Docs](./js/index.html){: .btn .mr-4 target="_blank"} </span>

43
docs/api/js/assets/highlight.css Normal file
View file

@ -0,0 +1,43 @@
:root {
--light-hl-0: #000000;
--dark-hl-0: #C8C8C8;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@media (prefers-color-scheme: light) { :root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--code-background: var(--light-code-background);
} }
@media (prefers-color-scheme: dark) { :root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--code-background: var(--dark-code-background);
} }
body.light {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--code-background: var(--light-code-background);
}
body.dark {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--code-background: var(--dark-code-background);
}
.hl-0 { color: var(--hl-0); }
.hl-1 { color: var(--hl-1); }
.hl-2 { color: var(--hl-2); }
pre, code { background: var(--code-background); }

1043
docs/api/js/assets/icons.css Normal file
View file

File diff suppressed because it is too large Load diff

BIN
docs/api/js/assets/icons.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 9.4 KiB

BIN
docs/api/js/assets/icons@2x.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 28 KiB

52
docs/api/js/assets/main.js Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/assets/search.js Normal file
View file

File diff suppressed because one or more lines are too long

1341
docs/api/js/assets/style.css Normal file
View file

File diff suppressed because it is too large Load diff

BIN
docs/api/js/assets/widgets.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 480 B

BIN
docs/api/js/assets/widgets@2x.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 855 B

22
docs/api/js/index.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>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"><h1>ONNX Runtime JavaScript API</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">
<a href="#onnx-runtime-javascript-api" id="onnx-runtime-javascript-api" style="color: inherit; text-decoration: none;">
<h1>ONNX Runtime JavaScript API</h1>
</a>
</div><div><p>ONNX Runtime JavaScript API is a unified API for all JavaScript usages, including the following NPM packages:</p>
<ul>
<li><a href="https://www.npmjs.com/package/onnxruntime-node">onnxruntime-node</a></li>
<li><a href="https://www.npmjs.com/package/onnxruntime-web">onnxruntime-web</a></li>
<li><a href="https://www.npmjs.com/package/onnxruntime-react-native">onnxruntime-react-native</a></li>
</ul>
<p>See also:</p>
<ul>
<li><a href="https://onnxruntime.ai/docs/get-started/with-javascript.html">Get Started</a></li>
<li><a href="https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js">Inference examples</a></li>
</ul>
</div></div></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>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace"><a href="modules/Env.html" class="tsd-kind-icon">Env</a></li><li class="tsd-kind-namespace"><a href="modules/InferenceSession.html" class="tsd-kind-icon">Inference<wbr/>Session</a></li><li class="tsd-kind-namespace"><a href="modules/Tensor.html" class="tsd-kind-icon">Tensor</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/Env.html" class="tsd-kind-icon">Env</a></li><li class="tsd-kind-interface"><a href="interfaces/InferenceSession.html" class="tsd-kind-icon">Inference<wbr/>Session</a></li><li class="tsd-kind-interface"><a href="interfaces/InferenceSessionFactory.html" class="tsd-kind-icon">Inference<wbr/>Session<wbr/>Factory</a></li><li class="tsd-kind-interface"><a href="interfaces/Tensor.html" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-interface"><a href="interfaces/TensorConstructor.html" class="tsd-kind-icon">Tensor<wbr/>Constructor</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/TypedTensor.html" class="tsd-kind-icon">Typed<wbr/>Tensor</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="index.html#OnnxValue" class="tsd-kind-icon">Onnx<wbr/>Value</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable"><a href="index.html#InferenceSession" class="tsd-kind-icon">Inference<wbr/>Session</a></li><li class="tsd-kind-variable"><a href="index.html#Tensor" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-variable"><a href="index.html#env" class="tsd-kind-icon">env</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="OnnxValue" class="tsd-anchor"></a><h3>Onnx<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">Onnx<wbr/>Value<span class="tsd-signature-symbol">:</span> <a href="index.html#Tensor" class="tsd-signature-type" data-tsd-kind="Variable">Tensor</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NonTensorType</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/onnx-value.ts#L13">onnx-value.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type OnnxValue Represents both tensors and non-tensors value for model&#39;s inputs/outputs.</p>
</div><div><p>NOTE: currently not support non-tensor</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a name="InferenceSession" class="tsd-anchor"></a><h3>Inference<wbr/>Session</h3><div class="tsd-signature tsd-kind-icon">Inference<wbr/>Session<span class="tsd-signature-symbol">:</span> <a href="interfaces/InferenceSessionFactory.html" class="tsd-signature-type" data-tsd-kind="Interface">InferenceSessionFactory</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L377">inference-session.ts:377</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a name="Tensor" class="tsd-anchor"></a><h3>Tensor</h3><div class="tsd-signature tsd-kind-icon">Tensor<span class="tsd-signature-symbol">:</span> <a href="interfaces/TensorConstructor.html" class="tsd-signature-type" data-tsd-kind="Interface">TensorConstructor</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L238">tensor.ts:238</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a name="env" class="tsd-anchor"></a><h3>env</h3><div class="tsd-signature tsd-kind-icon">env<span class="tsd-signature-symbol">:</span> <a href="interfaces/Env.html" class="tsd-signature-type" data-tsd-kind="Interface">Env</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/env.ts#L118">env.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Represent a set of flags as a global singleton.</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="current"><a href="index.html">Exports</a></li><li class=" 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="tsd-kind-interface"><a href="interfaces/Env.html" class="tsd-kind-icon">Env</a></li><li class="tsd-kind-interface"><a href="interfaces/InferenceSession.html" class="tsd-kind-icon">Inference<wbr/>Session</a></li><li class="tsd-kind-interface"><a href="interfaces/InferenceSessionFactory.html" class="tsd-kind-icon">Inference<wbr/>Session<wbr/>Factory</a></li><li class="tsd-kind-interface"><a href="interfaces/Tensor.html" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-interface"><a href="interfaces/TensorConstructor.html" class="tsd-kind-icon">Tensor<wbr/>Constructor</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/TypedTensor.html" class="tsd-kind-icon">Typed<wbr/>Tensor</a></li><li class="tsd-kind-type-alias"><a href="index.html#OnnxValue" class="tsd-kind-icon">Onnx<wbr/>Value</a></li><li class="tsd-kind-variable"><a href="index.html#InferenceSession" class="tsd-kind-icon">Inference<wbr/>Session</a></li><li class="tsd-kind-variable"><a href="index.html#Tensor" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-variable"><a href="index.html#env" class="tsd-kind-icon">env</a></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>

20
docs/api/js/interfaces/Env.WebAssemblyFlags.html Normal file
View file

@ -0,0 +1,20 @@
<!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>

15
docs/api/js/interfaces/Env.WebGLFlags.html Normal file
View file

@ -0,0 +1,15 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>WebGLFlags | 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.WebGLFlags.html">WebGLFlags</a></li></ul><h1>Interface WebGLFlags</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">WebGLFlags</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.WebGLFlags.html#async" class="tsd-kind-icon">async</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#contextId" class="tsd-kind-icon">context<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#matmulMaxBatchSize" class="tsd-kind-icon">matmul<wbr/>Max<wbr/>Batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#pack" class="tsd-kind-icon">pack</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#textureCacheMode" class="tsd-kind-icon">texture<wbr/>Cache<wbr/>Mode</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="async" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> async</h3><div class="tsd-signature tsd-kind-icon">async<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#L84">env.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set or get whether enable async download.</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="contextId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> context<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">context<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;webgl&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;webgl2&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L60">env.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set or get the WebGL Context ID (webgl or webgl2).</p>
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>&#39;webgl2&#39;</code></p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="matmulMaxBatchSize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> matmul<wbr/>Max<wbr/>Batch<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">matmul<wbr/>Max<wbr/>Batch<wbr/>Size<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#L66">env.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set or get the maximum batch size for matmul. 0 means to disable batching.</p>
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="pack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> pack</h3><div class="tsd-signature tsd-kind-icon">pack<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#L78">env.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set or get the packed texture mode</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="textureCacheMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> texture<wbr/>Cache<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">texture<wbr/>Cache<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;initializerOnly&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L72">env.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set or get the texture cache mode.</p>
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>&#39;full&#39;</code></p>
</dd></dl></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.WebGLFlags.html" class="tsd-kind-icon">WebGLFlags</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#async" class="tsd-kind-icon">async</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#contextId" class="tsd-kind-icon">context<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#matmulMaxBatchSize" class="tsd-kind-icon">matmul<wbr/>Max<wbr/>Batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#pack" class="tsd-kind-icon">pack</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.WebGLFlags.html#textureCacheMode" class="tsd-kind-icon">texture<wbr/>Cache<wbr/>Mode</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>

11
docs/api/js/interfaces/Env.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Env | 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="Env.html">Env</a></li></ul><h1>Interface Env</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">Env</span></li></ul></section><section class="tsd-panel tsd-kind-interface"><h3 class="tsd-before-signature">Indexable</h3><div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></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.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#logLevel" class="tsd-kind-icon">log<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#wasm" class="tsd-kind-icon">wasm</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#webgl" class="tsd-kind-icon">webgl</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="debug" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> debug</h3><div class="tsd-signature tsd-kind-icon">debug<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#L100">env.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Indicate whether run in debug mode.</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="logLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Level</h3><div class="tsd-signature tsd-kind-icon">log<wbr/>Level<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;verbose&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;warning&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;error&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fatal&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L94">env.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>set the severity level for logging.</p>
</div><dl class="tsd-comment-tags"><dt>defaultvalue</dt><dd><p><code>&#39;warning&#39;</code></p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="wasm" class="tsd-anchor"></a><h3>wasm</h3><div class="tsd-signature tsd-kind-icon">wasm<span class="tsd-signature-symbol">:</span> <a href="Env.WebAssemblyFlags.html" class="tsd-signature-type" data-tsd-kind="Interface">WebAssemblyFlags</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L105">env.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Represent a set of flags for WebAssembly</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="webgl" class="tsd-anchor"></a><h3>webgl</h3><div class="tsd-signature tsd-kind-icon">webgl<span class="tsd-signature-symbol">:</span> <a href="Env.WebGLFlags.html" class="tsd-signature-type" data-tsd-kind="Interface">WebGLFlags</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/env.ts#L110">env.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Represent a set of flags for WebGL</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=" 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"><a href="Env.html" class="tsd-kind-icon">Env</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#logLevel" class="tsd-kind-icon">log<wbr/>Level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#wasm" class="tsd-kind-icon">wasm</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Env.html#webgl" class="tsd-kind-icon">webgl</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>

1
docs/api/js/interfaces/InferenceSession.CpuExecutionProviderOption.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/InferenceSession.CudaExecutionProviderOption.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/InferenceSession.ExecutionProviderOption.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/InferenceSession.ExecutionProviderOptionMap.html Normal file
View file

File diff suppressed because one or more lines are too long

23
docs/api/js/interfaces/InferenceSession.RunOptions.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>RunOptions | 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.RunOptions.html">RunOptions</a></li></ul><h1>Interface RunOptions</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 inference run behavior</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RunOptions</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.RunOptions.html#extra" class="tsd-kind-icon">extra</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.RunOptions.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.RunOptions.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.RunOptions.html#tag" class="tsd-kind-icon">tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.RunOptions.html#terminate" class="tsd-kind-icon">terminate</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="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#L248">inference-session.ts:248</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set a single run configuration entry. 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_run_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">memory</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-0">enable_memory_arena_shrinkage</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><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="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#L208">inference-session.ts:208</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#L215">inference-session.ts:215</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="tag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tag</h3><div class="tsd-signature tsd-kind-icon">tag<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#L229">inference-session.ts:229</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A tag for the Run() calls using this</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="terminate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> terminate</h3><div class="tsd-signature tsd-kind-icon">terminate<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#L222">inference-session.ts:222</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Terminate all incomplete OrtRun calls as soon as possible if true</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></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.RunOptions.html" class="tsd-kind-icon">Run<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.RunOptions.html#extra" class="tsd-kind-icon">extra</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.RunOptions.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.RunOptions.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.RunOptions.html#tag" class="tsd-kind-icon">tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.RunOptions.html#terminate" class="tsd-kind-icon">terminate</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>

48
docs/api/js/interfaces/InferenceSession.SessionOptions.html Normal file
View file

@ -0,0 +1,48 @@
<!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>

1
docs/api/js/interfaces/InferenceSession.ValueMetadata.html Normal file
View file

@ -0,0 +1 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ValueMetadata | 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.ValueMetadata.html">ValueMetadata</a></li></ul><h1>Interface ValueMetadata</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">ValueMetadata</span></li></ul></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.ValueMetadata.html" class="tsd-kind-icon">Value<wbr/>Metadata</a><ul></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>

1
docs/api/js/interfaces/InferenceSession.WebAssemblyExecutionProviderOption.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/InferenceSession.WebGLExecutionProviderOption.html Normal file
View file

File diff suppressed because one or more lines are too long

23
docs/api/js/interfaces/InferenceSession.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>InferenceSession | 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="InferenceSession.html">InferenceSession</a></li></ul><h1>Interface InferenceSession</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>Represent a runtime instance of an ONNX model.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">InferenceSession</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.html#inputNames" class="tsd-kind-icon">input<wbr/>Names</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.html#outputNames" class="tsd-kind-icon">output<wbr/>Names</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#endProfiling" class="tsd-kind-icon">end<wbr/>Profiling</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#startProfiling" class="tsd-kind-icon">start<wbr/>Profiling</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="inputNames" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> input<wbr/>Names</h3><div class="tsd-signature tsd-kind-icon">input<wbr/>Names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><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#L311">inference-session.ts:311</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get input names of the loaded model.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="outputNames" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> output<wbr/>Names</h3><div class="tsd-signature tsd-kind-icon">output<wbr/>Names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><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#L316">inference-session.ts:316</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get output names of the loaded model.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="endProfiling" class="tsd-anchor"></a><h3>end<wbr/>Profiling</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">end<wbr/>Profiling<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L302">inference-session.ts:302</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>End profiling.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="run" class="tsd-anchor"></a><h3>run</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>feeds<span class="tsd-signature-symbol">: </span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.RunOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RunOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>feeds<span class="tsd-signature-symbol">: </span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a>, fetches<span class="tsd-signature-symbol">: </span><a href="../modules/InferenceSession.html#FetchesType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchesType</a>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.RunOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RunOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L276">inference-session.ts:276</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Execute the model asynchronously with the given feeds and options.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>feeds: <a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a></h5><div class="tsd-comment tsd-typography"><div><p>Representation of the model input. See type description of <code>InferenceSession.InputType</code> for detail.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.RunOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RunOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>Optional. A set of options that controls the behavior of model inference.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to a map, which uses output names as keys and OnnxValue as corresponding values.</p>
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L287">inference-session.ts:287</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Execute the model asynchronously with the given feeds, fetches and options.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>feeds: <a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a></h5><div class="tsd-comment tsd-typography"><div><p>Representation of the model input. See type description of <code>InferenceSession.InputType</code> for detail.</p>
</div></div></li><li><h5>fetches: <a href="../modules/InferenceSession.html#FetchesType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchesType</a></h5><div class="tsd-comment tsd-typography"><div><p>Representation of the model output. See type description of <code>InferenceSession.OutputType</code> for
detail.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.RunOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RunOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>Optional. A set of options that controls the behavior of model inference.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to a map, which uses output names as keys and OnnxValue as corresponding values.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="startProfiling" class="tsd-anchor"></a><h3>start<wbr/>Profiling</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">start<wbr/>Profiling<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/inference-session.ts#L297">inference-session.ts:297</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Start profiling.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></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=" 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"><a href="InferenceSession.html" class="tsd-kind-icon">Inference<wbr/>Session</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.html#inputNames" class="tsd-kind-icon">input<wbr/>Names</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="InferenceSession.html#outputNames" class="tsd-kind-icon">output<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#endProfiling" class="tsd-kind-icon">end<wbr/>Profiling</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSession.html#startProfiling" class="tsd-kind-icon">start<wbr/>Profiling</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>

23
docs/api/js/interfaces/InferenceSessionFactory.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/Tensor.DataTypeMap.html Normal file
View file

File diff suppressed because one or more lines are too long

1
docs/api/js/interfaces/Tensor.ElementTypeMap.html Normal file
View file

File diff suppressed because one or more lines are too long

14
docs/api/js/interfaces/Tensor.html Normal file
View file

@ -0,0 +1,14 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tensor | 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="Tensor.html">Tensor</a></li></ul><h1>Interface Tensor</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>Represent multi-dimensional arrays to feed to or fetch from model inferencing.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypedTensorBase</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/Tensor.html#Type" class="tsd-signature-type" data-tsd-kind="Type alias">Type</a><span class="tsd-signature-symbol">&gt;</span></li><li><span class="tsd-signature-type">TypedTensorUtils</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/Tensor.html#Type" class="tsd-signature-type" data-tsd-kind="Type alias">Type</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">Tensor</span></li></ul></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 tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#dims" class="tsd-kind-icon">dims</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#reshape" class="tsd-kind-icon">reshape</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int16Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigInt64Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float64Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigUint64Array</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.data</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L24">tensor.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the buffer data of the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dims" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dims</h3><div class="tsd-signature tsd-kind-icon">dims<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.dims</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L16">tensor.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the dimensions of the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="size" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> size</h3><div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorUtils.size</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor-utils.ts#L10">tensor-utils.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the number of elements in the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><a href="Tensor.DataTypeMap.html" class="tsd-signature-type" data-tsd-kind="Interface">DataTypeMap</a></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.type</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L20">tensor.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the data type of the tensor.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a name="reshape" class="tsd-anchor"></a><h3>reshape</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">reshape<span class="tsd-signature-symbol">(</span>dims<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TypedTensor.html" class="tsd-signature-type" data-tsd-kind="Interface">TypedTensor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">keyof </span><a href="Tensor.DataTypeMap.html" class="tsd-signature-type" data-tsd-kind="Interface">DataTypeMap</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from TypedTensorUtils.reshape</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor-utils.ts#L19">tensor-utils.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new tensor with the same data buffer and specified dims.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dims: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div><p>New dimensions. Size should match the old one.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="TypedTensor.html" class="tsd-signature-type" data-tsd-kind="Interface">TypedTensor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">keyof </span><a href="Tensor.DataTypeMap.html" class="tsd-signature-type" data-tsd-kind="Interface">DataTypeMap</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></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=" 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"><a href="Tensor.html" class="tsd-kind-icon">Tensor</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#dims" class="tsd-kind-icon">dims</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="Tensor.html#reshape" class="tsd-kind-icon">reshape</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>

73
docs/api/js/interfaces/TensorConstructor.html Normal file
View file

File diff suppressed because one or more lines are too long

14
docs/api/js/interfaces/TypedTensor.html Normal file
View file

@ -0,0 +1,14 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TypedTensor | 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="TypedTensor.html">TypedTensor</a></li></ul><h1>Interface TypedTensor&lt;T&gt;</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>Represent multi-dimensional arrays to feed to or fetch from model inferencing.</p>
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/Tensor.html#Type" class="tsd-signature-type" data-tsd-kind="Type alias">Type</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypedTensorBase</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li><li><span class="tsd-signature-type">TypedTensorUtils</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">TypedTensor</span></li></ul></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 tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#dims" class="tsd-kind-icon">dims</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#type" class="tsd-kind-icon">type</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#reshape" class="tsd-kind-icon">reshape</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="Tensor.DataTypeMap.html" class="tsd-signature-type" data-tsd-kind="Interface">DataTypeMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.data</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L24">tensor.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the buffer data of the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dims" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> dims</h3><div class="tsd-signature tsd-kind-icon">dims<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.dims</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L16">tensor.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the dimensions of the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="size" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> size</h3><div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorUtils.size</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor-utils.ts#L10">tensor-utils.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the number of elements in the tensor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><p>Inherited from TypedTensorBase.type</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor.ts#L20">tensor.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the data type of the tensor.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a name="reshape" class="tsd-anchor"></a><h3>reshape</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">reshape<span class="tsd-signature-symbol">(</span>dims<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TypedTensor.html" class="tsd-signature-type" data-tsd-kind="Interface">TypedTensor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from TypedTensorUtils.reshape</p><ul><li>Defined in <a href="https://github.com/microsoft/onnxruntime/blob/49b329e26/js/common/lib/tensor-utils.ts#L19">tensor-utils.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new tensor with the same data buffer and specified dims.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dims: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div><p>New dimensions. Size should match the old one.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="TypedTensor.html" class="tsd-signature-type" data-tsd-kind="Interface">TypedTensor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></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=" 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-has-type-parameter"><a href="TypedTensor.html" class="tsd-kind-icon">Typed<wbr/>Tensor</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#dims" class="tsd-kind-icon">dims</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="TypedTensor.html#reshape" class="tsd-kind-icon">reshape</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>

1
docs/api/js/modules/Env.html Normal file
View file

File diff suppressed because one or more lines are too long

15
docs/api/js/modules/InferenceSession.html Normal file
View file

File diff suppressed because one or more lines are too long

3
docs/api/js/modules/Tensor.html Normal file
View file

File diff suppressed because one or more lines are too long

2
docs/api/other-apis.md
View file

@ -1,7 +1,7 @@
---
title: Other Inference APIs
parent: API Docs
nav_order: 6
nav_order: 7
---
# Other APIs