mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-16 18:31:27 +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
368 lines
15 KiB
HTML
368 lines
15 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>OnnxValue (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="OnnxValue (OnnxRuntime-Java-API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":17,"i2":17,"i3":6,"i4":6,"i5":6};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/OnnxValue.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/OnnxTensor.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?ai/onnxruntime/OnnxValue.html" target="_top">Frames</a></li>
|
|
<li><a href="OnnxValue.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><a href="#nested.class.summary">Nested</a> | </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="Interface OnnxValue" class="title">Interface OnnxValue</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd>java.lang.AutoCloseable</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../ai/onnxruntime/OnnxMap.html" title="class in ai.onnxruntime">OnnxMap</a>, <a href="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime">OnnxSequence</a>, <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">OnnxValue</span>
|
|
extends java.lang.AutoCloseable</pre>
|
|
<div class="block">Top interface for input and output values from ONNX models.
|
|
Currently implemented by <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime"><code>OnnxTensor</code></a>, <a href="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime"><code>OnnxSequence</code></a> and <a href="../../ai/onnxruntime/OnnxMap.html" title="class in ai.onnxruntime"><code>OnnxMap</code></a>. Will be sealed to
|
|
these types one day.
|
|
|
|
Does not support sparse tensors.</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"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Interface and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static class </code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a></span></code>
|
|
<div class="block">The type of the <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>, mirroring the id in the C API.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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/OnnxValue.html#close--">close</a></span>()</code>
|
|
<div class="block">Closes the OnnxValue, freeing it's native memory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.html#close-java.lang.Iterable-">close</a></span>(java.lang.Iterable<? extends <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>> itr)</code>
|
|
<div class="block">Calls close on each element of the iterable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.html#close-java.util.Map-">close</a></span>(java.util.Map<java.lang.String,? extends <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>> map)</code>
|
|
<div class="block">Calls close on each <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a> in the map.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../ai/onnxruntime/ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.html#getInfo--">getInfo</a></span>()</code>
|
|
<div class="block">Gets the type info object associated with this OnnxValue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.html#getType--">getType</a></span>()</code>
|
|
<div class="block">Gets the type of this OnnxValue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxValue.html#getValue--">getValue</a></span>()</code>
|
|
<div class="block">Returns the value as a Java object copying it out of the native heap.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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="getType--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getType</h4>
|
|
<pre><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a> getType()</pre>
|
|
<div class="block">Gets the type of this OnnxValue.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The value type.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getValue--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getValue</h4>
|
|
<pre>java.lang.Object getValue()
|
|
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
|
|
<div class="block">Returns the value as a Java object copying it out of the native heap.
|
|
This operation can be quite slow for high dimensional tensors, where
|
|
you should prefer <a href="../../ai/onnxruntime/OnnxTensor.html#getByteBuffer--"><code>OnnxTensor.getByteBuffer()</code></a> etc.
|
|
<p>
|
|
Overridden by the subclasses with a more specific type if available.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The value.</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 an error occurred reading the value.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInfo--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInfo</h4>
|
|
<pre><a href="../../ai/onnxruntime/ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a> getInfo()</pre>
|
|
<div class="block">Gets the type info object associated with this OnnxValue.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The type information.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="close--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre>void close()</pre>
|
|
<div class="block">Closes the OnnxValue, freeing it's native memory.</div>
|
|
<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="close-java.lang.Iterable-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre>static void close(java.lang.Iterable<? extends <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>> itr)</pre>
|
|
<div class="block">Calls close on each element of the iterable.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>itr</code> - An iterable of closeable OnnxValues.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="close-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre>static void close(java.util.Map<java.lang.String,? extends <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>> map)</pre>
|
|
<div class="block">Calls close on each <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a> in the map.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>map</code> - A map of <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>s.</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/OnnxValue.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/OnnxTensor.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?ai/onnxruntime/OnnxValue.html" target="_top">Frames</a></li>
|
|
<li><a href="OnnxValue.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><a href="#nested.class.summary">Nested</a> | </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>
|