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/OrtEnvironment.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

671 lines
29 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>OrtEnvironment (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="OrtEnvironment (onnxruntime 1.15.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":10,"i12":10};
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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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="Class OrtEnvironment" class="title">Class OrtEnvironment</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OrtEnvironment</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">OrtEnvironment</span>
extends java.lang.Object
implements java.lang.AutoCloseable</pre>
<div class="block">The host object for the onnx-runtime system. Can create <a href="OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a>s which encapsulate
specific models.
<p>There can be at most one OrtEnvironment object created in a JVM lifetime. This class
implements <code>AutoCloseable</code> as before for backwards compatibility with 1.10 and earlier, but
the close method is a no-op. The environment is closed by a JVM shutdown hook registered on
construction.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OrtEnvironment.ThreadingOptions.html" title="class in ai.onnxruntime">OrtEnvironment.ThreadingOptions</a></span></code></th>
<td class="colLast">
<div class="block">Controls the global thread pools in the environment.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_NAME">DEFAULT_NAME</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Close is a no-op on OrtEnvironment since ORT 1.11.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSession(byte%5B%5D)">createSession</a></span>&#8203;(byte[]&nbsp;modelArray)</code></th>
<td class="colLast">
<div class="block">Create a session using the default <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSession(byte%5B%5D,ai.onnxruntime.OrtSession.SessionOptions)">createSession</a></span>&#8203;(byte[]&nbsp;modelArray,
<a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Create a session using the specified <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSession(java.lang.String)">createSession</a></span>&#8203;(java.lang.String&nbsp;modelPath)</code></th>
<td class="colLast">
<div class="block">Create a session using the default <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSession(java.lang.String,ai.onnxruntime.OrtSession.SessionOptions)">createSession</a></span>&#8203;(java.lang.String&nbsp;modelPath,
<a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Create a session using the specified <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.util.EnumSet&lt;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAvailableProviders()">getAvailableProviders</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the providers available in this environment.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment()">getEnvironment</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment(ai.onnxruntime.OrtLoggingLevel)">getEnvironment</a></span>&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;logLevel)</code></th>
<td class="colLast">
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment(ai.onnxruntime.OrtLoggingLevel,java.lang.String)">getEnvironment</a></span>&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;loggingLevel,
java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment(ai.onnxruntime.OrtLoggingLevel,java.lang.String,ai.onnxruntime.OrtEnvironment.ThreadingOptions)">getEnvironment</a></span>&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;loggingLevel,
java.lang.String&nbsp;name,
<a href="OrtEnvironment.ThreadingOptions.html" title="class in ai.onnxruntime">OrtEnvironment.ThreadingOptions</a>&nbsp;threadOptions)</code></th>
<td class="colLast">
<div class="block">Creates an OrtEnvironment using the specified global thread pool options.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment(java.lang.String)">getEnvironment</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTelemetry(boolean)">setTelemetry</a></span>&#8203;(boolean&nbsp;sendTelemetry)</code></th>
<td class="colLast">
<div class="block">Turns on or off the telemetry.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_NAME</h4>
<pre>public static final&nbsp;java.lang.String DEFAULT_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#ai.onnxruntime.OrtEnvironment.DEFAULT_NAME">Constant Field Values</a></dd>
</dl>
</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="getEnvironment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment()</pre>
<div class="block">Gets the OrtEnvironment. If there is not an environment currently created, it creates one using
<a href="#DEFAULT_NAME"><code>DEFAULT_NAME</code></a> and <a href="OrtLoggingLevel.html#ORT_LOGGING_LEVEL_WARNING"><code>OrtLoggingLevel.ORT_LOGGING_LEVEL_WARNING</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The OrtEnvironment singleton.</dd>
</dl>
</li>
</ul>
<a id="getEnvironment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Gets the OrtEnvironment. If there is not an environment currently created, it creates one using
the supplied name and <a href="OrtLoggingLevel.html#ORT_LOGGING_LEVEL_WARNING"><code>OrtLoggingLevel.ORT_LOGGING_LEVEL_WARNING</code></a>.
<p>If the environment already exists then it returns the existing one and logs a warning if the
name or log level is different from the requested one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The logging id of the environment.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The OrtEnvironment singleton.</dd>
</dl>
</li>
</ul>
<a id="getEnvironment(ai.onnxruntime.OrtLoggingLevel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;logLevel)</pre>
<div class="block">Gets the OrtEnvironment. If there is not an environment currently created, it creates one using
the <a href="#DEFAULT_NAME"><code>DEFAULT_NAME</code></a> and the supplied logging level.
<p>If the environment already exists then it returns the existing one and logs a warning if the
name or log level is different from the requested one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logLevel</code> - The logging level to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The OrtEnvironment singleton.</dd>
</dl>
</li>
</ul>
<a id="getEnvironment(ai.onnxruntime.OrtLoggingLevel,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;loggingLevel,
java.lang.String&nbsp;name)</pre>
<div class="block">Gets the OrtEnvironment. If there is not an environment currently created, it creates one using
the supplied name and logging level. If an environment already exists with a different name,
that environment is returned and a warning is logged.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loggingLevel</code> - The logging level to use.</dd>
<dd><code>name</code> - The log id.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The OrtEnvironment singleton.</dd>
</dl>
</li>
</ul>
<a id="getEnvironment(ai.onnxruntime.OrtLoggingLevel,java.lang.String,ai.onnxruntime.OrtEnvironment.ThreadingOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public static&nbsp;<a href="OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment&#8203;(<a href="OrtLoggingLevel.html" title="enum in ai.onnxruntime">OrtLoggingLevel</a>&nbsp;loggingLevel,
java.lang.String&nbsp;name,
<a href="OrtEnvironment.ThreadingOptions.html" title="class in ai.onnxruntime">OrtEnvironment.ThreadingOptions</a>&nbsp;threadOptions)</pre>
<div class="block">Creates an OrtEnvironment using the specified global thread pool options. Note unlike the other
<code>getEnvironment</code> methods if there already is an existing OrtEnvironment this call throws
<code>IllegalStateException</code> as we cannot guarantee that the environment has the appropriate
thread pool configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loggingLevel</code> - The logging level to use.</dd>
<dd><code>name</code> - The log id.</dd>
<dd><code>threadOptions</code> - The global thread pool options.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The OrtEnvironment singleton.</dd>
</dl>
</li>
</ul>
<a id="createSession(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre class="methodSignature">public&nbsp;<a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession&#8203;(java.lang.String&nbsp;modelPath)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the default <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modelPath</code> - Path on disk to load the model from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a> with the specified model.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the model failed to load, wasn't compatible or caused an error.</dd>
</dl>
</li>
</ul>
<a id="createSession(java.lang.String,ai.onnxruntime.OrtSession.SessionOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre class="methodSignature">public&nbsp;<a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession&#8203;(java.lang.String&nbsp;modelPath,
<a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the specified <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modelPath</code> - Path on disk to load the model from.</dd>
<dd><code>options</code> - The session options.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a> with the specified model.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the model failed to load, wasn't compatible or caused an error.</dd>
</dl>
</li>
</ul>
<a id="createSession(byte[],ai.onnxruntime.OrtSession.SessionOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre class="methodSignature">public&nbsp;<a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession&#8203;(byte[]&nbsp;modelArray,
<a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the specified <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modelArray</code> - Byte array representing an ONNX model.</dd>
<dd><code>options</code> - The session options.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a> with the specified model.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the model failed to parse, wasn't compatible or caused an error.</dd>
</dl>
</li>
</ul>
<a id="createSession(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre class="methodSignature">public&nbsp;<a href="OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession&#8203;(byte[]&nbsp;modelArray)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the default <a href="OrtSession.SessionOptions.html" title="class in ai.onnxruntime"><code>OrtSession.SessionOptions</code></a>, model and the default memory
allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>modelArray</code> - Byte array representing an ONNX model.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a> with the specified model.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the model failed to parse, wasn't compatible or caused an error.</dd>
</dl>
</li>
</ul>
<a id="setTelemetry(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTelemetry</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTelemetry&#8203;(boolean&nbsp;sendTelemetry)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Turns on or off the telemetry.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sendTelemetry</code> - If true then send telemetry on onnxruntime usage.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the call failed.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">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 id="getAvailableProviders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableProviders</h4>
<pre class="methodSignature">public static&nbsp;java.util.EnumSet&lt;<a href="OrtProvider.html" title="enum in ai.onnxruntime">OrtProvider</a>&gt;&nbsp;getAvailableProviders()</pre>
<div class="block">Gets the providers available in this environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An enum set of the available execution providers.</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block">Close is a no-op on OrtEnvironment since ORT 1.11.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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