mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-18 18:52:16 +00:00
[Automated]: Update C# API docs (#12964)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: RandySheriffH <RandySheriffH@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
GitHub
parent
8660613262
commit
aef4472ef1
6 changed files with 98 additions and 109 deletions
|
|
@ -586,6 +586,30 @@
|
|||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_CopyKernelInfo" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.CopyKernelInfo">CopyKernelInfo</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 IntPtr CopyKernelInfo</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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">IntPtr</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_CreateAllocator" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.CreateAllocator">CreateAllocator</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
|
@ -2530,6 +2554,30 @@
|
|||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_GetTrainingApi" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.GetTrainingApi">GetTrainingApi</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 IntPtr GetTrainingApi</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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">IntPtr</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_GetTypeInfo" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.GetTypeInfo">GetTypeInfo</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
|
@ -3466,6 +3514,30 @@
|
|||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_ReleaseKernelInfo" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.ReleaseKernelInfo">ReleaseKernelInfo</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 IntPtr ReleaseKernelInfo</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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">IntPtr</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_OrtApi_ReleaseMapTypeInfo" data-uid="Microsoft.ML.OnnxRuntime.OrtApi.ReleaseMapTypeInfo">ReleaseMapTypeInfo</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
|
|
|||
|
|
@ -869,35 +869,6 @@ Use only if you have the onnxruntime package specific to this Execution Provider
|
|||
</table>
|
||||
|
||||
|
||||
<a id="Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_Nuphar_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar*"></a>
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_Nuphar_System_String_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar(System.String)">AppendExecutionProvider_Nuphar(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Use only if you have the onnxruntime package specific to this Execution Provider.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void AppendExecutionProvider_Nuphar(string settings = "")</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.String</span></td>
|
||||
<td><span class="parametername">settings</span></td>
|
||||
<td><p>string with Nuphar specific settings</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_OpenVINO_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_OpenVINO*"></a>
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_OpenVINO_System_String_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_OpenVINO(System.String)">AppendExecutionProvider_OpenVINO(String)</h4>
|
||||
<div class="markdown level1 summary"><p>Use only if you have the onnxruntime package specific to this Execution Provider.</p>
|
||||
|
|
@ -1135,52 +1106,6 @@ Use only if CUDA is installed and you have the onnxruntime package specific to t
|
|||
</table>
|
||||
|
||||
|
||||
<a id="Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithNupharProvider_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider*"></a>
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithNupharProvider_String_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider(String)">MakeSessionOptionWithNupharProvider(String)</h4>
|
||||
<div class="markdown level1 summary"><p>A helper method to construct a SessionOptions object for Nuphar execution.
|
||||
Use only if you have the onnxruntime package specific to this Execution Provider.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static SessionOptions MakeSessionOptionWithNupharProvider(String settings = null)</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">String</span></td>
|
||||
<td><span class="parametername">settings</span></td>
|
||||
<td><p>settings string, comprises of comma separated key:value pairs. default is empty</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.SessionOptions.html">SessionOptions</a></td>
|
||||
<td><p>A SessionsOptions() object configured for execution with Nuphar</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<a id="Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithRocmProvider_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithRocmProvider*"></a>
|
||||
<h4 id="Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithRocmProvider_System_Int32_" data-uid="Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithRocmProvider(System.Int32)">MakeSessionOptionWithRocmProvider(Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>A helper method to construct a SessionOptions object for ROCM execution.
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@
|
|||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Microsoft.ML.OnnxRuntime.OrtApi.html",
|
||||
"hash": "FzIrfDIbrEulqdrXgi81tr4mr5E78lWI9TuQo4zt2p0="
|
||||
"hash": "sAtiOlRPkaoRheEH0Hs6p5PUIvrmf5sGMeV33rM5v3Q="
|
||||
}
|
||||
},
|
||||
"is_incremental": true,
|
||||
|
|
@ -405,7 +405,7 @@
|
|||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/Microsoft.ML.OnnxRuntime.SessionOptions.html",
|
||||
"hash": "bo1tpjILfewDePcgPolqlmt4kdgnIFGarF5mDUzzAY4="
|
||||
"hash": "8OAPzYOSpAUgnb8+xvi9mE741cw5BHomfioRQcCzKG0="
|
||||
}
|
||||
},
|
||||
"is_incremental": true,
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -2012,7 +2012,7 @@ lunr.Index.load = function (serializedIndex) {
|
|||
* @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.
|
||||
* @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.
|
||||
* @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.
|
||||
* @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.
|
||||
* @property {array} metadataAcceptedlist - A list of metadata keys that have been listed for entry in the index.
|
||||
*/
|
||||
lunr.Builder = function () {
|
||||
this._ref = "id"
|
||||
|
|
@ -2027,7 +2027,7 @@ lunr.Builder = function () {
|
|||
this._b = 0.75
|
||||
this._k1 = 1.2
|
||||
this.termIndex = 0
|
||||
this.metadataWhitelist = []
|
||||
this.metadataAcceptedlist = []
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -2149,10 +2149,10 @@ lunr.Builder.prototype.add = function (doc) {
|
|||
this.invertedIndex[term][fieldName][docRef] = Object.create(null)
|
||||
}
|
||||
|
||||
// store all whitelisted metadata about this token in the
|
||||
// store all metadata about this token in the
|
||||
// inverted index
|
||||
for (var l = 0; l < this.metadataWhitelist.length; l++) {
|
||||
var metadataKey = this.metadataWhitelist[l],
|
||||
for (var l = 0; l < this.metadataAcceptedlist.length; l++) {
|
||||
var metadataKey = this.metadataAcceptedlist[l],
|
||||
metadata = term.metadata[metadataKey]
|
||||
|
||||
if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {
|
||||
|
|
|
|||
|
|
@ -1209,6 +1209,12 @@ references:
|
|||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.CompareMemoryInfo
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.CompareMemoryInfo
|
||||
nameWithType: OrtApi.CompareMemoryInfo
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.CopyKernelInfo
|
||||
name: CopyKernelInfo
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_CopyKernelInfo
|
||||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.CopyKernelInfo
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.CopyKernelInfo
|
||||
nameWithType: OrtApi.CopyKernelInfo
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.CreateAllocator
|
||||
name: CreateAllocator
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_CreateAllocator
|
||||
|
|
@ -1695,6 +1701,12 @@ references:
|
|||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.GetTensorTypeAndShape
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.GetTensorTypeAndShape
|
||||
nameWithType: OrtApi.GetTensorTypeAndShape
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.GetTrainingApi
|
||||
name: GetTrainingApi
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_GetTrainingApi
|
||||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.GetTrainingApi
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.GetTrainingApi
|
||||
nameWithType: OrtApi.GetTrainingApi
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.GetTypeInfo
|
||||
name: GetTypeInfo
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_GetTypeInfo
|
||||
|
|
@ -1929,6 +1941,12 @@ references:
|
|||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.ReleaseIoBinding
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseIoBinding
|
||||
nameWithType: OrtApi.ReleaseIoBinding
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseKernelInfo
|
||||
name: ReleaseKernelInfo
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_ReleaseKernelInfo
|
||||
commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.ReleaseKernelInfo
|
||||
fullName: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseKernelInfo
|
||||
nameWithType: OrtApi.ReleaseKernelInfo
|
||||
- uid: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseMapTypeInfo
|
||||
name: ReleaseMapTypeInfo
|
||||
href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_ReleaseMapTypeInfo
|
||||
|
|
@ -3725,19 +3743,6 @@ references:
|
|||
isSpec: "True"
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nnapi
|
||||
nameWithType: SessionOptions.AppendExecutionProvider_Nnapi
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar(System.String)
|
||||
name: AppendExecutionProvider_Nuphar(String)
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_Nuphar_System_String_
|
||||
commentId: M:Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar(System.String)
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar(System.String)
|
||||
nameWithType: SessionOptions.AppendExecutionProvider_Nuphar(String)
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar*
|
||||
name: AppendExecutionProvider_Nuphar
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_Nuphar_
|
||||
commentId: Overload:Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar
|
||||
isSpec: "True"
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_Nuphar
|
||||
nameWithType: SessionOptions.AppendExecutionProvider_Nuphar
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.AppendExecutionProvider_OpenVINO(System.String)
|
||||
name: AppendExecutionProvider_OpenVINO(String)
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_AppendExecutionProvider_OpenVINO_System_String_
|
||||
|
|
@ -3958,19 +3963,6 @@ references:
|
|||
isSpec: "True"
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithCudaProvider
|
||||
nameWithType: SessionOptions.MakeSessionOptionWithCudaProvider
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider(String)
|
||||
name: MakeSessionOptionWithNupharProvider(String)
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithNupharProvider_String_
|
||||
commentId: M:Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider(String)
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider(String)
|
||||
nameWithType: SessionOptions.MakeSessionOptionWithNupharProvider(String)
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider*
|
||||
name: MakeSessionOptionWithNupharProvider
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithNupharProvider_
|
||||
commentId: Overload:Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider
|
||||
isSpec: "True"
|
||||
fullName: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithNupharProvider
|
||||
nameWithType: SessionOptions.MakeSessionOptionWithNupharProvider
|
||||
- uid: Microsoft.ML.OnnxRuntime.SessionOptions.MakeSessionOptionWithRocmProvider(System.Int32)
|
||||
name: MakeSessionOptionWithRocmProvider(Int32)
|
||||
href: api/Microsoft.ML.OnnxRuntime.SessionOptions.html#Microsoft_ML_OnnxRuntime_SessionOptions_MakeSessionOptionWithRocmProvider_System_Int32_
|
||||
|
|
|
|||
Loading…
Reference in a new issue