Update the parameters description in the summary as described in the issue 2177 #2432

HerraHak · 2019-02-06T10:28:15Z

Fixes #2177

The description of the parameters have been updated as described by @sfilipi in issue #2177

We are excited to review your PR.

So we can do the best job, please check:

[X ] There's a descriptive title that will make sense to other developers some time from now.
[X ] There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
[X ] Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
[ N/A] You have included any necessary tests in the same PR.

HerraHak · 2019-02-06T11:15:14Z

to be honest I don't know why the code coverage failed... Is there an issue with master?

artidoro · 2019-02-06T11:22:13Z

We have sporadic failures due to the random nature of our tests, I just restarted the code coverage bot. Thanks for your PR!

codecov · 2019-02-06T11:56:29Z

Codecov Report

Merging #2432 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #2432      +/-   ##
==========================================
+ Coverage    71.5%    71.5%   +<.01%     
==========================================
  Files         801      801              
  Lines      142036   142033       -3     
  Branches    16151    16148       -3     
==========================================
+ Hits       101559   101560       +1     
+ Misses      36004    36002       -2     
+ Partials     4473     4471       -2

Flag	Coverage Δ
#Debug	`71.5% <100%> (ø)`	⬆️
#production	`67.79% <100%> (ø)`	⬆️
#test	`85.56% <ø> (ø)`	⬆️

Ivanidzo4ka · 2019-02-06T21:51:26Z

@sfilipi do you mean in issue to unify all column or only specific one?
Because I can see following variation in code for public classes:
/// <param name="labelColumn">The label column name.</param>
/// <param name="labelColumn">The label, or dependent variable.</param>
/// <param name="labelColumn">The labelColumn, or dependent variable.</param>
/// <param name="labelColumn">Name of the column to use for labels.</param>
/// <param name="labelColumn">The labelColumn column.</param>

sfilipi · 2019-02-06T22:05:47Z

@HerraHak thanks for your PR.

I have edited the original issue to describe other feedback that we have had.

this is how those parameters should look like:

/// The name of the label column.
/// The name of the feature column.
/// The name of the optional weights column.

There are many of them, through the code-base. If you don't intend to fix all of them, please don;t close the issue.

@Ivanidzo4ka does the above look good? as long as we standardize to something.
Feel free to propose different language.

sfilipi · 2019-02-06T22:06:25Z

src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs

-        /// <param name="weights">The optional weights column.</param>
+        /// <param name="labelColumn">The name of the label column.</param>
+        /// <param name="featureColumn">The name of the feature column.</param>
+        /// <param name="weights">The name of the optional weights column.</param>


so weightsColumnName, labelColumnName, featureColumnName.

Should we change the name of the parameters too or is a different issue?

If it's not hard for you.
This weights is actually weightsColumn
or weightColumn

@sfilipi why we use singular for feature column and plural for weight column?

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

Ivanidzo4ka · 2019-02-06T22:09:36Z

I'm more than happy with proposed language. I just wonder what is criteria to close issue :)

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

HerraHak · 2019-02-07T05:50:05Z

So if I understand correctly, the language like it is in the pull request is what we want? If that's the case, I can look for other occurrences in the code and change that.

dnfclas · 2019-02-07T10:30:17Z

All CLA requirements met.

HerraHak · 2019-02-07T14:53:09Z

Huh, the code coverage failed again.
Could anybody perhaps relaunch the code coverage test??

sfilipi · 2019-02-07T23:13:08Z

@HerraHak don't worry about the CodeCoverage, that is not blocking.

src/Microsoft.ML.HalLearners/HalLearnersCatalog.cs

src/Microsoft.ML.ImageAnalytics/ExtensionsCatalog.cs

src/Microsoft.ML.ImageAnalytics/ImagePixelExtractor.cs

Ivanidzo4ka · 2019-02-08T01:32:40Z

src/Microsoft.ML.ImageAnalytics/ImageResizer.cs

@@ -135,7 +135,7 @@ private static VersionInfo GetVersionInfo()
        /// <param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
        /// <param name="imageWidth">Width of resized image.</param>
        /// <param name="imageHeight">Height of resized image.</param>
-        /// <param name="inputColumnName">Name of the input column.</param>
+        /// <param name="inputColumnName">The name of the input column.</param>


inputColumnName [](start = 25, length = 15)

