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/java/ai/onnxruntime/OrtEnvironment.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

573 lines
27 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:31 EST 2019 -->
<title>OrtEnvironment (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="OrtEnvironment (OnnxRuntime-Java-API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":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";
</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/OrtEnvironment.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/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtEnvironment.html" target="_top">Frames</a></li>
<li><a href="OrtEnvironment.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>
<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 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 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>java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public 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="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime"><code>OrtSession</code></a>s
which encapsulate specific models.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</a></span></code>
<div class="block">The logging level for messages from the environment and session.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#DEFAULT_NAME">DEFAULT_NAME</a></span></code>&nbsp;</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">&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="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/OrtEnvironment.html#close--">close</a></span>()</code>
<div class="block">Closes the OrtEnvironment.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#createSession-byte:A-">createSession</a></span>(byte[]&nbsp;modelArray)</code>
<div class="block">Create a session using the default <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#createSession-byte:A-ai.onnxruntime.OrtSession.SessionOptions-">createSession</a></span>(byte[]&nbsp;modelArray,
<a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)</code>
<div class="block">Create a session using the specified <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#createSession-java.lang.String-">createSession</a></span>(java.lang.String&nbsp;modelPath)</code>
<div class="block">Create a session using the default <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#createSession-java.lang.String-ai.onnxruntime.OrtSession.SessionOptions-">createSession</a></span>(java.lang.String&nbsp;modelPath,
<a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)</code>
<div class="block">Create a session using the specified <a href="../../ai/onnxruntime/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 <a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#getEnvironment--">getEnvironment</a></span>()</code>
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#getEnvironment-ai.onnxruntime.OrtEnvironment.LoggingLevel-">getEnvironment</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</a>&nbsp;logLevel)</code>
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#getEnvironment-ai.onnxruntime.OrtEnvironment.LoggingLevel-java.lang.String-">getEnvironment</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</a>&nbsp;loggingLevel,
java.lang.String&nbsp;name)</code>
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#getEnvironment-java.lang.String-">getEnvironment</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Gets the OrtEnvironment.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#isClosed--">isClosed</a></span>()</code>
<div class="block">Is this environment closed?</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#setTelemetry-boolean-">setTelemetry</a></span>(boolean&nbsp;sendTelemetry)</code>
<div class="block">Turns on or off the telemetry.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OrtEnvironment.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="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>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEnvironment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/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="../../ai/onnxruntime/OrtEnvironment.html#DEFAULT_NAME"><code>DEFAULT_NAME</code></a> and <a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html#ORT_LOGGING_LEVEL_WARNING"><code>OrtEnvironment.LoggingLevel.ORT_LOGGING_LEVEL_WARNING</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An onnxruntime environment.</dd>
</dl>
</li>
</ul>
<a name="getEnvironment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment(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="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html#ORT_LOGGING_LEVEL_WARNING"><code>OrtEnvironment.LoggingLevel.ORT_LOGGING_LEVEL_WARNING</code></a>.</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>An onnxruntime environment.</dd>
</dl>
</li>
</ul>
<a name="getEnvironment-ai.onnxruntime.OrtEnvironment.LoggingLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment(<a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</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="../../ai/onnxruntime/OrtEnvironment.html#DEFAULT_NAME"><code>DEFAULT_NAME</code></a> and the supplied logging level.</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>An onnxruntime environment.</dd>
</dl>
</li>
</ul>
<a name="getEnvironment-ai.onnxruntime.OrtEnvironment.LoggingLevel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;getEnvironment(<a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime">OrtEnvironment.LoggingLevel</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 name="createSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession(java.lang.String&nbsp;modelPath)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the default <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/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="../../ai/onnxruntime/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 name="createSession-java.lang.String-ai.onnxruntime.OrtSession.SessionOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession(java.lang.String&nbsp;modelPath,
<a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the specified <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/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="../../ai/onnxruntime/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 name="createSession-byte:A-ai.onnxruntime.OrtSession.SessionOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession(byte[]&nbsp;modelArray,
<a href="../../ai/onnxruntime/OrtSession.SessionOptions.html" title="class in ai.onnxruntime">OrtSession.SessionOptions</a>&nbsp;options)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the specified <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/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="../../ai/onnxruntime/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 name="createSession-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OrtSession.html" title="class in ai.onnxruntime">OrtSession</a>&nbsp;createSession(byte[]&nbsp;modelArray)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a session using the default <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/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="../../ai/onnxruntime/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 name="setTelemetry-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTelemetry</h4>
<pre>public&nbsp;void&nbsp;setTelemetry(boolean&nbsp;sendTelemetry)
throws <a href="../../ai/onnxruntime/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="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the call failed.</dd>
</dl>
</li>
</ul>
<a name="isClosed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>public&nbsp;boolean&nbsp;isClosed()</pre>
<div class="block">Is this environment closed?</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the environment is closed.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>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 name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Closes the OrtEnvironment. If this is the last reference to the environment then it closes the native handle.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></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 the close failed.</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/OrtEnvironment.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/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OrtEnvironment.LoggingLevel.html" title="enum in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OrtEnvironment.html" target="_top">Frames</a></li>
<li><a href="OrtEnvironment.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>
<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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink