Fixed documentation for ImageClassificationMetricsCallback to resolve the confusion in issue #4259 (#4298)

harshithapv · web-flow · commit c9f616fdc5a1 · 2019-10-04T17:57:04.000-07:00
* commit b468adb Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 21:19:57 2019 -0700 Fixed a bug in the unit test for image classification commit 30aa4d1 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 20:43:17 2019 -0700 addressed Zeeshan's comments commit 3d4f5fe Merge: 0fbd3d2 718a238 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 20:41:21 2019 -0700 Merge branch 'master' of https://github.com/dotnet/machinelearning into ImageClassificationVBuf commit 0fbd3d2 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 17:10:49 2019 -0700 Changed type to useImageType in LoadImages(). Changed appropriate variable names in ImageClassificationTransform.cs commit 2417888 Merge: 3ad26b4 4944be7 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 16:55:25 2019 -0700 Merge branch 'master' of https://github.com/dotnet/machinelearning into ImageClassificationVBuf commit 3ad26b4 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 15:59:06 2019 -0700 Added buffer re-use while reading the image in netstandard 2.0. Addressed Eric's comments. Changed ImageLoadingTransformer to take a bool type instead of a DataViewType to make it user friendly. (type = true means we are using VBuffer<byte> , type = false means we are using ImageDataViewType) commit c67dd08 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Tue Oct 1 09:50:52 2019 -0700 Added functionality to load images as VBuffer<byte> in ImageLoader. If no DataViewType options are provided it defaults to loading images as ImageDataViewType. Made LoadImages a part of the sample in ResnetV2101TransferLearningTrainTestSplit.cs. Addressed some of the comments from Zeeshan and Yael. Added a unit test for testing the API. Added TargetFrameworks to get cross platform functionality for System.IO.Stream.Read(Span<Byte>) which doesn't work for netstandard2.0. commit ae2ac0d Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Wed Sep 25 14:49:41 2019 -0700 Added some edits to address Yael's comments commit b1e5739 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Wed Sep 25 13:24:03 2019 -0700 Added unit test for the change commit acf985d Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Mon Sep 23 10:39:07 2019 -0700 Changed the calling function back to how it was in master commit b80f7ad Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Mon Sep 23 10:20:31 2019 -0700 Added a few optimizations to re-use buffers and thereby improving performance. commit b106ae0 Author: Harshitha Parnandi Venkata <havenka@microsoft.com> Date: Thu Sep 19 14:07:15 2019 -0700 Changed Image Classification API to take in a VBuffer<byte> type instead of ImagePath. * fixed merge conflicts * Fixed some unit tests that were failing after the merge. Addressed a few comments. * Fixed TensorFlow unit tests * Changed the buffer re-use logic for ReadToEnd * Changed ReadToEnd function to read using span instead of unsafe blocks * removed unnecessary commits * Added version check with backward compatability. Addressed Zeeshan's comments. * Fixed tab and synced to master * Addressed comments. Checkpoint commit * changed the solution files and version check in ImageLoader.cs * Added changes for StableApi.csproj * Added ArrayPool for buffer re-use * Handled the case when MakeGetter src is empty we need to send an empty VBuffer. Another check for handling empty images. * Addressed comments * Added comments to address issue #4259
diff --git a/src/Microsoft.ML.Dnn/ImageClassificationTransform.cs b/src/Microsoft.ML.Dnn/ImageClassificationTransform.cs
@@ -1101,7 +1101,8 @@ public enum EarlyStoppingMetric
         }
 
         /// <summary>
-        /// Callback that returns DNN statistics during training phase.
+        /// Callback that returns DNN statistics during bottlenack phase and training phase.
+        /// Train metrics may be null when bottleneck phase is running, so have check!
         /// </summary>
         public delegate void ImageClassificationMetricsCallback(ImageClassificationMetrics metrics);
 
@@ -1283,7 +1284,8 @@ public bool ShouldStop(TrainMetrics currentMetrics)
         }
 
         /// <summary>
-        /// Metrics for image classification training.
+        /// Metrics for image classification bottlenect phase and training.
+        /// Train metrics may be null when bottleneck phase is running, so have check!
         /// </summary>
         public sealed class ImageClassificationMetrics
         {

Original file line number	Diff line number	Diff line change
`@@ -1101,7 +1101,8 @@ public enum EarlyStoppingMetric`
`1101`	`1101`	`}`
`1102`	`1102`
`1103`	`1103`	`/// <summary>`
`1104`		`- /// Callback that returns DNN statistics during training phase.`
	`1104`	`+ /// Callback that returns DNN statistics during bottlenack phase and training phase.`
	`1105`	`+ /// Train metrics may be null when bottleneck phase is running, so have check!`
`1105`	`1106`	`/// </summary>`
`1106`	`1107`	`public delegate void ImageClassificationMetricsCallback(ImageClassificationMetrics metrics);`
`1107`	`1108`
`@@ -1283,7 +1284,8 @@ public bool ShouldStop(TrainMetrics currentMetrics)`
`1283`	`1284`	`}`
`1284`	`1285`
`1285`	`1286`	`/// <summary>`
`1286`		`- /// Metrics for image classification training.`
	`1287`	`+ /// Metrics for image classification bottlenect phase and training.`
	`1288`	`+ /// Train metrics may be null when bottleneck phase is running, so have check!`
`1287`	`1289`	`/// </summary>`
`1288`	`1290`	`public sealed class ImageClassificationMetrics`
`1289`	`1291`	`{`