mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-14 18:12:05 +00:00
a0f3e30de6
* 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
344 lines
13 KiB
HTML
344 lines
13 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:32 EST 2019 -->
|
|
<title>OrtSession.Result (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.Result (OnnxRuntime-Java-API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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.Result.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.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?ai/onnxruntime/OrtSession.Result.html" target="_top">Frames</a></li>
|
|
<li><a href="OrtSession.Result.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.Result" class="title">Class OrtSession.Result</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>ai.onnxruntime.OrtSession.Result</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>java.lang.AutoCloseable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>>></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.Result</span>
|
|
extends java.lang.Object
|
|
implements java.lang.AutoCloseable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>>></pre>
|
|
<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.
|
|
<p>
|
|
When this is closed it closes all the <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>s inside it. If you maintain a reference to a
|
|
value after this object has been closed it will throw an <code>IllegalStateException</code> upon access.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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.Result.html#close--">close</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.Result.html#get-int-">get</a></span>(int index)</code>
|
|
<div class="block">Gets the value from the container at the specified index.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.util.Optional<<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.Result.html#get-java.lang.String-">get</a></span>(java.lang.String key)</code>
|
|
<div class="block">Gets the value from the container assuming it's not been closed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.util.Iterator<java.util.Map.Entry<java.lang.String,<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.Result.html#iterator--">iterator</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtSession.Result.html#size--">size</a></span>()</code>
|
|
<div class="block">Returns the number of outputs in this Result.</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 java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface java.lang.Iterable</h3>
|
|
<code>forEach, spliterator</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="close--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre>public void close()</pre>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="iterator--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>iterator</h4>
|
|
<pre>public java.util.Iterator<java.util.Map.Entry<java.lang.String,<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>>> iterator()</pre>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code>iterator</code> in interface <code>java.lang.Iterable<java.util.Map.Entry<java.lang.String,<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>>></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="get-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>get</h4>
|
|
<pre>public <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a> get(int index)</pre>
|
|
<div class="block">Gets the value from the container at the specified index.
|
|
|
|
Throws <code>IllegalStateException</code> if the container has been closed, and <code>IndexOutOfBoundsException</code> if the index is invalid.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>index</code> - The index to lookup.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The value at the index.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="size--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>size</h4>
|
|
<pre>public int size()</pre>
|
|
<div class="block">Returns the number of outputs in this Result.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of outputs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="get-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>get</h4>
|
|
<pre>public java.util.Optional<<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>> get(java.lang.String key)</pre>
|
|
<div class="block">Gets the value from the container assuming it's not been closed.
|
|
|
|
Throws <code>IllegalStateException</code> if the container has been closed.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - The key to lookup.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Optional.of the value if it exists.</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.Result.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.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?ai/onnxruntime/OrtSession.Result.html" target="_top">Frames</a></li>
|
|
<li><a href="OrtSession.Result.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|