From a507c0c6a5ff4ebbf3d60f1fb0c22c5eae831b86 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Feb 2023 11:16:35 -0800 Subject: [PATCH] [Automated]: Update C# API docs (#14672) --- docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html | 6 +++++- docs/api/csharp/api/Microsoft.ML.OnnxRuntime.html | 6 +++++- docs/api/csharp/manifest.json | 4 ++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html index 6425c4915f..807f2ab6d7 100644 --- a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html +++ b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.OrtEnv.html @@ -73,7 +73,11 @@

Class OrtEnv

-

This class initializes the process-global ONNX Runtime environment instance (OrtEnv)

+

This class initializes the process-global ONNX Runtime environment instance (OrtEnv). +The singleton class OrtEnv contains the process-global ONNX Runtime environment. +It sets up logging, creates system wide thread-pools (if Thread Pool options are provided) +and other necessary things for OnnxRuntime to function. Create or access OrtEnv by calling +the Instance() method. Call this method before doing anything else in your application.

diff --git a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.html b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.html index e6fd8ffc10..76a60e900f 100644 --- a/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.html +++ b/docs/api/csharp/api/Microsoft.ML.OnnxRuntime.html @@ -123,7 +123,11 @@ See docs/C_API.md for more details

Holds the options for configuring a CUDA Execution Provider instance

OrtEnv

-

This class initializes the process-global ONNX Runtime environment instance (OrtEnv)

+

This class initializes the process-global ONNX Runtime environment instance (OrtEnv). +The singleton class OrtEnv contains the process-global ONNX Runtime environment. +It sets up logging, creates system wide thread-pools (if Thread Pool options are provided) +and other necessary things for OnnxRuntime to function. Create or access OrtEnv by calling +the Instance() method. Call this method before doing anything else in your application.

OrtExternalAllocation

This class represents an arbitrary buffer of memory diff --git a/docs/api/csharp/manifest.json b/docs/api/csharp/manifest.json index 3342a746d5..ffbbf98784 100644 --- a/docs/api/csharp/manifest.json +++ b/docs/api/csharp/manifest.json @@ -249,7 +249,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.ML.OnnxRuntime.OrtEnv.html", - "hash": "PXeW553V+aEWRDISvceN6PnUZWZpjFpHmwL5DNu5sD0=" + "hash": "iS3nVfeBTzG9n4zcHwl3sRPnbjZt2l/lsnAbizwVd1o=" } }, "is_incremental": true, @@ -561,7 +561,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.ML.OnnxRuntime.html", - "hash": "cJW7ywORI8Dbb97+DSeaDVXbbRQ7SHrQsKz164PEMlE=" + "hash": "tI3yVHfUX4r6AMiVLyXozouqJ4oFAjvf3LaP8S7e7XA=" } }, "is_incremental": true,