XML doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator #3454

artidoro · 2019-04-21T22:33:49Z

Tracked by #3204 .

This PR adds xml doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator.

artidoro · 2019-04-21T22:34:33Z

src/Microsoft.ML.Transforms/GcnTransform.cs

+    /// Let $\mu(x) = \sum_i x_i / n$ be the mean of the values of vector $x$. The <xref:Microsoft.ML.Transforms.LpNormNormalizingTransformer>
+    /// performs the following operation on each input vector $x$:
+    ///
+    ///     $y = \frac{x - \mu(x)}{L(x)}$


I am not sure if I should use the double dollar sign here? #Resolved

This looks fine to me, but the following may be better:

\begin{equation*}
<equation without $ signs>
\end{equation*}

P.S. Don't use $$ as it is plain TeX and may not render in LaTex

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

Same for the equations for the other norm funstions

In reply to: 277185443 [](ancestors = 277185443,277183775)

I think the \begin{equation*} would need the amsmath package available wherever the LaTeX is being rendered so maybe use \[ and \] around the equation instead (only if you decide to replace $, which I don't think is necessary). #Resolved

This is in a markdown block, so I think you need the $ $ #Resolved

But single($equation$) or double ($$equation$$)?

I would like those to be centered. But it is a detail. #Resolved

codecov · 2019-04-21T23:12:29Z

Codecov Report

❗ No coverage uploaded for pull request base (master@7ca768a). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #3454   +/-   ##
=========================================
  Coverage          ?   72.77%           
=========================================
  Files             ?      808           
  Lines             ?   145452           
  Branches          ?    16244           
=========================================
  Hits              ?   105847           
  Misses            ?    35186           
  Partials          ?     4419

Flag	Coverage Δ
#Debug	`72.77% <ø> (?)`
#production	`68.28% <ø> (?)`
#test	`89.04% <ø> (?)`

Impacted Files	Coverage Δ
src/Microsoft.ML.Transforms/NormalizerCatalog.cs	`84.78% <ø> (ø)`
src/Microsoft.ML.Transforms/GcnTransform.cs	`77.57% <ø> (ø)`

najeeb-kazmi · 2019-04-21T23:20:12Z

src/Microsoft.ML.Transforms/NormalizerCatalog.cs

-        ///                                The data type on this column is the same as the input column.</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>
+        /// This column's data type will be the same as the input column's data type.</param>
+        /// <param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the


Name of column to transform [](start = 42, length = 27)

Name of the column to normalize, but if you're nopt changing this for the remaining normalizers (not included in this PR), I'd rather keep this consistent and leave it be. #Resolved

najeeb-kazmi · 2019-04-21T23:21:56Z

src/Microsoft.ML.Transforms/NormalizerCatalog.cs

+        /// This column's data type will be the same as the input column's data type.</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.
+        /// This estimator operates over known-sized vectors of <see cref="System.Single"/>.</param>
        /// <param name="norm">Type of norm to use to normalize each sample. The indicated norm of the resulted vector will be normalized to one.</param>


resulted [](start = 103, length = 8)

resulting #Resolved

najeeb-kazmi · 2019-04-21T23:28:10Z

src/Microsoft.ML.Transforms/NormalizerCatalog.cs

-        ///                                The data type on this column is the same as the input column.</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>
+        /// This column's data type will be the same as the input column's data type.</param>
+        /// <param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the


Name of column to transform [](start = 42, length = 27)

Same as above #Resolved

najeeb-kazmi · 2019-04-21T23:31:15Z

src/Microsoft.ML.Transforms/NormalizerCatalog.cs

        /// <param name="ensureZeroMean">If <see langword="true"/>, subtract mean from each value before normalizing and use the raw input otherwise.</param>
-        /// <param name="ensureUnitStandardDeviation">If <see langword="true"/>, resulted vector's standard deviation would be one. Otherwise, resulted vector's L2-norm would be one.</param>
+        /// <param name="ensureUnitStandardDeviation">If <see langword="true"/>, resulted vector's standard deviation would be one.


resulting #Resolved

najeeb-kazmi · 2019-04-21T23:39:36Z

src/Microsoft.ML.Transforms/GcnTransform.cs

+    ///
+    ///
+    /// The resulting <xref:Microsoft.ML.Transforms.LpNormNormalizingTransformer> normalizes vectors in the input column individually
+    /// by rescaling them applying the global contrast normalization. The <xref:Microsoft.ML.Transforms.LpNormNormalizingTransformer>


maybe "...individually, rescaling them by applying global contrast normalization" #Resolved

najeeb-kazmi

najeeb-kazmi · 2019-04-21T23:40:29Z

Please see minor comments #Resolved

natke · 2019-04-21T23:57:45Z

src/Microsoft.ML.Transforms/GcnTransform.cs

+    /// | Output column data type | Vector of <xref:System.Single> |
+    ///
+    ///
+    /// The resulting <xref:Microsoft.ML.Transforms.LpNormNormalizingTransformer> normalizes vectors in the input column individually


Should this be GlobalContrastNormalizingEstimator? #ByDesign

Both the GlobalContrastNormalizingEstimator and the LpNormalizingEstimator lead to the same transformer the LpNormalizingTransformer after training

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

natke · 2019-04-22T00:07:22Z

src/Microsoft.ML.Transforms/GcnTransform.cs

+    ///     $y = \frac{x}{L(x)}$
+    ///
+    /// There are four types of norm that can be selected by the user to be applied on input vector $x$. They are defined as follows:
+    /// - <xref:Microsoft.ML.Transforms.Text.TextFeaturizingEstimator.NormFunction.L1>


Should these be the Microsoft.ML.Transforms.LpNormNormalizingEstimatorBase.NormFunction values rather than the TextFeaturizing ones? #Resolved

Yes you are right! Thank you for the catch!!

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

lp norm gc norm

ada4969

artidoro added the documentation Related to documentation of ML.NET label Apr 21, 2019

artidoro requested review from natke and shmoradims April 21, 2019 22:33

artidoro self-assigned this Apr 21, 2019

artidoro commented Apr 21, 2019

View reviewed changes

najeeb-kazmi reviewed Apr 21, 2019

View reviewed changes

najeeb-kazmi approved these changes Apr 21, 2019

View reviewed changes

natke approved these changes Apr 22, 2019

View reviewed changes

review comments

87c270b

artidoro merged commit dc61418 into dotnet:master Apr 22, 2019

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XML doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator #3454

XML doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator #3454

artidoro commented Apr 21, 2019

artidoro Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

natke Apr 21, 2019 •

edited by artidoro

Loading

artidoro Apr 22, 2019 •

edited

Loading

codecov bot commented Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi left a comment

najeeb-kazmi commented Apr 21, 2019 •

edited by artidoro

Loading

natke Apr 21, 2019 •

edited by artidoro

Loading

artidoro Apr 22, 2019

natke Apr 22, 2019 •

edited by artidoro

Loading

artidoro Apr 22, 2019

XML doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator #3454

XML doc for LpNormalizingEstimator and GlobalContrastNormalizingEstimator #3454

Conversation

artidoro commented Apr 21, 2019

artidoro Apr 21, 2019 • edited Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

natke Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

artidoro Apr 22, 2019 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Apr 21, 2019 • edited Loading

Codecov Report

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

najeeb-kazmi Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

najeeb-kazmi left a comment

Choose a reason for hiding this comment

najeeb-kazmi commented Apr 21, 2019 • edited by artidoro Loading

natke Apr 21, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

artidoro Apr 22, 2019

Choose a reason for hiding this comment

natke Apr 22, 2019 • edited by artidoro Loading

Choose a reason for hiding this comment

artidoro Apr 22, 2019

Choose a reason for hiding this comment

artidoro Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

natke Apr 21, 2019 •

edited by artidoro

Loading

artidoro Apr 22, 2019 •

edited

Loading

codecov bot commented Apr 21, 2019 •

edited

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi Apr 21, 2019 •

edited by artidoro

Loading

najeeb-kazmi commented Apr 21, 2019 •

edited by artidoro

Loading

natke Apr 21, 2019 •

edited by artidoro

Loading

natke Apr 22, 2019 •

edited by artidoro

Loading