saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/js/interfaces/InferenceSessionFactory.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

23 lines
No EOL
13 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>InferenceSessionFactory | 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="InferenceSessionFactory.html">InferenceSessionFactory</a></li></ul><h1>Interface InferenceSessionFactory</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">InferenceSessionFactory</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSessionFactory.html#create" class="tsd-kind-icon">create</a></li></ul></section></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="create" class="tsd-anchor"></a><h3>create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBufferLike</span>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBufferLike</span>, byteOffset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, byteLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, options<span class="tsd-signature-symbol">?: </span><a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</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#L341">inference-session.ts:341</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new inference session and load model asynchronously from an ONNX model file.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>The URI or file path of the model to load.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>specify configuration for creating a new inference session.</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to an InferenceSession object.</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#L350">inference-session.ts:350</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new inference session and load model asynchronously from an array bufer.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>buffer: <span class="tsd-signature-type">ArrayBufferLike</span></h5><div class="tsd-comment tsd-typography"><div><p>An ArrayBuffer representation of an ONNX model.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>specify configuration for creating a new inference session.</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to an InferenceSession object.</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#L361">inference-session.ts:361</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new inference session and load model asynchronously from segment of an array bufer.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>buffer: <span class="tsd-signature-type">ArrayBufferLike</span></h5><div class="tsd-comment tsd-typography"><div><p>An ArrayBuffer representation of an ONNX model.</p>
</div></div></li><li><h5>byteOffset: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>The beginning of the specified portion of the array buffer.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> byteLength: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>The length in bytes of the array buffer.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>specify configuration for creating a new inference session.</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to an InferenceSession object.</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#L371">inference-session.ts:371</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new inference session and load model asynchronously from a Uint8Array.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>buffer: <span class="tsd-signature-type">Uint8Array</span></h5><div class="tsd-comment tsd-typography"><div><p>A Uint8Array representation of an ONNX model.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="InferenceSession.SessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SessionOptions</a></h5><div class="tsd-comment tsd-typography"><div><p>specify configuration for creating a new inference session.</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="../index.html#InferenceSession" class="tsd-signature-type" data-tsd-kind="Variable">InferenceSession</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves to an InferenceSession object.</p>
</div></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="InferenceSessionFactory.html" class="tsd-kind-icon">Inference<wbr/>Session<wbr/>Factory</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="InferenceSessionFactory.html#create" class="tsd-kind-icon">create</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in a new issue View git blame Copy permalink