saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/java/ai/onnxruntime/package-summary.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

320 lines
13 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>ai.onnxruntime (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="ai.onnxruntime (OnnxRuntime-Java-API)";
}
}
catch(err) {
}
//-->
</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</li>
<li><a href="package-use.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>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;ai.onnxruntime</h1>
<div class="docSummary">
<div class="block">A Java interface to the onnxruntime.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></td>
<td class="colLast">
<div class="block">Top interface for input and output values from ONNX models.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></td>
<td class="colLast">
<div class="block">Interface for info objects describing an <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/MapInfo.html" title="class in ai.onnxruntime">MapInfo</a></td>
<td class="colLast">
<div class="block">Describes an <a href="../../ai/onnxruntime/OnnxMap.html" title="class in ai.onnxruntime"><code>OnnxMap</code></a> object or output node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/NodeInfo.html" title="class in ai.onnxruntime">NodeInfo</a></td>
<td class="colLast">
<div class="block">The info for an input or output node from an ONNX model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxMap.html" title="class in ai.onnxruntime">OnnxMap</a></td>
<td class="colLast">
<div class="block">A container for a map returned by <a href="../../ai/onnxruntime/OrtSession.html#run-java.util.Map-"><code>OrtSession.run(Map)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime">OnnxSequence</a></td>
<td class="colLast">
<div class="block">A sequence of <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><code>OnnxValue</code></a>s all of the same type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></td>
<td class="colLast">
<div class="block">A Java object wrapping an OnnxTensor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></td>
<td class="colLast">
<div class="block">The host object for the onnx-runtime system.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></td>
<td class="colLast">
<div class="block">Wraps an ONNX model and allows inference calls.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtSession.Result.html" title="class in ai.onnxruntime">OrtSession.Result</a></td>
<td class="colLast">
<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="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a></td>
<td class="colLast">
<div class="block">Represents the options used to construct this session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtUtil.html" title="class in ai.onnxruntime">OrtUtil</a></td>
<td class="colLast">
<div class="block">Util code for interacting with Java arrays.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/SequenceInfo.html" title="class in ai.onnxruntime">SequenceInfo</a></td>
<td class="colLast">
<div class="block">Describes an <a href="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime"><code>OnnxSequence</code></a>, including it's element type if known.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></td>
<td class="colLast">
<div class="block">Describes an <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime"><code>OnnxTensor</code></a>, including it's size, shape and element type.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a></td>
<td class="colLast">
<div class="block">An enum representing onnxruntime supported Java primitive types (and String).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxMap.OnnxMapValueType.html" title="enum in ai.onnxruntime">OnnxMap.OnnxMapValueType</a></td>
<td class="colLast">
<div class="block">An enum representing the Java type of the values stored in an <a href="../../ai/onnxruntime/OnnxMap.html" title="class in ai.onnxruntime"><code>OnnxMap</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a></td>
<td class="colLast">
<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>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</a></td>
<td class="colLast">
<div class="block">The logging level for messages from the environment and session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtException.OrtErrorCode.html" title="enum in ai.onnxruntime">OrtException.OrtErrorCode</a></td>
<td class="colLast">
<div class="block">Maps the OrtErrorCode struct in "onnxruntime_c_api.h" with an additional entry for Java side errors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.ExecutionMode</a></td>
<td class="colLast">
<div class="block">The execution mode to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html" title="enum in ai.onnxruntime">OrtSession.SessionOptions.OptLevel</a></td>
<td class="colLast">
<div class="block">The optimisation level to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../ai/onnxruntime/TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a></td>
<td class="colLast">
<div class="block">The native element types supported by the ONNX runtime.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></td>
<td class="colLast">
<div class="block">An exception which contains the error message and code produced by the native onnxruntime.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package ai.onnxruntime Description">Package ai.onnxruntime Description</h2>
<div class="block">A Java interface to the onnxruntime.
<p>
Provides access to the same execution backends as the C library.
Non-representable types in Java (such as fp16) are converted
into the nearest Java primitive type when accessed through this API.</div>
</div>
<!-- ======= 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</li>
<li><a href="package-use.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>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink