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/index.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

22 lines
No EOL
9.8 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>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>
Reference in a new issue View git blame Copy permalink