From 31b14652e1fd48016b434ffb5b660e08df1c4439 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Jan 2023 16:22:26 -0800 Subject: [PATCH] [Automated]: Update C# API docs (#13570) --- .../api/Microsoft.ML.OnnxRuntime.OrtApi.html | 168 ++++++++++++++++++ .../api/Microsoft.ML.OnnxRuntime.OrtEnv.html | 27 +++ .../Microsoft.ML.OnnxRuntime.RunOptions.html | 36 ++++ docs/api/csharp/manifest.json | 6 +- docs/api/csharp/xrefmap.yml | 68 +++++++ 5 files changed, 302 insertions(+), 3 deletions(-) diff --git a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtApi.html b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtApi.html index ea43191df4..3779aa296a 100644 --- a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtApi.html +++ b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtApi.html @@ -706,6 +706,30 @@ +

CreateCANNProviderOptions

+
+
+
Declaration
+
+ 
public IntPtr CreateCANNProviderOptions
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

CreateCpuMemoryInfo

@@ -1858,6 +1882,30 @@ +

GetCANNProviderOptionsAsString

+
+
+
Declaration
+
+ 
public IntPtr GetCANNProviderOptionsAsString
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

GetCUDAProviderOptionsAsString

@@ -3010,6 +3058,30 @@ +

MemoryInfoGetDeviceType

+
+
+
Declaration
+
+ 
public IntPtr MemoryInfoGetDeviceType
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

MemoryInfoGetId

@@ -3418,6 +3490,30 @@ +

ReleaseCANNProviderOptions

+
+
+
Declaration
+
+ 
public IntPtr ReleaseCANNProviderOptions
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

ReleaseCUDAProviderOptions

@@ -4474,6 +4570,30 @@ +

SessionOptionsAppendExecutionProvider_CANN

+
+
+
Declaration
+
+ 
public IntPtr SessionOptionsAppendExecutionProvider_CANN
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

SessionOptionsAppendExecutionProvider_CUDA

@@ -5266,6 +5386,30 @@ +

UpdateCANNProviderOptions

+
+
+
Declaration
+
+ 
public IntPtr UpdateCANNProviderOptions
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

UpdateCUDAProviderOptions

@@ -5290,6 +5434,30 @@ +

UpdateEnvWithCustomLogLevel

+
+
+
Declaration
+
+ 
public IntPtr UpdateEnvWithCustomLogLevel
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
IntPtr
+ +

UpdateTensorRTProviderOptions

diff --git a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html index c1fd95ddb3..6425c4915f 100644 --- a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html +++ b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html @@ -91,6 +91,33 @@ + +

EnvLogLevel

+

Get/Set log level property of OrtEnv instance

+
+
+
Declaration
+
+ 
public LogLevel EnvLogLevel { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
LogLevel

env log level

+
+ +

IsInvalid

Overrides SafeHandle.IsInvalid

diff --git a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.RunOptions.html b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.RunOptions.html index 685a933339..c7cf4e496c 100644 --- a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.RunOptions.html +++ b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.RunOptions.html @@ -240,6 +240,42 @@ Default = false

+ +

AddRunConfigEntry(String, String)

+

Set a single run configuration entry as a pair of strings +If a configuration with same key exists, this will overwrite the configuration with the given configValue.

+
+
+
Declaration
+
+ 
public void AddRunConfigEntry(string configKey, string configValue)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.StringconfigKey

config key name

+
System.StringconfigValue

config key value

+
+ +

ReleaseHandle()

Overrides SafeHandle.ReleaseHandle() to properly dispose of diff --git a/docs/api/csharp/manifest.json b/docs/api/csharp/manifest.json index c45cdeb08a..3342a746d5 100644 --- a/docs/api/csharp/manifest.json +++ b/docs/api/csharp/manifest.json @@ -201,7 +201,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.ML.OnnxRuntime.OrtApi.html", - "hash": "sAtiOlRPkaoRheEH0Hs6p5PUIvrmf5sGMeV33rM5v3Q=" + "hash": "kcldkKNm2tP5YLLOId862EIO2K7/UXkzwtud6lemh5g=" } }, "is_incremental": true, @@ -249,7 +249,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.ML.OnnxRuntime.OrtEnv.html", - "hash": "wWh+HZ8oHuyPvUYGFPQHTC4BKbjwvUQAm6souqXVnBU=" + "hash": "PXeW553V+aEWRDISvceN6PnUZWZpjFpHmwL5DNu5sD0=" } }, "is_incremental": true, @@ -393,7 +393,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.ML.OnnxRuntime.RunOptions.html", - "hash": "o1Ixt/L59R92AXuO9u+AcSesGcpptSQU4Rk8ihtL/pc=" + "hash": "rI8D4rpRajKcZdm9ShDdZuT8YaeHglU3N4iRTSzYW9c=" } }, "is_incremental": true, diff --git a/docs/api/csharp/xrefmap.yml b/docs/api/csharp/xrefmap.yml index 3fe1dd9667..7cbed5d26a 100644 --- a/docs/api/csharp/xrefmap.yml +++ b/docs/api/csharp/xrefmap.yml @@ -1239,6 +1239,12 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.CreateArenaCfgV2 fullName: Microsoft.ML.OnnxRuntime.OrtApi.CreateArenaCfgV2 nameWithType: OrtApi.CreateArenaCfgV2 +- uid: Microsoft.ML.OnnxRuntime.OrtApi.CreateCANNProviderOptions + name: CreateCANNProviderOptions + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_CreateCANNProviderOptions + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.CreateCANNProviderOptions + fullName: Microsoft.ML.OnnxRuntime.OrtApi.CreateCANNProviderOptions + nameWithType: OrtApi.CreateCANNProviderOptions - uid: Microsoft.ML.OnnxRuntime.OrtApi.CreateCpuMemoryInfo name: CreateCpuMemoryInfo href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_CreateCpuMemoryInfo @@ -1527,6 +1533,12 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.GetBoundOutputValues fullName: Microsoft.ML.OnnxRuntime.OrtApi.GetBoundOutputValues nameWithType: OrtApi.GetBoundOutputValues +- uid: Microsoft.ML.OnnxRuntime.OrtApi.GetCANNProviderOptionsAsString + name: GetCANNProviderOptionsAsString + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_GetCANNProviderOptionsAsString + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.GetCANNProviderOptionsAsString + fullName: Microsoft.ML.OnnxRuntime.OrtApi.GetCANNProviderOptionsAsString + nameWithType: OrtApi.GetCANNProviderOptionsAsString - uid: Microsoft.ML.OnnxRuntime.OrtApi.GetCUDAProviderOptionsAsString name: GetCUDAProviderOptionsAsString href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_GetCUDAProviderOptionsAsString @@ -1815,6 +1827,12 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.KernelInfoGetAttributeArray_int64 fullName: Microsoft.ML.OnnxRuntime.OrtApi.KernelInfoGetAttributeArray_int64 nameWithType: OrtApi.KernelInfoGetAttributeArray_int64 +- uid: Microsoft.ML.OnnxRuntime.OrtApi.MemoryInfoGetDeviceType + name: MemoryInfoGetDeviceType + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_MemoryInfoGetDeviceType + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.MemoryInfoGetDeviceType + fullName: Microsoft.ML.OnnxRuntime.OrtApi.MemoryInfoGetDeviceType + nameWithType: OrtApi.MemoryInfoGetDeviceType - uid: Microsoft.ML.OnnxRuntime.OrtApi.MemoryInfoGetId name: MemoryInfoGetId href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_MemoryInfoGetId @@ -1917,6 +1935,12 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.ReleaseAvailableProviders fullName: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseAvailableProviders nameWithType: OrtApi.ReleaseAvailableProviders +- uid: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseCANNProviderOptions + name: ReleaseCANNProviderOptions + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_ReleaseCANNProviderOptions + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.ReleaseCANNProviderOptions + fullName: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseCANNProviderOptions + nameWithType: OrtApi.ReleaseCANNProviderOptions - uid: Microsoft.ML.OnnxRuntime.OrtApi.ReleaseCUDAProviderOptions name: ReleaseCUDAProviderOptions href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_ReleaseCUDAProviderOptions @@ -2181,6 +2205,12 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider fullName: Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider nameWithType: OrtApi.SessionOptionsAppendExecutionProvider +- uid: Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider_CANN + name: SessionOptionsAppendExecutionProvider_CANN + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_SessionOptionsAppendExecutionProvider_CANN + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider_CANN + fullName: Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider_CANN + nameWithType: OrtApi.SessionOptionsAppendExecutionProvider_CANN - uid: Microsoft.ML.OnnxRuntime.OrtApi.SessionOptionsAppendExecutionProvider_CUDA name: SessionOptionsAppendExecutionProvider_CUDA href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_SessionOptionsAppendExecutionProvider_CUDA @@ -2379,12 +2409,24 @@ references: commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.UnregisterAllocator fullName: Microsoft.ML.OnnxRuntime.OrtApi.UnregisterAllocator nameWithType: OrtApi.UnregisterAllocator +- uid: Microsoft.ML.OnnxRuntime.OrtApi.UpdateCANNProviderOptions + name: UpdateCANNProviderOptions + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_UpdateCANNProviderOptions + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.UpdateCANNProviderOptions + fullName: Microsoft.ML.OnnxRuntime.OrtApi.UpdateCANNProviderOptions + nameWithType: OrtApi.UpdateCANNProviderOptions - uid: Microsoft.ML.OnnxRuntime.OrtApi.UpdateCUDAProviderOptions name: UpdateCUDAProviderOptions href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_UpdateCUDAProviderOptions commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.UpdateCUDAProviderOptions fullName: Microsoft.ML.OnnxRuntime.OrtApi.UpdateCUDAProviderOptions nameWithType: OrtApi.UpdateCUDAProviderOptions +- uid: Microsoft.ML.OnnxRuntime.OrtApi.UpdateEnvWithCustomLogLevel + name: UpdateEnvWithCustomLogLevel + href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_UpdateEnvWithCustomLogLevel + commentId: F:Microsoft.ML.OnnxRuntime.OrtApi.UpdateEnvWithCustomLogLevel + fullName: Microsoft.ML.OnnxRuntime.OrtApi.UpdateEnvWithCustomLogLevel + nameWithType: OrtApi.UpdateEnvWithCustomLogLevel - uid: Microsoft.ML.OnnxRuntime.OrtApi.UpdateTensorRTProviderOptions name: UpdateTensorRTProviderOptions href: api/Microsoft.ML.OnnxRuntime.OrtApi.html#Microsoft_ML_OnnxRuntime_OrtApi_UpdateTensorRTProviderOptions @@ -2591,6 +2633,19 @@ references: isSpec: "True" fullName: Microsoft.ML.OnnxRuntime.OrtEnv.EnableTelemetryEvents nameWithType: OrtEnv.EnableTelemetryEvents +- uid: Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel + name: EnvLogLevel + href: api/Microsoft.ML.OnnxRuntime.OrtEnv.html#Microsoft_ML_OnnxRuntime_OrtEnv_EnvLogLevel + commentId: P:Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel + fullName: Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel + nameWithType: OrtEnv.EnvLogLevel +- uid: Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel* + name: EnvLogLevel + href: api/Microsoft.ML.OnnxRuntime.OrtEnv.html#Microsoft_ML_OnnxRuntime_OrtEnv_EnvLogLevel_ + commentId: Overload:Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel + isSpec: "True" + fullName: Microsoft.ML.OnnxRuntime.OrtEnv.EnvLogLevel + nameWithType: OrtEnv.EnvLogLevel - uid: Microsoft.ML.OnnxRuntime.OrtEnv.GetAvailableProviders name: GetAvailableProviders() href: api/Microsoft.ML.OnnxRuntime.OrtEnv.html#Microsoft_ML_OnnxRuntime_OrtEnv_GetAvailableProviders @@ -3481,6 +3536,19 @@ references: isSpec: "True" fullName: Microsoft.ML.OnnxRuntime.RunOptions.RunOptions nameWithType: RunOptions.RunOptions +- uid: Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry(System.String,System.String) + name: AddRunConfigEntry(String, String) + href: api/Microsoft.ML.OnnxRuntime.RunOptions.html#Microsoft_ML_OnnxRuntime_RunOptions_AddRunConfigEntry_System_String_System_String_ + commentId: M:Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry(System.String,System.String) + fullName: Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry(System.String, System.String) + nameWithType: RunOptions.AddRunConfigEntry(String, String) +- uid: Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry* + name: AddRunConfigEntry + href: api/Microsoft.ML.OnnxRuntime.RunOptions.html#Microsoft_ML_OnnxRuntime_RunOptions_AddRunConfigEntry_ + commentId: Overload:Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry + isSpec: "True" + fullName: Microsoft.ML.OnnxRuntime.RunOptions.AddRunConfigEntry + nameWithType: RunOptions.AddRunConfigEntry - uid: Microsoft.ML.OnnxRuntime.RunOptions.IsInvalid name: IsInvalid href: api/Microsoft.ML.OnnxRuntime.RunOptions.html#Microsoft_ML_OnnxRuntime_RunOptions_IsInvalid