inputColumnName [](start = 25, length = 15)

/// Name of the column to transform. If set to , the value of the will be used as source.
#Closed

Ivanidzo4ka · 2019-02-08T01:34:06Z

src/Microsoft.ML.LightGBM/LightGbmMulticlassTrainer.cs

@@ -45,7 +45,7 @@ internal LightGbmMulticlassTrainer(IHostEnvironment env, Options options)
        /// Initializes a new instance of <see cref="LightGbmMulticlassTrainer"/>
        /// </summary>
        /// <param name="env">The private instance of <see cref="IHostEnvironment"/>.</param>
-        /// <param name="labelColumn">The name of The label column.</param>
+        /// <param name="labelColumn">The name of the label column.</param>
        /// <param name="featureColumn">The name of the feature column.</param>
        /// <param name="weights">The name for the column containing the initial weight.</param>


The name for the column containing the initial weight. [](start = 34, length = 54)

The name for the column containing the initial weight. [](start = 34, length = 54)

/// <param name="weightsColumnName">The name of the optional weights column.</param> #Closed

Ivanidzo4ka · 2019-02-08T01:34:27Z

    /// <param name="weightsColumn">The name of the weights column.</param>

/// <param name="weightsColumnName">The name of the optional weights column.</param> #Closed

Refers to: src/Microsoft.ML.StandardLearners/Standard/Online/OnlineGradientDescent.cs:102 in c94be09. [](commit_id = c94be09, deletion_comment = False)

Ivanidzo4ka · 2019-02-10T00:49:07Z

src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs

-        /// <param name="weights">The optional weights column.</param>
+        /// <param name="labelColumn">The name of the label column.</param>
+        /// <param name="featureColumn">The name of the feature column.</param>
+        /// <param name="weights">The name of the optional weights column.</param>


weights [](start = 25, length = 7)

can you update this one as well, otherwise build is not working #Closed

Sorry I meant in whole file. We have strict rules to match parameters names in xml documentation

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

Should be ok now

Ivanidzo4ka · 2019-02-12T05:42:20Z

src/Microsoft.ML.ImageAnalytics/ExtensionsCatalog.cs

-        /// <param name="inputColumnName">Name of the input column.</param>
-        /// <param name="outputColumnName">Name of the resulting output column.</param>
+        /// <param name="inputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
+        /// <param name="outputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>


outputColumnName [](start = 25, length = 16)

you need to switch input and output column. Output column is resulting and input column is name of column to transform.

This is how it suppose to be.

/// <param name="outputColumnName"> Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param> /// <param name="inputColumnName"> Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>

And now check what do you have in param name=

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

Ivanidzo4ka · 2019-02-12T05:43:04Z

src/Microsoft.ML.LightGBM/LightGbmCatalog.cs

-        /// <param name="weights">The weights column.</param>
+        /// <param name="labelColumn">The name of the label column.</param>
+        /// <param name="featureColumn">The name of the features column.</param>
+        /// <param name="weights">The name of the weights column.</param>


the [](start = 46, length = 3)

optional weights column

across whole file

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

…m/HerraHak/machinelearning into 2177-update-parameter-description

Ivanidzo4ka · 2019-02-28T23:22:57Z

@abgoswam covered same thing in his PR.
Thank you for help!

HerraHak · 2019-03-01T09:22:57Z

Well it was nice trying to contribute on this. I'll pick up another issue then.

Update the document as described in the issue 2177

6e1b08e

sfilipi reviewed Feb 6, 2019

View reviewed changes

Changed the parameter's decription where relevant as per the issue 2177

6bf8a17

Ivanidzo4ka reviewed Feb 8, 2019

View reviewed changes

src/Microsoft.ML.HalLearners/HalLearnersCatalog.cs Outdated Show resolved Hide resolved

Ivanidzo4ka reviewed Feb 8, 2019

View reviewed changes

src/Microsoft.ML.ImageAnalytics/ExtensionsCatalog.cs Outdated Show resolved Hide resolved

Ivanidzo4ka reviewed Feb 8, 2019

View reviewed changes

src/Microsoft.ML.ImageAnalytics/ImagePixelExtractor.cs Outdated Show resolved Hide resolved

Ivanidzo4ka reviewed Feb 8, 2019

View reviewed changes

Changed parameters description as per the comment of @Ivanidzo4ka

9e1b8b4

