saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-15 18:23:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.html
Cassie a0f3e30de6
Docs update: updated nav, get started sections, home page, apis (#9060) 
* initial setup and rename "how to" to "setup"

* move API to main nav

* move api to main nav

* add get starated, rework nav order

* rename to install move mds out of install section

* update api nav and home page

* add install docs and python qs updates

* python get started work

* remove c and obj c for now

* move java, python, and obj-c docs under api folder

* move java api html to iframe (ugh)

* remove api docs w/o details, move api text getstar

* remove api docs wo detail updates get started

* remvoe iframes

* move eco system to main nav

* fix api buttons

* added more examples moved intro to ORT

* fix links

* fix get started titles

* fix get started titles

* fix more links

* fix more links

* more link fixes

* fix nav remove inferencing and training subnav

* fix top nav remove inference and training nav

* fix title

* fix tutorials nav hierarchy

* fix python api button

* add tenorflow keras example

* fix quickstart toc

* add imports fix spacing

* fix links

* update nav and python get started page

* move ort training example, add coming soon for iot

* update C# get started

* fix spacing on quantization

* Add some js get started content

* fix formatting

* fix typo

* removed onnx-pytorch and onnx-tf

* updated pip install torch and added links iot page

* added pytorch tutorial heirarchy

* updated web to docs soon added release blog link

* add web link
2021-09-15 16:23:42 -05:00

646 lines
27 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_221) on Fri Dec 06 15:15:32 EST 2019 -->
<title>OrtSession.SessionOptions (OnnxRuntime-Java-API)</title>
<meta name="date" content="2019-12-06">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OrtSession.SessionOptions (OnnxRuntime-Java-API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OrtSession.SessionOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtSession.SessionOptions.html" target="_top">Frames</a></li>
<li><a href="OrtSession.SessionOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ai.onnxruntime</div>
<h2 title="Class OrtSession.SessionOptions" class="title">Class OrtSession.SessionOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OrtSession.SessionOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.AutoCloseable</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">OrtSession.SessionOptions</span>
extends java.lang.Object
implements java.lang.AutoCloseable</pre>
<div class="block">Represents the options used to construct this session.
<p>
Used to set the number of threads, optimisation level, computation backend and other options.
<p>
Modifying this after the session has been constructed will have no effect.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.ExecutionMode</a></span></code>
<div class="block">The execution mode to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.OptLevel</a></span></code>
<div class="block">The optimisation level to use.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#SessionOptions--">SessionOptions</a></span>()</code>
<div class="block">Create an empty session options.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addCPU-boolean-">addCPU</a></span>(boolean&nbsp;useArena)</code>
<div class="block">Adds the CPU as an execution backend, using the arena allocator if desired.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addCUDA--">addCUDA</a></span>()</code>
<div class="block">Add CUDA as an execution backend, using device 0.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addCUDA-int-">addCUDA</a></span>(int&nbsp;deviceNum)</code>
<div class="block">Add CUDA as an execution backend, using the specified CUDA device id.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addDnnl-boolean-">addDnnl</a></span>(boolean&nbsp;useArena)</code>
<div class="block">Adds Intel's Deep Neural Network Library as an execution backend.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addNGraph-java.lang.String-">addNGraph</a></span>(java.lang.String&nbsp;ngBackendType)</code>
<div class="block">Adds NGraph as an execution backend.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addNnapi--">addNnapi</a></span>()</code>
<div class="block">Adds Android's NNAPI as an execution backend.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addNuphar-boolean-java.lang.String-">addNuphar</a></span>(boolean&nbsp;allowUnalignedBuffers,
java.lang.String&nbsp;settings)</code>
<div class="block">Adds Nuphar as an execution backend.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addOpenVINO-java.lang.String-">addOpenVINO</a></span>(java.lang.String&nbsp;deviceId)</code>
<div class="block">Adds OpenVINO as an execution backend.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#addTensorrt-int-">addTensorrt</a></span>(int&nbsp;deviceNum)</code>
<div class="block">Adds Nvidia's TensorRT as an execution backend.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#close--">close</a></span>()</code>
<div class="block">Closes the session options, releasing any memory acquired.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#setExecutionMode-ai.onnxruntime.OrtSession.SessionOptions.ExecutionMode-">setExecutionMode</a></span>(<a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.ExecutionMode</a>&nbsp;mode)</code>
<div class="block">Sets the execution mode of this options object, overriding the old setting.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#setInterOpNumThreads-int-">setInterOpNumThreads</a></span>(int&nbsp;numThreads)</code>
<div class="block">Sets the size of the CPU thread pool used for executing multiple request concurrently, if executing on a CPU.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#setIntraOpNumThreads-int-">setIntraOpNumThreads</a></span>(int&nbsp;numThreads)</code>
<div class="block">Sets the size of the CPU thread pool used for executing a single graph, if executing on a CPU.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#setOptimizationLevel-ai.onnxruntime.OrtSession.SessionOptions.OptLevel-">setOptimizationLevel</a></span>(<a href="../../ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.OptLevel</a>&nbsp;level)</code>
<div class="block">Sets the optimization level of this options object, overriding the old setting.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html#setOptimizedModelFilePath-java.lang.String-">setOptimizedModelFilePath</a></span>(java.lang.String&nbsp;outputPath)</code>
<div class="block">Sets the output path for the optimized model.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SessionOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SessionOptions</h4>
<pre>public&nbsp;SessionOptions()</pre>
<div class="block">Create an empty session options.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">Closes the session options, releasing any memory acquired.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
</dl>
</li>
</ul>
<a name="setExecutionMode-ai.onnxruntime.OrtSession.SessionOptions.ExecutionMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExecutionMode</h4>
<pre>public&nbsp;void&nbsp;setExecutionMode(<a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.ExecutionMode</a>&nbsp;mode)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Sets the execution mode of this options object, overriding the old setting.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - The execution mode to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="setOptimizationLevel-ai.onnxruntime.OrtSession.SessionOptions.OptLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOptimizationLevel</h4>
<pre>public&nbsp;void&nbsp;setOptimizationLevel(<a href="../../ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.OptLevel</a>&nbsp;level)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Sets the optimization level of this options object, overriding the old setting.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - The optimization level to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="setInterOpNumThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInterOpNumThreads</h4>
<pre>public&nbsp;void&nbsp;setInterOpNumThreads(int&nbsp;numThreads)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Sets the size of the CPU thread pool used for executing multiple request concurrently, if executing on a CPU.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numThreads</code> - The number of threads to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="setIntraOpNumThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIntraOpNumThreads</h4>
<pre>public&nbsp;void&nbsp;setIntraOpNumThreads(int&nbsp;numThreads)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Sets the size of the CPU thread pool used for executing a single graph, if executing on a CPU.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numThreads</code> - The number of threads to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="setOptimizedModelFilePath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOptimizedModelFilePath</h4>
<pre>public&nbsp;void&nbsp;setOptimizedModelFilePath(java.lang.String&nbsp;outputPath)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Sets the output path for the optimized model.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputPath</code> - The output path to write the model to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addCUDA--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCUDA</h4>
<pre>public&nbsp;void&nbsp;addCUDA()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Add CUDA as an execution backend, using device 0.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addCUDA-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCUDA</h4>
<pre>public&nbsp;void&nbsp;addCUDA(int&nbsp;deviceNum)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Add CUDA as an execution backend, using the specified CUDA device id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deviceNum</code> - The CUDA device id.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addCPU-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCPU</h4>
<pre>public&nbsp;void&nbsp;addCPU(boolean&nbsp;useArena)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds the CPU as an execution backend, using the arena allocator if desired.
<p>
By default this backend is used, but if other backends are requested,
it should be requested last.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useArena</code> - If true use the arena memory allocator.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addDnnl-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDnnl</h4>
<pre>public&nbsp;void&nbsp;addDnnl(boolean&nbsp;useArena)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds Intel's Deep Neural Network Library as an execution backend.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useArena</code> - If true use the arena memory allocator.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addNGraph-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNGraph</h4>
<pre>public&nbsp;void&nbsp;addNGraph(java.lang.String&nbsp;ngBackendType)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds NGraph as an execution backend.
<p>
See the documentation for the supported backend types.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ngBackendType</code> - The NGraph backend type.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addOpenVINO-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOpenVINO</h4>
<pre>public&nbsp;void&nbsp;addOpenVINO(java.lang.String&nbsp;deviceId)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds OpenVINO as an execution backend.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deviceId</code> - The id of the OpenVINO execution device.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addTensorrt-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTensorrt</h4>
<pre>public&nbsp;void&nbsp;addTensorrt(int&nbsp;deviceNum)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds Nvidia's TensorRT as an execution backend.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deviceNum</code> - The id of the CUDA device.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addNnapi--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNnapi</h4>
<pre>public&nbsp;void&nbsp;addNnapi()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds Android's NNAPI as an execution backend.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
<a name="addNuphar-boolean-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addNuphar</h4>
<pre>public&nbsp;void&nbsp;addNuphar(boolean&nbsp;allowUnalignedBuffers,
java.lang.String&nbsp;settings)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Adds Nuphar as an execution backend.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowUnalignedBuffers</code> - Allow unaligned memory buffers.</dd>
<dd><code>settings</code> - See the documentation for valid settings strings.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If there was an error in native code.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OrtSession.SessionOptions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtSession.SessionOptions.html" target="_top">Frames</a></li>
<li><a href="OrtSession.SessionOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink