csharp api for graph transformers (microsoft#741)

askhade · web-flow · commit 2dbce4ebcfe9 · 2019-04-02T17:23:14.000-07:00
* add graph optimization level to csharp api

* format documentation

* changes per review comments
diff --git a/csharp/sample/Microsoft.ML.OnnxRuntime.InferenceSample/Program.cs b/csharp/sample/Microsoft.ML.OnnxRuntime.InferenceSample/Program.cs
@@ -24,8 +24,11 @@ static void UseApi()
         {
             string modelPath = Directory.GetCurrentDirectory() + @"\squeezenet.onnx";
 
+            // Optional : Create session options and set the graph optimization level for the session
+            SessionOptions options = new SessionOptions();
+            options.SetSessionGraphOptimizationLevel(2);
 
-            using (var session = new InferenceSession(modelPath))
+            using (var session = new InferenceSession(modelPath, options))
             {
                 var inputMeta = session.InputMetadata;
                 var container = new List<NamedOnnxValue>();
diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/NativeMethods.cs b/csharp/src/Microsoft.ML.OnnxRuntime/NativeMethods.cs
@@ -157,6 +157,9 @@ IntPtr[] outputValues /* An array of output value pointers. Array must be alloca
         [DllImport(nativeLib, CharSet = charSet)]
         public static extern int OrtSetSessionThreadPoolSize(IntPtr /* OrtSessionOptions* */ options, int sessionThreadPoolSize);
 
+        [DllImport(nativeLib, CharSet = charSet)]
+        public static extern int OrtSetSessionGraphOptimizationLevel(IntPtr /* OrtSessionOptions* */ options, uint graphOptimizationLevel);
+
 
         ///**
         //  * The order of invocation indicates the preference order as well. In other words call this method
diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/SessionOptions.cs b/csharp/src/Microsoft.ML.OnnxRuntime/SessionOptions.cs
@@ -35,6 +35,21 @@ public SessionOptions()
             _nativePtr = NativeMethods.OrtCreateSessionOptions();
         }
 
+        /// <summary>
+        /// Sets the graph optimization level for the session. Default is set to 1.        
+        /// </summary>
+        /// <param name="optimization_level">optimization level for the session</param>
+        /// Available options are : 0, 1, 2
+        /// 0 -> Disable all optimizations
+        /// 1 -> Enable basic optimizations
+        /// 2 -> Enable all optimizations
+        /// <returns>True on success and false otherwise</returns>
+        public bool SetSessionGraphOptimizationLevel(uint optimization_level)
+        {
+            var result = NativeMethods.OrtSetSessionGraphOptimizationLevel(_nativePtr, optimization_level);
+            return result == 0;
+        }
+
         /// <summary>
         /// Default instance
         /// </summary>
diff --git a/csharp/test/Microsoft.ML.OnnxRuntime.Tests/InferenceTest.cs b/csharp/test/Microsoft.ML.OnnxRuntime.Tests/InferenceTest.cs
@@ -50,12 +50,18 @@ public void CanCreateAndDisposeSessionWithModelPath()
             }
         }
 
-        [Fact]
-        private void CanRunInferenceOnAModel()
+        [Theory]
+        [InlineData(0)]
+        [InlineData(2)]
+        private void CanRunInferenceOnAModel(uint graphOptimizationLevel)
         {
             string modelPath = Path.Combine(Directory.GetCurrentDirectory(), "squeezenet.onnx");
 
-            using (var session = new InferenceSession(modelPath))
+            // Set the graph optimization level for this session.
+            SessionOptions options = new SessionOptions();
+            Assert.True(options.SetSessionGraphOptimizationLevel(graphOptimizationLevel));
+
+            using (var session = new InferenceSession(modelPath, options))
             {
                 var inputMeta = session.InputMetadata;
                 var container = new List<NamedOnnxValue>();
@@ -664,8 +670,8 @@ private void VerifyNativeMethodsExist()
             "OrtSessionGetOutputTypeInfo","OrtReleaseSession","OrtCreateSessionOptions","OrtCloneSessionOptions",
             "OrtEnableSequentialExecution","OrtDisableSequentialExecution","OrtEnableProfiling","OrtDisableProfiling",
             "OrtEnableMemPattern","OrtDisableMemPattern","OrtEnableCpuMemArena","OrtDisableCpuMemArena",
-            "OrtSetSessionLogId","OrtSetSessionLogVerbosityLevel","OrtSetSessionThreadPoolSize","OrtSessionOptionsAppendExecutionProvider_CPU",
-            "OrtCreateAllocatorInfo","OrtCreateCpuAllocatorInfo",
+            "OrtSetSessionLogId","OrtSetSessionLogVerbosityLevel","OrtSetSessionThreadPoolSize","OrtSetSessionGraphOptimizationLevel",
+            "OrtSessionOptionsAppendExecutionProvider_CPU","OrtCreateAllocatorInfo","OrtCreateCpuAllocatorInfo",
             "OrtCreateDefaultAllocator","OrtAllocatorFree","OrtAllocatorGetInfo",
             "OrtCreateTensorWithDataAsOrtValue","OrtGetTensorMutableData", "OrtReleaseAllocatorInfo",
             "OrtCastTypeInfoToTensorInfo","OrtGetTensorShapeAndType","OrtGetTensorElementType","OrtGetNumOfDimensions",
@@ -677,7 +683,7 @@ private void VerifyNativeMethodsExist()
                 var x = GetProcAddress(hModule, ep);
                 Assert.False(x == UIntPtr.Zero, $"Entrypoint {ep} not found in module {module}");
             }
-        }
+        }        
 
         static string GetTestModelsDir()
         {
diff --git a/docs/CSharp_API.md b/docs/CSharp_API.md
@@ -105,6 +105,12 @@ Constructs a SessionOptions will all options at default/unset values.
 Accessor to the default static option object
 
 #### Methods
+    SetSessionGraphOptimizationLevel(uint optimization_level);
+Sets the graph optimization level for the session. Default is set to 1. Available options are : {0, 1, 2}. 
+ * 0 -> Disable all optimizations
+ * 1 -> Enable basic optimizations such as redundant node removals and constant folding
+ * 2 -> Enable all optimizations (includes Level1 and more complex optimizations such as node fusions)
+
     AppendExecutionProvider(ExecutionProvider provider);
 Appends execution provider to the session. For any operator in the graph the first execution provider that implements the operator will be user. ExecutionProvider is defined as the following enum.
 

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,11 @@ static void UseApi()`
`24`	`24`	`{`
`25`	`25`	`string modelPath = Directory.GetCurrentDirectory() + @"\squeezenet.onnx";`
`26`	`26`
	`27`	`+ // Optional : Create session options and set the graph optimization level for the session`
	`28`	`+ SessionOptions options = new SessionOptions();`
	`29`	`+ options.SetSessionGraphOptimizationLevel(2);`
`27`	`30`
`28`		`- using (var session = new InferenceSession(modelPath))`
	`31`	`+ using (var session = new InferenceSession(modelPath, options))`
`29`	`32`	`{`
`30`	`33`	`var inputMeta = session.InputMetadata;`
`31`	`34`	`var container = new List<NamedOnnxValue>();`