mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-16 18:31:27 +00:00
e2573f4801
Update C# API docs to commit 98b2b7f
Co-authored-by: natke <natke@users.noreply.github.com>
283 lines
11 KiB
HTML
283 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class DisposableNamedOnnxValue
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class DisposableNamedOnnxValue
|
|
">
|
|
<meta name="generator" content="docfx 2.59.3.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue">
|
|
|
|
|
|
<h1 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue" class="text-break">Class DisposableNamedOnnxValue
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class serves as a container for model run output values including
|
|
tensors, sequences of tensors, sequences and maps.
|
|
It extends NamedOnnxValue, exposes the OnnxValueType and Tensor type
|
|
The class must be disposed of.
|
|
It disposes of _ortValueHolder that owns the underlying Ort output value and
|
|
anything else that would need to be disposed by the instance of the class.
|
|
Use factory method CreateFromOrtValue to obtain an instance of the class.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html">NamedOnnxValue</a></div>
|
|
<div class="level2"><span class="xref">DisposableNamedOnnxValue</span></div>
|
|
</div>
|
|
<div class="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">IDisposable</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue__value">NamedOnnxValue._value</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue__name">NamedOnnxValue._name</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_CreateFromTensor__1_System_String_Tensor___0__">NamedOnnxValue.CreateFromTensor<T>(String, Tensor<T>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_Name">NamedOnnxValue.Name</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_Value">NamedOnnxValue.Value</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_AsTensor__1">NamedOnnxValue.AsTensor<T>()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_AsEnumerable__1">NamedOnnxValue.AsEnumerable<T>()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Microsoft.ML.OnnxRuntime.NamedOnnxValue.html#Microsoft_ML_OnnxRuntime_NamedOnnxValue_AsDictionary__2">NamedOnnxValue.AsDictionary<K, V>()</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Microsoft.ML.OnnxRuntime.html">Microsoft.ML.OnnxRuntime</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class DisposableNamedOnnxValue : NamedOnnxValue</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_ElementType_" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.ElementType*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_ElementType" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.ElementType">ElementType</h4>
|
|
<div class="markdown level1 summary"><p>Only valid if ValueType is Tensor</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TensorElementType ElementType { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">TensorElementType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_ValueType_" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.ValueType*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_ValueType" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.ValueType">ValueType</h4>
|
|
<div class="markdown level1 summary"><p>Returns OnnxValueType</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OnnxValueType ValueType { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.ML.OnnxRuntime.OnnxValueType.html">OnnxValueType</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_Dispose_" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.Dispose*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_Dispose" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>IDisposable implementation</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_Dispose_" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.Dispose*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_DisposableNamedOnnxValue_Dispose_System_Boolean_" data-uid="Microsoft.ML.OnnxRuntime.DisposableNamedOnnxValue.Dispose(System.Boolean)">Dispose(Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>IDisposable implementation</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">disposing</span></td>
|
|
<td><p>true if invoked by Dispose()</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">IDisposable</span>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|