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/OrtProvider.html
github-actions[bot] 89eb6eb488
[Automated]: Update Java API docs (#14426) 
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Co-authored-by: fs-eire <fs-eire@users.noreply.github.com>
2023-01-26 15:42:09 -08:00

590 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>OrtProvider (onnxruntime 1.15.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OrtProvider (onnxruntime 1.15.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":9,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">ai.onnxruntime</a></div>
<h2 title="Enum OrtProvider" class="title">Enum OrtProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&gt;</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OrtProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&gt;</code></dd>
</dl>
<hr>
<pre>public enum <span class="typeNameLabel">OrtProvider</span>
extends java.lang.Enum&lt;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&gt;</pre>
<div class="block">The execution providers available through the Java API.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ACL">ACL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ARM_NN">ARM_NN</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CORE_ML">CORE_ML</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CPU">CPU</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CUDA">CUDA</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DIRECT_ML">DIRECT_ML</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DNNL">DNNL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MI_GRAPH_X">MI_GRAPH_X</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NNAPI">NNAPI</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OPEN_VINO">OPEN_VINO</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#RK_NPU">RK_NPU</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ROCM">ROCM</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TENSOR_RT">TENSOR_RT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#VITIS_AI">VITIS_AI</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#XNNPACK">XNNPACK</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Accessor for the internal name of this provider.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapFromName(java.lang.String)">mapFromName</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Maps from the name string used by ONNX Runtime into the enum.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="CPU">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CPU</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> CPU</pre>
</li>
</ul>
<a id="CUDA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CUDA</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> CUDA</pre>
</li>
</ul>
<a id="DNNL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DNNL</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> DNNL</pre>
</li>
</ul>
<a id="OPEN_VINO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPEN_VINO</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> OPEN_VINO</pre>
</li>
</ul>
<a id="VITIS_AI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VITIS_AI</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> VITIS_AI</pre>
</li>
</ul>
<a id="TENSOR_RT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TENSOR_RT</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> TENSOR_RT</pre>
</li>
</ul>
<a id="NNAPI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NNAPI</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> NNAPI</pre>
</li>
</ul>
<a id="RK_NPU">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RK_NPU</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> RK_NPU</pre>
</li>
</ul>
<a id="DIRECT_ML">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DIRECT_ML</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> DIRECT_ML</pre>
</li>
</ul>
<a id="MI_GRAPH_X">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MI_GRAPH_X</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> MI_GRAPH_X</pre>
</li>
</ul>
<a id="ACL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ACL</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> ACL</pre>
</li>
</ul>
<a id="ARM_NN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ARM_NN</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> ARM_NN</pre>
</li>
</ul>
<a id="ROCM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROCM</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> ROCM</pre>
</li>
</ul>
<a id="CORE_ML">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CORE_ML</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> CORE_ML</pre>
</li>
</ul>
<a id="XNNPACK">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XNNPACK</h4>
<pre>public static final&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a> XNNPACK</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (OrtProvider c : OrtProvider.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block">Accessor for the internal name of this provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The internal provider name.</dd>
</dl>
</li>
</ul>
<a id="mapFromName(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mapFromName</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&nbsp;mapFromName&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Maps from the name string used by ONNX Runtime into the enum.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The provider name string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The enum constant.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in a new issue View git blame Copy permalink