onnxruntime/java/ai/onnxruntime/OrtSession.html
Adam Pocock a2e4914279 Adding Javadoc to the website (#2554)
* Adding Javadoc to the website.

* Updated javadoc.
2019-12-15 12:58:06 -08:00

486 lines
20 KiB
HTML

<!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:31 EST 2019 -->
<title>OrtSession (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 (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};
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.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/OrtException.OrtErrorCode.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtSession.html" target="_top">Frames</a></li>
<li><a href="OrtSession.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>Constr&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>Constr&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" class="title">Class OrtSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OrtSession</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">OrtSession</span>
extends java.lang.Object
implements java.lang.AutoCloseable</pre>
<div class="block">Wraps an ONNX model and allows inference calls.
<p>
Allows the inspection of the model's input and output nodes.
Produced by an <a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime"><code>OrtEnvironment</code></a>.
<p>
Most instance methods throw <code>IllegalStateException</code> if the
session is closed and the methods are called.</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.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a></span></code>
<div class="block">An <code>AutoCloseable</code> wrapper around a <code>Map</code> containing <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>s.</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.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a></span></code>
<div class="block">Represents the options used to construct this session.</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.html#close--">close</a></span>()</code>
<div class="block">Closes the session, releasing it's resources.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/NodeInfo.html" title="class in ai.onnxruntime">NodeInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getInputInfo--">getInputInfo</a></span>()</code>
<div class="block">Returns the info objects for the inputs, including their names and types.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getInputNames--">getInputNames</a></span>()</code>
<div class="block">Returns the input names.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getNumInputs--">getNumInputs</a></span>()</code>
<div class="block">Returns the number of inputs this model expects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getNumOutputs--">getNumOutputs</a></span>()</code>
<div class="block">Returns the number of outputs this model expects.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/NodeInfo.html" title="class in ai.onnxruntime">NodeInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getOutputInfo--">getOutputInfo</a></span>()</code>
<div class="block">Returns the info objects for the outputs, including their names and types.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#getOutputNames--">getOutputNames</a></span>()</code>
<div class="block">Returns the output names.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#run-java.util.Map-">run</a></span>(java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&gt;&nbsp;inputs)</code>
<div class="block">Scores an input feed dict, returning the map of all inferred outputs.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#run-java.util.Map-java.util.Set-">run</a></span>(java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&gt;&nbsp;inputs,
java.util.Set&lt;java.lang.String&gt;&nbsp;requestedOutputs)</code>
<div class="block">Scores an input feed dict, returning the map of requested inferred outputs.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.html#toString--">toString</a></span>()</code>&nbsp;</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, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNumInputs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumInputs</h4>
<pre>public&nbsp;long&nbsp;getNumInputs()</pre>
<div class="block">Returns the number of inputs this model expects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of inputs.</dd>
</dl>
</li>
</ul>
<a name="getNumOutputs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumOutputs</h4>
<pre>public&nbsp;long&nbsp;getNumOutputs()</pre>
<div class="block">Returns the number of outputs this model expects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of outputs.</dd>
</dl>
</li>
</ul>
<a name="getInputNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputNames</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getInputNames()</pre>
<div class="block">Returns the input names. The underlying collection is sorted based on the input id number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The input names.</dd>
</dl>
</li>
</ul>
<a name="getOutputNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputNames</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getOutputNames()</pre>
<div class="block">Returns the output names. The underlying collection is sorted based on the output id number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The output names.</dd>
</dl>
</li>
</ul>
<a name="getInputInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputInfo</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/NodeInfo.html" title="class in ai.onnxruntime">NodeInfo</a>&gt;&nbsp;getInputInfo()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Returns the info objects for the inputs, including their names and types.
The underlying collection is sorted based on the input id number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The input information.</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="getOutputInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputInfo</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/NodeInfo.html" title="class in ai.onnxruntime">NodeInfo</a>&gt;&nbsp;getOutputInfo()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Returns the info objects for the outputs, including their names and types.
The underlying collection is sorted based on the output id number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The output information.</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="run-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a>&nbsp;run(java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&gt;&nbsp;inputs)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Scores an input feed dict, returning the map of all inferred outputs.
<p>
The outputs are sorted based on their id number.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputs</code> - The inputs to score.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The inferred outputs.</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, the input names are invalid, or if there are zero or too many inputs.</dd>
</dl>
</li>
</ul>
<a name="run-java.util.Map-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a>&nbsp;run(java.util.Map&lt;java.lang.String,<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&gt;&nbsp;inputs,
java.util.Set&lt;java.lang.String&gt;&nbsp;requestedOutputs)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Scores an input feed dict, returning the map of requested inferred outputs.
<p>
The outputs are sorted based on the supplied set traveral order.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputs</code> - The inputs to score.</dd>
<dd><code>requestedOutputs</code> - The requested outputs.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The inferred outputs.</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, the input or output names are invalid, or if there are zero or too many inputs or outputs.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Closes the session, releasing it's resources.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></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 it failed to close.</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.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/OrtException.OrtErrorCode.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtSession.html" target="_top">Frames</a></li>
<li><a href="OrtSession.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>Constr&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>Constr&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>