replace e.g. with for example #1016

mairaw · 2018-09-25T00:46:11Z

I've noticed in some of the API docs for ML.NET that I was browsing that there is a heavy use of e.g. which is against our style guide rules (https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/e/eg). So replaced it across the board on the repo.

Once this is merged, I can create a separate PR for i.e. which also shouldn't be used.

TomFinley · 2018-09-25T03:31:57Z

docs/code/IDataViewImplementation.md

@@ -337,13 +337,13 @@ aside (which we can hardly help), we expect the models to be the same.
 When you create a loader you have the option of specifying not only *one* data
 input, but any number of data input files, including zero. But there's also a
 more general principle at work here with zero files: when deserializing a data
-loader from a data model with an `IMultiStreamSource` with `Count == 0` (e.g.,
+loader from a data model with an `IMultiStreamSource` with `Count == 0` (for example,


It's a little unfortunate that the linebreaking got all screwed up due to the longer lines, but I guess maybe we can opportunistically fix it later? #Closed

@TomFinley this is usually a personal choice. Some people choose to cut the text that way, no?

TomFinley · 2018-09-25T03:34:36Z

Are we going to have a separate PR for i.e.? ;) Edit: I was joking but I see from the PR description but this was actually the plan.

justinormont · 2018-09-25T03:34:47Z

src/Microsoft.ML.Core/Data/RoleMappedSchema.cs

@@ -79,7 +79,7 @@ public static ColumnInfo CreateFromIndex(ISchema schema, int index)
    /// individually configured). Also, by being a one-to-many mapping, it is a way for learners that can consume
    /// multiple features columns to consume that information.
    ///
-    /// This class has convenience fields for several common column roles (se.g., <see cref="Feature"/>, <see
+    /// This class has convenience fields for several common column roles (sfor example, <see cref="Feature"/>, <see


Spelling (propagated from previous) #Closed

TomFinley · 2018-09-25T03:35:05Z

docs/release-notes/0.1/release-0.1.md

@@ -22,7 +22,7 @@ Or from within Visual Studio's NuGet package manager.

 This initial release contains core ML.NET components for enabling machine learning pipelines:

-* ML Data Structures (e.g. `IDataView`, `LearningPipeline`)
+* ML Data Structures (for example, `IDataView`, `LearningPipeline`)


for example [](start = 22, length = 11)

Live documentation seems fine, I guess. This however I'm not sure about. These are release notes that have already been released. They're already out. #Closed

Do you want me to revert in those cases @TomFinley?

Yes I think.

In reply to: 222494637 [](ancestors = 222494637)

justinormont · 2018-09-25T03:36:40Z

src/Microsoft.ML.TensorFlow/TensorFlow/Tensorflow.cs

        ///  (c) Use FailedPrecondition if the client should not retry until
-        ///      the system state has been explicitly fixed.  E.g., if an "rmdir"
+        ///      the system state has been explicitly fixed.  For example, if an "rmdir"


Minor: extra space after period. #Closed

TomFinley · 2018-09-25T03:37:18Z

test/Microsoft.ML.Tests/Scenarios/Api/Estimators/IntrospectiveTraining.cs

@@ -25,7 +25,7 @@ public partial class ApiScenariosTests
        ///  *) The tree ensemble learners, I should be able to inspect the trees.
        ///  *) The LDA transform, I should be able to inspect the topics.
        ///  I view it as essential from a usability perspective that this be discoverable to someone without 
-        ///  having to read documentation.E.g.: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that
+        ///  having to read documentation.For example,: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that


.F [](start = 41, length = 2)

Spacing please... and a spare comma. #Closed

justinormont · 2018-09-25T03:37:20Z

test/Microsoft.ML.Tests/Scenarios/Api/Estimators/Visibility.cs

@@ -13,7 +13,7 @@ public partial class ApiScenariosTests
    {
        /// <summary>
        /// Visibility: It should, possibly through the debugger, be not such a pain to actually
-        /// see what is happening to your data when you apply this or that transform. E.g.: if I
+        /// see what is happening to your data when you apply this or that transform. For example,: if I


Extra comma #Closed

justinormont · 2018-09-25T03:37:51Z

test/Microsoft.ML.Tests/Scenarios/Api/IntrospectiveTraining.cs

@@ -33,7 +33,7 @@ private TOut GetValue<TOut>(Dictionary<string, object> keyValues, string key)
        ///  *) The tree ensemble learners, I should be able to inspect the trees.
        ///  *) The LDA transform, I should be able to inspect the topics.
        ///  I view it as essential from a usability perspective that this be discoverable to someone without 
-        ///  having to read documentation.E.g.: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that
+        ///  having to read documentation.For example,: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that


Missing space & extra comma #Closed

justinormont · 2018-09-25T03:38:12Z

test/Microsoft.ML.Tests/Scenarios/Api/Visibility.cs

@@ -13,7 +13,7 @@ public partial class ApiScenariosTests
    {
        /// <summary>
        /// Visibility: It should, possibly through the debugger, be not such a pain to actually
-        /// see what is happening to your data when you apply this or that transform. E.g.: if I
+        /// see what is happening to your data when you apply this or that transform. For example,: if I


extra comma #Closed

TomFinley · 2018-09-25T03:38:29Z

src/Microsoft.ML.Data/DataView/CacheDataView.cs

@@ -1403,7 +1403,7 @@ private sealed class ImplVec<T> : ColumnCache<VBuffer<T>>
                // For a given row [r], elements at [r] and [r+1] specify the inclusive
                // and exclusive range of values for the two big arrays. In the case
                // of indices, if that range is empty, then the corresponding stored
-                // vector is dense. E.g.: row 5 would have its vector's values stored
+                // vector is dense. For example,: row 5 would have its vector's values stored


e,: [](start = 46, length = 3)

Comma #Closed

justinormont · 2018-09-25T03:38:42Z

src/Microsoft.ML.Data/DataView/CacheDataView.cs

@@ -1403,7 +1403,7 @@ private sealed class ImplVec<T> : ColumnCache<VBuffer<T>>
                // For a given row [r], elements at [r] and [r+1] specify the inclusive
                // and exclusive range of values for the two big arrays. In the case
                // of indices, if that range is empty, then the corresponding stored
-                // vector is dense. E.g.: row 5 would have its vector's values stored
+                // vector is dense. For example,: row 5 would have its vector's values stored


extra comma / colon #Closed

TomFinley · 2018-09-25T03:38:44Z

src/Microsoft.ML.Sweeper/Parameters.cs

@@ -513,7 +513,7 @@ public sealed class SuggestedSweepsParser
        /// Generic parameter parser. Currently hand-hacked to auto-detect type.
        ///
        /// Generic form:   Name:Values
-        /// e.g.:    lr:0.05-0.4
+        /// for example,:    lr:0.05-0.4


e,: [](start = 22, length = 3)

Comma #Closed

justinormont · 2018-09-25T03:38:52Z

src/Microsoft.ML.Sweeper/Parameters.cs

@@ -513,7 +513,7 @@ public sealed class SuggestedSweepsParser
        /// Generic parameter parser. Currently hand-hacked to auto-detect type.
        ///
        /// Generic form:   Name:Values
-        /// e.g.:    lr:0.05-0.4
+        /// for example,:    lr:0.05-0.4


Extra comma #Closed

justinormont · 2018-09-25T03:39:10Z

test/Microsoft.ML.Tests/Scenarios/Api/Estimators/IntrospectiveTraining.cs

@@ -25,7 +25,7 @@ public partial class ApiScenariosTests
        ///  *) The tree ensemble learners, I should be able to inspect the trees.
        ///  *) The LDA transform, I should be able to inspect the topics.
        ///  I view it as essential from a usability perspective that this be discoverable to someone without 
-        ///  having to read documentation.E.g.: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that
+        ///  having to read documentation.For example,: if I have var lda = new LdaTransform().Fit(data)(I don't insist on that


Extra comma / colon #Closed

justinormont · 2018-09-25T03:39:54Z

src/Microsoft.ML.TensorFlow/TensorFlow/Tensorflow.cs

@@ -1776,7 +1776,7 @@ internal enum TFCode : uint
        Aborted = 10,

        /// <summary>
-        /// Operation tried to iterate past the valid input range.  E.g., seeking or
+        /// Operation tried to iterate past the valid input range.  For example, seeking or


Extra space after period #Closed

mairaw · 2018-10-03T23:17:48Z

Feedback and merge conflicts resolved. I know it's a funny PR @TomFinley but given this are making into the product and documentation, I think we should follow the style guide. Decided to separate the i.e. just to not overwhelm you with a giant PR.

justinormont · 2018-10-04T02:52:13Z

src/Microsoft.ML.Data/StaticPipe/StaticSchemaShape.cs

@@ -14,7 +14,7 @@ namespace Microsoft.ML.StaticPipe.Runtime
    /// <summary>
    /// A schema shape with names corresponding to a type parameter in one of the typed variants
    /// of the data pipeline structures. Instances of this class tend to be bundled with the statically
-    /// typed variants of the dynamic structures (e.g., <see cref="DataView{TShape}"/> and so forth),
+    /// typed variants of the dynamic structures (for example, <see cref="DataView{TTupleShape}"/> and so forth),


Was renaming TShape to TTupleShape intentional? #Closed

Nope. I probably did a wrong analysis when resolving conflicts. The only changes should be spaces and e.g. -> for example #Closed

justinormont

LGTM

Zruty0

Zruty0 · 2018-10-05T16:42:12Z

@mairaw thanks for doing the work!
Could you please undo the changes for old release notes, then it will be good to go?

mairaw · 2018-10-09T18:01:46Z

Thanks everyone for their feedback. I think this should be ready then!

justinormont · 2018-10-09T18:49:31Z

I'm going to close/re-open to restart the CI tests.

Error looks to be:

2018-10-09T18:08:09.5762190Z Error Message:
2018-10-09T18:08:09.5762970Z  System.InvalidOperationException : MTA thread failed
2018-10-09T18:08:09.5764350Z ---- Assert.InRange() Failure
2018-10-09T18:08:09.5765820Z Range:  (-0.0001 - 0.0001)
2018-10-09T18:08:09.5768440Z Actual: -6
2018-10-09T18:08:09.5768600Z Stack Trace:
2018-10-09T18:08:09.5768920Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.RunMTAThread(ThreadStart fn) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 807
2018-10-09T18:08:09.5769140Z    at Microsoft.ML.Runtime.RunTests.TestPredictors.MulticlassTreeFeaturizedLRTest() in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.Predictor.Tests/TestPredictors.cs:line 201
2018-10-09T18:08:09.5769780Z ----- Inner Stack Trace -----
2018-10-09T18:08:09.5769960Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.MatchNumberWithTolerance(MatchCollection firstCollection, MatchCollection secondCollection, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 616
2018-10-09T18:08:09.5770150Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.GetNumbersFromFile(String& firstString, String& secondString, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 601
2018-10-09T18:08:09.5770310Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.CheckEqualityFromPathsCore(String relPath, String basePath, String outPath, Int32 skip, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 581
2018-10-09T18:08:09.5770480Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.CheckEqualityCore(String dir, String name, String nameBase, Boolean normalize, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 387
2018-10-09T18:08:09.5771030Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.CheckEqualityNormalized(String dir, String name, String nameBase, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 357
2018-10-09T18:08:09.5771370Z    at Microsoft.ML.Runtime.RunTests.TestCommandBase.OutputPath.CheckEqualityNormalized(Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/TestCommandBase.cs:line 76
2018-10-09T18:08:09.5771550Z    at Microsoft.ML.Runtime.RunTests.BaseTestPredictors.Run(RunContext ctx, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestPredictorsMaml.cs:line 167
2018-10-09T18:08:09.5771760Z    at Microsoft.ML.Runtime.RunTests.BaseTestPredictors.Run_TrainTest(PredictorAndArgs predictor, TestDataset dataset, String[] extraSettings, String extraTag, Boolean expectFailure, Boolean summary, Boolean saveAsIni, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestPredictorsMaml.cs:line 389
2018-10-09T18:08:09.5771970Z    at Microsoft.ML.Runtime.RunTests.BaseTestPredictors.RunOneAllTests(PredictorAndArgs predictor, TestDataset dataset, String[] extraSettings, String extraTag, Boolean summary, Int32 digitsOfPrecision) in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestPredictorsMaml.cs:line 357
2018-10-09T18:08:09.5772150Z    at Microsoft.ML.Runtime.RunTests.TestPredictors.<MulticlassTreeFeaturizedLRTest>b__15_0() in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.Predictor.Tests/TestPredictors.cs:line 204
2018-10-09T18:08:09.5772380Z    at Microsoft.ML.Runtime.RunTests.BaseTestBaseline.<>c__DisplayClass107_0.<RunMTAThread>b__0() in /Users/buildagent/agent/agent/_work/1/s/test/Microsoft.ML.TestFramework/BaseTestBaseline.cs:line 792
2018-10-09T18:08:09.5772630Z Standard Output Messages:
2018-10-09T18:08:09.5773520Z  Running 'MulticlassLogisticRegression' on 'iris-tree-featurized'
2018-10-09T18:08:09.5775550Z    Running as: TrainTest tr=MulticlassLogisticRegression{l1=0.001 l2=0.1 ot=1e-3 nt=1} data=/Users/buildagent/agent/agent/_work/1/s/test/data/iris.txt seed=1 test=/Users/buildagent/agent/agent/_work/1/s/test/data/iris.txt loader=Text{col=Label:U4[0-2]:0 col=Features:1-*} xf=TreeFeat{lps=0 trainer=ftr{iter=3}} xf=copy{col=Features:Leaves} out={/Users/buildagent/agent/agent/_work/1/s/bin/AnyCPU.Debug/Microsoft.ML.Predictor.Tests/netcoreapp2.1/TestOutput/MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized-model.zip} dout={/Users/buildagent/agent/agent/_work/1/s/bin/AnyCPU.Debug/Microsoft.ML.Predictor.Tests/netcoreapp2.1/TestOutput/MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized.txt} norm=no
2018-10-09T18:08:09.5776830Z  Output matches baseline: 'MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized-out.txt'
2018-10-09T18:08:09.5777830Z  Output matches baseline: 'MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized.txt'
2018-10-09T18:08:09.5778570Z  Suffix of length 27 compared against sequence of length 41
2018-10-09T18:08:09.5779650Z  Running 'MulticlassLogisticRegression' on 'iris-tree-featurized'
2018-10-09T18:08:09.5781170Z    Running as: CV tr=MulticlassLogisticRegression{l1=0.001 l2=0.1 ot=1e-3 nt=1} data=/Users/buildagent/agent/agent/_work/1/s/test/data/iris.txt seed=1 loader=Text{col=Label:U4[0-2]:0 col=Features:1-*} xf=TreeFeat{lps=0 trainer=ftr{iter=3}} xf=copy{col=Features:Leaves} dout={/Users/buildagent/agent/agent/_work/1/s/bin/AnyCPU.Debug/Microsoft.ML.Predictor.Tests/netcoreapp2.1/TestOutput/MulticlassLogisticRegression/MulticlassLogisticRegression-CV-iris-tree-featurized.txt} norm=no threads-
2018-10-09T18:08:09.5782080Z  Output matches baseline: 'MulticlassLogisticRegression/MulticlassLogisticRegression-CV-iris-tree-featurized-out.txt'
2018-10-09T18:08:09.5783300Z  Output matches baseline: 'MulticlassLogisticRegression/MulticlassLogisticRegression-CV-iris-tree-featurized.txt'
2018-10-09T18:08:09.5784180Z  Running 'MulticlassLogisticRegression' on 'iris-tree-featurized-permuted'
2018-10-09T18:08:09.5786440Z    Running as: TrainTest tr=MulticlassLogisticRegression{l1=0.001 l2=0.1 ot=1e-3 nt=1} data=/Users/buildagent/agent/agent/_work/1/s/test/data/iris.txt seed=1 test=/Users/buildagent/agent/agent/_work/1/s/test/data/iris.txt loader=Text{col=Label:U4[0-2]:0 col=Features:1-*} xf=TreeFeat{lps=2 trainer=ftr{iter=3}} xf=copy{col=Features:Leaves} out={/Users/buildagent/agent/agent/_work/1/s/bin/AnyCPU.Debug/Microsoft.ML.Predictor.Tests/netcoreapp2.1/TestOutput/MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized-permuted-model.zip} dout={/Users/buildagent/agent/agent/_work/1/s/bin/AnyCPU.Debug/Microsoft.ML.Predictor.Tests/netcoreapp2.1/TestOutput/MulticlassLogisticRegression/MulticlassLogisticRegression-TrainTest-iris-tree-featurized-permuted.txt} norm=no
2018-10-09T18:08:09.5787570Z  *** Failure: The test threw an exception - Xunit.Sdk.InRangeException: Assert.InRange() Failure

replace e.g. with for example

19fd0bd

TomFinley reviewed Sep 25, 2018

View reviewed changes