onnxruntime/docs/api/js/interfaces/Env.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

11 lines
No EOL
8.2 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>