HerraHak force-pushed the 2177-update-parameter-description branch from 6bf8a17 to 9e1b8b4 Compare February 9, 2019 23:58

HerraHak added 2 commits February 10, 2019 01:23

Update the document as described in the issue 2177

726a5e3

Changed the parameter's decription where relevant as per the issue 2177

1103cda

Ivanidzo4ka reviewed Feb 10, 2019

View reviewed changes

HerraHak added 3 commits February 10, 2019 02:11

another small correction

1a9ebb0

corrected weights in treetrainerscatalog

671ca11

fixing the build issue

c94be09

Ivanidzo4ka reviewed Feb 12, 2019

View reviewed changes

Merge branch '2177-update-parameter-description' of https://github.co…

245b336

…m/HerraHak/machinelearning into 2177-update-parameter-description

HerraHak and others added 3 commits February 15, 2019 09:38

changed as per comment of @Ivanidzo4ka

d5ee839

Merge branch 'master' into 2177-update-parameter-description

17e2954

Merge branch 'master' into 2177-update-parameter-description

9dda72d

Ivanidzo4ka closed this Feb 28, 2019

HerraHak deleted the 2177-update-parameter-description branch March 13, 2019 13:16

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the parameters description in the summary as described in the issue 2177 #2432

Update the parameters description in the summary as described in the issue 2177 #2432

HerraHak commented Feb 6, 2019

HerraHak commented Feb 6, 2019

artidoro commented Feb 6, 2019

codecov bot commented Feb 6, 2019 •

edited

Loading

Ivanidzo4ka commented Feb 6, 2019

sfilipi commented Feb 6, 2019

sfilipi Feb 6, 2019

HerraHak Feb 7, 2019

Ivanidzo4ka Feb 8, 2019

Ivanidzo4ka commented Feb 6, 2019

HerraHak commented Feb 7, 2019 via email •

edited

Loading

dnfclas commented Feb 7, 2019 •

edited

Loading

HerraHak commented Feb 7, 2019

sfilipi commented Feb 7, 2019

Ivanidzo4ka Feb 8, 2019 •

edited

Loading

Ivanidzo4ka Feb 8, 2019 •

edited

Loading

Ivanidzo4ka commented Feb 8, 2019 •

edited

Loading

Ivanidzo4ka Feb 10, 2019 •

edited

Loading

Ivanidzo4ka Feb 10, 2019

HerraHak Feb 10, 2019

Ivanidzo4ka Feb 12, 2019

Ivanidzo4ka Feb 15, 2019

Ivanidzo4ka Feb 12, 2019

Ivanidzo4ka Feb 12, 2019

Ivanidzo4ka commented Feb 28, 2019

HerraHak commented Mar 1, 2019

Update the parameters description in the summary as described in the issue 2177 #2432

Update the parameters description in the summary as described in the issue 2177 #2432

Conversation

HerraHak commented Feb 6, 2019

HerraHak commented Feb 6, 2019

artidoro commented Feb 6, 2019

codecov bot commented Feb 6, 2019 • edited Loading

Codecov Report

Ivanidzo4ka commented Feb 6, 2019

sfilipi commented Feb 6, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ivanidzo4ka commented Feb 6, 2019

HerraHak commented Feb 7, 2019 via email • edited Loading

dnfclas commented Feb 7, 2019 • edited Loading

HerraHak commented Feb 7, 2019

sfilipi commented Feb 7, 2019

Ivanidzo4ka Feb 8, 2019 • edited Loading

Choose a reason for hiding this comment

Ivanidzo4ka Feb 8, 2019 • edited Loading

Choose a reason for hiding this comment

Ivanidzo4ka commented Feb 8, 2019 • edited Loading

Ivanidzo4ka Feb 10, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ivanidzo4ka commented Feb 28, 2019

HerraHak commented Mar 1, 2019

codecov bot commented Feb 6, 2019 •

edited

Loading

HerraHak commented Feb 7, 2019 via email •

edited

Loading

dnfclas commented Feb 7, 2019 •

edited

Loading

Ivanidzo4ka Feb 8, 2019 •

edited

Loading

Ivanidzo4ka Feb 8, 2019 •

edited

Loading

Ivanidzo4ka commented Feb 8, 2019 •

edited

Loading

Ivanidzo4ka Feb 10, 2019 •

edited

Loading