Skip to content

Reference to See Also section for example of usage in all estimators #3577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 25, 2019

Conversation

artidoro
Copy link
Contributor

FIxes #3485.

@artidoro artidoro added the documentation Related to documentation of ML.NET label Apr 25, 2019
@artidoro artidoro self-assigned this Apr 25, 2019
@@ -876,6 +876,8 @@ public VBuffer<ReadOnlyMemory<char>>[] SlotNamesMetadata(out VectorDataViewType[
/// <xref:Microsoft.ML.Transforms.Text.NgramHashingEstimator> is different from <xref:Microsoft.ML.Transforms.Text.WordHashBagEstimator>
/// in a way that The former takes tokenized text as input while the latter tokenizes text internally.
/// Check the See Also section for links to examples of the usage.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check [](start = 8, length = 5)

Duplicate.

Forests](https://blogs.technet.microsoft.com/machinelearning/2014/09/10/from-stumps-to-trees-to-forests/)

Check the See Also section for links to examples of the usage.
Copy link
Member

@sfilipi sfilipi Apr 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"to examples of the usage" doesn't sound well..

I think they should all be "to usage examples."

Sorry.. probably should have put that in the bug..

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @sfilipi but we could live with what is here

Forests](https://blogs.technet.microsoft.com/machinelearning/2014/09/10/from-stumps-to-trees-to-forests/)

Check the See Also section for links to examples of the usage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @sfilipi but we could live with what is here

Copy link

@shmoradims shmoradims left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@codecov
Copy link

codecov bot commented Apr 25, 2019

Codecov Report

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

@@            Coverage Diff            @@
##             master    #3577   +/-   ##
=========================================
  Coverage          ?   72.78%           
=========================================
  Files             ?      808           
  Lines             ?   145452           
  Branches          ?    16244           
=========================================
  Hits              ?   105866           
  Misses            ?    35163           
  Partials          ?     4423
Flag Coverage Δ
#Debug 72.78% <ø> (?)
#production 68.29% <ø> (?)
#test 89.04% <ø> (?)
Impacted Files Coverage Δ
...osoft.ML.Transforms/Text/TokenizingByCharacters.cs 95.32% <ø> (ø)
...soft.ML.Transforms/Text/WrappedTextTransformers.cs 93.63% <ø> (ø)
src/Microsoft.ML.Data/Transforms/ColumnCopying.cs 85.43% <ø> (ø)
src/Microsoft.ML.PCA/PcaTrainer.cs 79.94% <ø> (ø)
...ML.Data/Transforms/ColumnConcatenatingEstimator.cs 80.3% <ø> (ø)
src/Microsoft.ML.TimeSeries/IidSpikeDetector.cs 72.54% <ø> (ø)
...rd/MulticlassClassification/OneVersusAllTrainer.cs 74.87% <ø> (ø)
src/Microsoft.ML.Transforms/Text/LdaTransform.cs 89.89% <ø> (ø)
...LogisticRegression/MulticlassLogisticRegression.cs 67.61% <ø> (ø)
src/Microsoft.ML.ImageAnalytics/ImageLoader.cs 84.55% <ø> (ø)
... and 50 more

@artidoro artidoro merged commit 5163413 into dotnet:master Apr 25, 2019
@ghost ghost locked as resolved and limited conversation to collaborators Mar 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Related to documentation of ML.NET
Projects
None yet
Development

Successfully merging this pull request may close these issues.

All transform estimator documentation should point the user that the See Also section contains the example
4 participants