onnxruntime/docs/api/objectivec/Classes/ORTEnv.html
2021-12-10 17:37:56 -08:00

227 lines
11 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>ORTEnv Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/objc/Class/ORTEnv" class="dashAnchor"></a>
<a title="ORTEnv Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.10.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ONNX Runtime Objective-C API Reference</a>
<img id="carat" src="../img/carat.png" alt=""/>
ORTEnv Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/ORTCoreMLExecutionProviderOptions.html">ORTCoreMLExecutionProviderOptions</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTEnv.html">ORTEnv</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTRunOptions.html">ORTRunOptions</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTSession.html">ORTSession</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTSessionOptions.html">ORTSessionOptions</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTTensorTypeAndShapeInfo.html">ORTTensorTypeAndShapeInfo</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTValue.html">ORTValue</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ORTValueTypeInfo.html">ORTValueTypeInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/ORTGraphOptimizationLevel.html">ORTGraphOptimizationLevel</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ORTLoggingLevel.html">ORTLoggingLevel</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ORTTensorElementDataType.html">ORTTensorElementDataType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ORTValueType.html">ORTValueType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/c:@F@ORTIsCoreMLExecutionProviderAvailable">ORTIsCoreMLExecutionProviderAvailable</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>ORTEnv</h1>
<div class="declaration">
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">ORTEnv</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">ORTEnv</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>The ORT environment.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)ORTEnv(im)init"></a>
<a name="//apple_ref/objc/Method/-init" class="dashAnchor"></a>
<a class="token discouraged" href="#/c:objc(cs)ORTEnv(im)init">-init</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="aside aside-unavailable">
<p class="aside-title">Unavailable</p>
</div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)ORTEnv(im)initWithLoggingLevel:error:"></a>
<a name="//apple_ref/objc/Method/-initWithLoggingLevel:error:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)ORTEnv(im)initWithLoggingLevel:error:">-initWithLoggingLevel:<wbr>error:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates an ORT Environment.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLoggingLevel</span><span class="p">:(</span><span class="n"><a href="../Enums/ORTLoggingLevel.html">ORTLoggingLevel</a></span><span class="p">)</span><span class="nv">loggingLevel</span>
<span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span>
<span class="n">error</span><span class="p">;</span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">loggingLevel</span><span class="p">:</span> <span class="kt"><a href="../Enums/ORTLoggingLevel.html">ORTLoggingLevel</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>loggingLevel</em>
</code>
</td>
<td>
<div>
<p>The environment logging level.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>error</em>
</code>
</td>
<td>
<div>
<p>Optional error information set if an error occurs.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The instance, or nil if an error occurs.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external noopener">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-12-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>