onnxruntime/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.html
github-actions[bot] e2573f4801
[Automated]: Update C# API docs (#12807)
Update C# API docs to commit 98b2b7f

Co-authored-by: natke <natke@users.noreply.github.com>
2022-09-02 09:14:15 -05:00

302 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 FixedBufferOnnxValue
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FixedBufferOnnxValue
">
<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.FixedBufferOnnxValue">
<h1 id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue" class="text-break">Class FixedBufferOnnxValue
</h1>
<div class="markdown level0 summary"><p>Represents an OrtValue with its underlying buffer pinned</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"><span class="xref">FixedBufferOnnxValue</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_FixedBufferOnnxValue_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FixedBufferOnnxValue : IDisposable</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_CreateFromMemory_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.CreateFromMemory*"></a>
<h4 id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_CreateFromMemory__1_Microsoft_ML_OnnxRuntime_OrtMemoryInfo_Memory___0__TensorElementType_System_Int64___System_Int64_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.CreateFromMemory``1(Microsoft.ML.OnnxRuntime.OrtMemoryInfo,Memory{``0},TensorElementType,System.Int64[],System.Int64)">CreateFromMemory&lt;T&gt;(OrtMemoryInfo, Memory&lt;T&gt;, TensorElementType, Int64[], Int64)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static FixedBufferOnnxValue CreateFromMemory&lt;T&gt;(OrtMemoryInfo memoryInfo, Memory&lt;T&gt; memory, TensorElementType elementType, long[] shape, long bytesSize)</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><a class="xref" href="Microsoft.ML.OnnxRuntime.OrtMemoryInfo.html">OrtMemoryInfo</a></td>
<td><span class="parametername">memoryInfo</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Memory</span>&lt;T&gt;</td>
<td><span class="parametername">memory</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">TensorElementType</span></td>
<td><span class="parametername">elementType</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span>[]</td>
<td><span class="parametername">shape</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">bytesSize</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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.FixedBufferOnnxValue.html">FixedBufferOnnxValue</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_CreateFromTensor_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.CreateFromTensor*"></a>
<h4 id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_CreateFromTensor__1_Tensor___0__" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.CreateFromTensor``1(Tensor{``0})">CreateFromTensor&lt;T&gt;(Tensor&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.html">FixedBufferOnnxValue</a> object from the tensor and pins its underlying buffer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static FixedBufferOnnxValue CreateFromTensor&lt;T&gt;(Tensor&lt;T&gt; value)</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">Tensor</span>&lt;T&gt;</td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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.FixedBufferOnnxValue.html">FixedBufferOnnxValue</a></td>
<td><p>a disposable instance of FixedBufferOnnxValue</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_Dispose_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.Dispose*"></a>
<h4 id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_Dispose" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.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_FixedBufferOnnxValue_Dispose_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.Dispose*"></a>
<h4 id="Microsoft_ML_OnnxRuntime_FixedBufferOnnxValue_Dispose_System_Boolean_" data-uid="Microsoft.ML.OnnxRuntime.FixedBufferOnnxValue.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 from Dispose()</p>
</td>
</tr>
</tbody>
</table>
</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>