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

* add landing page

* trivial revise

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

15 lines
No EOL
16 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>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>Namespace InferenceSession</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.CpuExecutionProviderOption.html" class="tsd-kind-icon">Cpu<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.CudaExecutionProviderOption.html" class="tsd-kind-icon">Cuda<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ExecutionProviderOption.html" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ExecutionProviderOptionMap.html" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Option<wbr/>Map</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.RunOptions.html" class="tsd-kind-icon">Run<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.SessionOptions.html" class="tsd-kind-icon">Session<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ValueMetadata.html" class="tsd-kind-icon">Value<wbr/>Metadata</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.WebAssemblyExecutionProviderOption.html" class="tsd-kind-icon">Web<wbr/>Assembly<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.WebGLExecutionProviderOption.html" class="tsd-kind-icon">WebGLExecution<wbr/>Provider<wbr/>Option</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ExecutionProviderConfig" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Config</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ExecutionProviderName" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Name</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#FeedsType" class="tsd-kind-icon">Feeds<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#FetchesType" class="tsd-kind-icon">Fetches<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#NullableOnnxValueMapType" class="tsd-kind-icon">Nullable<wbr/>Onnx<wbr/>Value<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#OnnxValueMapType" class="tsd-kind-icon">Onnx<wbr/>Value<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ReturnType" class="tsd-kind-icon">Return<wbr/>Type</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 tsd-parent-kind-namespace"><a name="ExecutionProviderConfig" class="tsd-anchor"></a><h3>Execution<wbr/>Provider<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Execution<wbr/>Provider<wbr/>Config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/InferenceSession.ExecutionProviderOptionMap.html" class="tsd-signature-type" data-tsd-kind="Interface">ExecutionProviderOptionMap</a><span class="tsd-signature-symbol">[</span><a href="InferenceSession.html#ExecutionProviderName" class="tsd-signature-type" data-tsd-kind="Type alias">ExecutionProviderName</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/InferenceSession.ExecutionProviderOption.html" class="tsd-signature-type" data-tsd-kind="Interface">ExecutionProviderOption</a><span class="tsd-signature-symbol"> | </span><a href="InferenceSession.html#ExecutionProviderName" class="tsd-signature-type" data-tsd-kind="Type alias">ExecutionProviderName</a><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#L170">inference-session.ts:170</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="ExecutionProviderName" class="tsd-anchor"></a><h3>Execution<wbr/>Provider<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">Execution<wbr/>Provider<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><a href="../interfaces/InferenceSession.ExecutionProviderOptionMap.html" class="tsd-signature-type" data-tsd-kind="Interface">ExecutionProviderOptionMap</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#L169">inference-session.ts:169</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="FeedsType" class="tsd-anchor"></a><h3>Feeds<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Feeds<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</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#L18">inference-session.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A feeds (model inputs) is an object that uses input names as keys and OnnxValue as corresponding values.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="FetchesType" class="tsd-anchor"></a><h3>Fetches<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Fetches<wbr/>Type<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><span class="tsd-signature-symbol"> | </span><a href="InferenceSession.html#NullableOnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">NullableOnnxValueMapType</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#L32">inference-session.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A fetches (model outputs) could be one of the following:</p>
</div><div><ul>
<li>Omitted. Use model&#39;s output names definition.</li>
<li>An array of string indicating the output names.</li>
<li>An object that use output names as keys and OnnxValue or null as corresponding values.</li>
</ul>
</div><dl class="tsd-comment-tags"><dt>remark</dt><dd><p>different from input argument, in output, OnnxValue is optional. If an OnnxValue is present it will be
used as a pre-allocated value by the inference engine; if omitted, inference engine will allocate buffer
internally.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="NullableOnnxValueMapType" class="tsd-anchor"></a><h3>Nullable<wbr/>Onnx<wbr/>Value<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Nullable<wbr/>Onnx<wbr/>Value<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</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#L13">inference-session.ts:13</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../index.html#OnnxValue" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValue</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="OnnxValueMapType" class="tsd-anchor"></a><h3>Onnx<wbr/>Value<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Onnx<wbr/>Value<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</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#L12">inference-session.ts:12</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../index.html#OnnxValue" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValue</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="ReturnType" class="tsd-anchor"></a><h3>Return<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Return<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="InferenceSession.html#OnnxValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">OnnxValueMapType</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#L37">inference-session.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A inferencing return type is an object that uses output names as keys and OnnxValue as corresponding values.</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="Env.html">Env</a></li><li class="current tsd-kind-namespace"><a href="InferenceSession.html">Inference<wbr/>Session</a></li><li class=" tsd-kind-namespace"><a href="Tensor.html">Tensor</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.CpuExecutionProviderOption.html" class="tsd-kind-icon">Cpu<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.CudaExecutionProviderOption.html" class="tsd-kind-icon">Cuda<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ExecutionProviderOption.html" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ExecutionProviderOptionMap.html" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Option<wbr/>Map</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.RunOptions.html" class="tsd-kind-icon">Run<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.SessionOptions.html" class="tsd-kind-icon">Session<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.ValueMetadata.html" class="tsd-kind-icon">Value<wbr/>Metadata</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.WebAssemblyExecutionProviderOption.html" class="tsd-kind-icon">Web<wbr/>Assembly<wbr/>Execution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/InferenceSession.WebGLExecutionProviderOption.html" class="tsd-kind-icon">WebGLExecution<wbr/>Provider<wbr/>Option</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ExecutionProviderConfig" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Config</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ExecutionProviderName" class="tsd-kind-icon">Execution<wbr/>Provider<wbr/>Name</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#FeedsType" class="tsd-kind-icon">Feeds<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#FetchesType" class="tsd-kind-icon">Fetches<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#NullableOnnxValueMapType" class="tsd-kind-icon">Nullable<wbr/>Onnx<wbr/>Value<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#OnnxValueMapType" class="tsd-kind-icon">Onnx<wbr/>Value<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="InferenceSession.html#ReturnType" class="tsd-kind-icon">Return<wbr/>Type</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>
Reference in a new issue View git blame Copy permalink