Reformatting ModelOperations and DataOperations samples to width 85 #3923

sierralee51 · 2019-06-27T16:35:02Z

Guidelines followed:
-85 characters per line
-Use 4 spaces for indentation
-Dot and open parentheses stay on same line as function
-If not a preexisting line under line that we break, add an extra line after it
-Don't indent comments
-Don't break a comment if it represents output
-Don't break links
-If applicable, break right before $
-Keep math op together

Fix for issue #3478

dnfclas · 2019-06-27T16:35:15Z

All CLA requirements met.

codemzs · 2019-06-27T17:23:24Z

docs/samples/Microsoft.ML.Samples/Dynamic/ModelOperations/SaveLoadModel.cs

@@ -35,11 +36,15 @@ public static void Example()
                model = mlContext.Model.Load(file, out DataViewSchema schema);

            // Create a prediction engine from the model for feeding new data.
-            var engine = mlContext.Model.CreatePredictionEngine<Data, Transformation>(model);
+            var engine = mlContext.Model.CreatePredictionEngine<Data,


@eerhardt Is it ok to break generics like this or should all of it be in the same line as its corresponding class?

I'll fix it so that I split before the "<" in a later pull request. Thanks!

…to samples

eerhardt · 2019-06-27T21:33:44Z

85 characters per line

I kind of think that is too small. In dotnet/spark we are using 100. What's the reasoning for 85?

eerhardt · 2019-06-27T21:39:10Z

docs/samples/Microsoft.ML.Samples/Dynamic/ModelOperations/SaveLoadModelFile.cs

@@ -25,7 +25,8 @@ public static void Example()
            var outputColumnName = nameof(Transformation.Key);

            // Transform.
-            ITransformer model = mlContext.Transforms.Conversion.MapValueToKey(outputColumnName, inputColumnName).Fit(dataView);
+            ITransformer model = mlContext.Transforms.Conversion.MapValueToKey(
+                outputColumnName, inputColumnName).Fit(dataView);


For cases like this, I would rather we break per method call, than to break between a method and its parameter list.

For example:

// If you have chained method calls, line-break each method call Enumerable.Range(0, numRows) .Select(i => i.ToString()) .ToArray();

That is much more readable than:

object o = foo.methodCall( methodCallArg1, methodCallArg2).OtherMethodCall(arg3)

eerhardt · 2019-06-27T21:40:44Z

docs/samples/Microsoft.ML.Samples/Program.cs

