From 6e1008877e45ad63bfe519e770fadfc1c1624cd2 Mon Sep 17 00:00:00 2001 From: Dmitri Smirnov Date: Mon, 13 Feb 2023 16:40:44 -0800 Subject: [PATCH] Update OrtEnv class documentation (#14650) ### Description Tell more about `OrtEnv` class. ### Motivation and Context Need to mention the importance of creating `OrtEnv` first. --- csharp/src/Microsoft.ML.OnnxRuntime/OnnxRuntime.shared.cs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/OnnxRuntime.shared.cs b/csharp/src/Microsoft.ML.OnnxRuntime/OnnxRuntime.shared.cs index 4e18b22f2a..7cab9e89b6 100644 --- a/csharp/src/Microsoft.ML.OnnxRuntime/OnnxRuntime.shared.cs +++ b/csharp/src/Microsoft.ML.OnnxRuntime/OnnxRuntime.shared.cs @@ -44,7 +44,11 @@ namespace Microsoft.ML.OnnxRuntime } /// - /// 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. /// public sealed class OrtEnv : SafeHandle {