mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-15 18:23:41 +00:00
e2573f4801
Update C# API docs to commit 98b2b7f
Co-authored-by: natke <natke@users.noreply.github.com>
322 lines
12 KiB
HTML
322 lines
12 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 OrtValue
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OrtValue
|
|
">
|
|
<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.OrtValue">
|
|
|
|
|
|
<h1 id="Microsoft_ML_OnnxRuntime_OrtValue" data-uid="Microsoft.ML.OnnxRuntime.OrtValue" class="text-break">Class OrtValue
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents a disposable OrtValue.
|
|
This class exposes a native instance of OrtValue.
|
|
The class implements IDisposable via SafeHandle and must
|
|
be disposed.</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">OrtValue</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_OrtValue_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OrtValue : SafeHandle</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_OrtValue_IsInvalid_" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.IsInvalid*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_OrtValue_IsInvalid" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.IsInvalid">IsInvalid</h4>
|
|
<div class="markdown level1 summary"><p>Overrides SafeHandle.IsInvalid</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool IsInvalid { 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">System.Boolean</span></td>
|
|
<td><p>returns true if handle is equal to Zero</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_OrtValue_CreateFromTensorObject_" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.CreateFromTensorObject*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_OrtValue_CreateFromTensorObject_Object_System_Nullable_MemoryHandle___TensorElementType__" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.CreateFromTensorObject(Object,System.Nullable{MemoryHandle}@,TensorElementType@)">CreateFromTensorObject(Object, out Nullable<MemoryHandle>, out TensorElementType)</h4>
|
|
<div class="markdown level1 summary"><p>This is a factory method creates a native Onnxruntime OrtValue containing a tensor.
|
|
The method will attempt to pin managed memory so no copying occurs when data is passed down
|
|
to native code.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static OrtValue CreateFromTensorObject(Object value, out MemoryHandle? memoryHandle, out TensorElementType elementType)</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">Object</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>Tensor object</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">MemoryHandle</span>></td>
|
|
<td><span class="parametername">memoryHandle</span></td>
|
|
<td><p>For all tensor types but string tensors we endeavor to use managed memory
|
|
to avoid additional allocation and copy. This out parameter represents a chunk of pinned memory which will need
|
|
to be disposed when no longer needed. The lifespan of memoryHandle should eclipse the lifespan of the corresponding
|
|
OrtValue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TensorElementType</span></td>
|
|
<td><span class="parametername">elementType</span></td>
|
|
<td><p>discovered tensor element type</p>
|
|
</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.OrtValue.html">OrtValue</a></td>
|
|
<td><p>And instance of OrtValue constructed on top of the object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_OrtValue_CreateTensorValueWithData_" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.CreateTensorValueWithData*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_OrtValue_CreateTensorValueWithData_Microsoft_ML_OnnxRuntime_OrtMemoryInfo_TensorElementType_System_Int64___IntPtr_System_Int64_" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.CreateTensorValueWithData(Microsoft.ML.OnnxRuntime.OrtMemoryInfo,TensorElementType,System.Int64[],IntPtr,System.Int64)">CreateTensorValueWithData(OrtMemoryInfo, TensorElementType, Int64[], IntPtr, Int64)</h4>
|
|
<div class="markdown level1 summary"><p>Factory method to construct an OrtValue of Tensor type on top of pre-allocated memory.
|
|
This can be a piece of native memory allocated by OrtAllocator (possibly on a device)
|
|
or a piece of pinned managed memory.</p>
|
|
<p>The resulting OrtValue does not own the underlying memory buffer and will not attempt to
|
|
deallocate it.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static OrtValue CreateTensorValueWithData(OrtMemoryInfo memInfo, TensorElementType elementType, long[] shape, IntPtr dataBuffer, long bufferLength)</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">memInfo</span></td>
|
|
<td><p>Memory Info. For managed memory it is a default cpu.
|
|
For Native memory must be obtained from the allocator or OrtMemoryAllocation instance</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TensorElementType</span></td>
|
|
<td><span class="parametername">elementType</span></td>
|
|
<td><p>DataType for the Tensor</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int64</span>[]</td>
|
|
<td><span class="parametername">shape</span></td>
|
|
<td><p>Tensor shape</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">IntPtr</span></td>
|
|
<td><span class="parametername">dataBuffer</span></td>
|
|
<td><p>Pointer to a raw memory buffer</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int64</span></td>
|
|
<td><span class="parametername">bufferLength</span></td>
|
|
<td><p>Buffer length in bytes</p>
|
|
</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.OrtValue.html">OrtValue</a></td>
|
|
<td><p>A disposable instance of OrtValue</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_ML_OnnxRuntime_OrtValue_ReleaseHandle_" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.ReleaseHandle*"></a>
|
|
<h4 id="Microsoft_ML_OnnxRuntime_OrtValue_ReleaseHandle" data-uid="Microsoft.ML.OnnxRuntime.OrtValue.ReleaseHandle">ReleaseHandle()</h4>
|
|
<div class="markdown level1 summary"><p>Overrides SafeHandle.ReleaseHandle() to properly dispose of
|
|
the native instance of OrtValue</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override bool ReleaseHandle()</code></pre>
|
|
</div>
|
|
<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><span class="xref">System.Boolean</span></td>
|
|
<td><p>always returns true</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>
|