@@ -9,6 +9,7 @@ public static class Program

        internal static void RunAll()
        {
+            // Samples counter.


What's the usefulness of this comment? If those words make a better name, it would be better to rename the variable with those words, than to add a comment like this.

My bad, I meant to delete that. That was for an earlier test.

sierralee51 · 2019-06-27T22:20:13Z

85 characters per line

I kind of think that is too small. In dotnet/spark we are using 100. What's the reasoning for 85?

@natke asked for 85 characters to ensure that a horizontal scrollbar is not needed on the docs webpage.

eerhardt · 2019-06-27T22:32:07Z

Ah, ok then I understand why 85 characters is better, it needs to be hosted inside a page with other things around it. Thanks for the explanation.

…tions

sierralee51 · 2019-06-28T00:13:47Z

Guidelines followed:
-85 characters per line
-Use 4 spaces for indentation
-Dot and open parentheses stay on same line as function
-If not a preexisting line under line that we break, add an extra line after it
-Don't indent comments
-Don't break a comment if it represents output
-Don't break links
-If applicable, break right before $
-Keep math op together

Fix for issue #3478

*Updated to include DataOperations samples as well

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/Cache.cs

Co-Authored-By: Justin Ormont <[email protected]>

Got rid of test comment

natke

Width of lines looks good.

Looks like there are quite a few places with extra whitespace at the beginning of the line

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/DataViewEnumerable.cs

natke · 2019-06-28T17:35:47Z

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/DataViewEnumerable.tt

-            var rowEnumerableIgnoreMissing = mlContext.Data.CreateEnumerable<SampleTemperatureDataWithLatitude>(data,
-                reuseRowObject: true, ignoreMissingColumns: true);
+            // We can now examine the records in the IDataView. We first create an
+			// enumerable of rows in the IDataView.


Extra whitespace

Should be fixed. Some tt files have certain indentations that insure that the comments in the cs files align.

Fixed extra whitespace

Fixed whitespace

natke

Looks good! A couple of places where there is an extra carriage return

natke · 2019-06-28T18:59:38Z

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/FilterRowsByColumn.cs

@@ -21,7 +23,9 @@ public static void Example()
            Console.WriteLine($"Date\tTemperature");
            foreach (var row in enumerableOfData)
            {
-                Console.WriteLine($"{row.Date.ToString("d")}\t{row.Temperature}");
+                Console.WriteLine(
+				    $"{row.Date.ToString("d")}\t{row.Temperature}");


Extra carriage return here?

natke · 2019-06-28T19:00:05Z

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/FilterRowsByColumn.cs

            Console.WriteLine($"Date\tTemperature");
            foreach (var row in enumerable)
            {
-                Console.WriteLine($"{row.Date.ToString("d")}\t{row.Temperature}");
+                Console.WriteLine(


Extra carriage return?

natke · 2019-06-28T19:00:20Z

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/FilterRowsByColumn.tt

@@ -16,7 +18,9 @@ string Example = @"// Create a new context for ML.NET operations. It can be used
            Console.WriteLine($""Date\tTemperature"");
            foreach (var row in enumerableOfData)
            {
-                Console.WriteLine($""{row.Date.ToString(""d"")}\t{row.Temperature}"");
+                Console.WriteLine(


Extra carriage return?

natke · 2019-06-28T19:00:32Z

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/FilterRowsByColumn.tt

            Console.WriteLine($""Date\tTemperature"");
            foreach (var row in enumerable)
            {
-                Console.WriteLine($""{row.Date.ToString(""d"")}\t{row.Temperature}"");
+                Console.WriteLine(


Extra carriage return?

Fixed extra carriage returns

…otnet#3923) * Added a comment. * reformatted ModelOperations samples to width 85 * Fixed commented-on parts of MachineOperations & reformatted DataOperations * Update docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/Cache.cs Co-Authored-By: Justin Ormont <[email protected]> * Update Program.cs Got rid of test comment * Update DataViewEnumerable.tt Fixed extra whitespace * Update DataViewEnumerable.cs Fixed extra whitespace * Update DataViewEnumerable.tt Fixed extra whitespace * Update FilterRowsByColumn.tt Fixed whitespace * Update ShuffleRows.tt Fixed whitespace * Update TakeRows.tt Fixed whitespace * Update TakeRows.cs Fixed whitespace * Update SkipRows.cs Fixed whitespace * Update SkipRows.tt Fixed whitespace * Update ShuffleRows.cs Fixed whitespace * Update ShuffleRows.cs Fixed whitespace * Update ShuffleRows.cs * Update ShuffleRows.tt * Update SkipRows.tt * Update SkipRows.cs * Update FilterRowsByColumn.cs Fixed whitespace * Update FilterRowsByColumn.cs Fixed whitespace * Update DataViewEnumerable.cs * Update FilterRowsByColumn.cs Fixed extra carriage returns * Update FilterRowsByColumn.tt Fixed extra carriage returns * Update FilterRowsByColumn.cs * Update FilterRowsByColumn.tt

sierralee51 added 2 commits June 26, 2019 15:20

Added a comment.

f880b7b

reformatted ModelOperations samples to width 85

4f06b84

sierralee51 requested review from codemzs, wschin and artidoro June 27, 2019 16:35

wschin approved these changes Jun 27, 2019

View reviewed changes

codemzs reviewed Jun 27, 2019

View reviewed changes

codemzs requested review from codemzs and eerhardt June 27, 2019 17:23

sierralee51 requested a review from natke June 27, 2019 17:32

Merge branch 'master' of https://github.com/dotnet/machinelearning in…

0c16632

…to samples

eerhardt reviewed Jun 27, 2019

View reviewed changes

Fixed commented-on parts of MachineOperations & reformatted DataOpera…

3ce38a3

…tions

sierralee51 changed the title ~~Reformatting ModelOperations samples to width 85~~ Reformatting ModelOperations and DataOperations samples to width 85 Jun 27, 2019

justinormont reviewed Jun 28, 2019

View reviewed changes

docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/Cache.cs Outdated Show resolved Hide resolved

sierralee51 and others added 2 commits June 28, 2019 05:42

Update docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/Cache.cs

10f40fd

Co-Authored-By: Justin Ormont <[email protected]>

Update Program.cs

00acf2a

Got rid of test comment

codemzs requested review from eerhardt and wschin June 28, 2019 17:14

natke reviewed Jun 28, 2019

View reviewed changes

sierralee51 added 4 commits June 28, 2019 10:58

Update DataViewEnumerable.tt

acdf665

Fixed extra whitespace

Update DataViewEnumerable.cs

842765f

Fixed extra whitespace

Update DataViewEnumerable.tt

fe9c188

Fixed extra whitespace

Update FilterRowsByColumn.tt

2f91a6d

Fixed whitespace

sierralee51 added 14 commits June 28, 2019 11:17

Update ShuffleRows.tt

7a27578

Fixed whitespace

Update TakeRows.tt

cd05ce0

Fixed whitespace

Update TakeRows.cs

61de1fb

Fixed whitespace

Update SkipRows.cs

5d2e8af

Fixed whitespace

Update SkipRows.tt

063a651

Fixed whitespace

Update ShuffleRows.cs

958633b

Fixed whitespace

Update ShuffleRows.cs

01a5390

Fixed whitespace

Update ShuffleRows.cs

0eb6065

Update ShuffleRows.tt

2db2bde

Update SkipRows.tt

8c1989f

Update SkipRows.cs

f39823a

Update FilterRowsByColumn.cs

90ed060

Fixed whitespace

Update FilterRowsByColumn.cs

2a5e8c3

Fixed whitespace

Update DataViewEnumerable.cs

f9d91e6

natke approved these changes Jun 28, 2019

View reviewed changes

sierralee51 added 4 commits June 28, 2019 13:23

Update FilterRowsByColumn.cs

5daecb8

Fixed extra carriage returns

Update FilterRowsByColumn.tt

c436498

Fixed extra carriage returns

Update FilterRowsByColumn.cs

49d7a09

Update FilterRowsByColumn.tt

d2315f9

natke approved these changes Jun 28, 2019

View reviewed changes

sierralee51 merged commit 17c9155 into dotnet:master Jun 28, 2019

ghost locked as resolved and limited conversation to collaborators Mar 21, 2022

Reformatting ModelOperations and DataOperations samples to width 85 #3923

Reformatting ModelOperations and DataOperations samples to width 85 #3923

Uh oh!

Conversation

sierralee51 commented Jun 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dnfclas commented Jun 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eerhardt commented Jun 27, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sierralee51 commented Jun 27, 2019

Uh oh!

eerhardt commented Jun 27, 2019

Uh oh!

sierralee51 commented Jun 28, 2019

Uh oh!

Uh oh!

natke left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

natke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sierralee51 commented Jun 27, 2019 •

edited

Loading

dnfclas commented Jun 27, 2019 •

edited

Loading