Skip to content

Towards #2522 - RandomizedPcaTrainer documentation #3402

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

Closed
wants to merge 5 commits into from

Conversation

yaeldekel
Copy link

Adding documentation for Randomized PCA, as specified in #2252.

@codecov
Copy link

codecov bot commented Apr 18, 2019

Codecov Report

Merging #3402 into master will increase coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3402      +/-   ##
==========================================
+ Coverage   72.69%   72.74%   +0.05%     
==========================================
  Files         807      807              
  Lines      145171   145206      +35     
  Branches    16225    16230       +5     
==========================================
+ Hits       105536   105635      +99     
+ Misses      35220    35151      -69     
- Partials     4415     4420       +5
Flag Coverage Δ
#Debug 72.74% <ø> (+0.05%) ⬆️
#production 68.29% <ø> (+0.06%) ⬆️
#test 88.98% <ø> (ø) ⬆️
Impacted Files Coverage Δ
src/Microsoft.ML.PCA/PCACatalog.cs 92.3% <ø> (ø) ⬆️
src/Microsoft.ML.PCA/PcaTrainer.cs 79.94% <ø> (ø) ⬆️
src/Microsoft.ML.Data/Transforms/KeyToValue.cs 79.16% <0%> (-0.65%) ⬇️
...ML.Transforms/MutualInformationFeatureSelection.cs 78.58% <0%> (-0.33%) ⬇️
...soft.ML.Tests/Transformers/CategoricalHashTests.cs 100% <0%> (ø) ⬆️
src/Microsoft.ML.Transforms/KernelCatalog.cs 33.33% <0%> (ø) ⬆️
...icrosoft.ML.Transforms/RandomFourierFeaturizing.cs 83.41% <0%> (ø) ⬆️
src/Microsoft.ML.Transforms/NormalizerCatalog.cs 84.78% <0%> (ø) ⬆️
...osoft.ML.Tests/Transformers/TextFeaturizerTests.cs 99.58% <0%> (ø) ⬆️
...soft.ML.Transforms/Text/NgramHashingTransformer.cs 88.79% <0%> (+0.01%) ⬆️
... and 9 more

@yaeldekel yaeldekel added the documentation Related to documentation of ML.NET label Apr 18, 2019

| Output Column Name | Column Type | Description|
| -- | -- | -- |
| `Score` | <xref:System.Single> | The score that was calculated by the anomaly detection model.|
Copy link

@shmoradims shmoradims Apr 18, 2019

Choose a reason for hiding this comment

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

[](start = 38, length = 1)

if the range is (-inf,+inf) we call them 'unbounded score' to be clear that it's not normalized or anything like that. #Resolved

/// ### Training Algorithm Details
/// This trainer trains an approximate PCA using a randomized method for computing the singular value decomposition (SVD) of
/// the matrix whose rows are the input vectors.
/// The method is described [here](https://web.stanford.edu/group/mmds/slides2010/Martinsson.pdf).
Copy link
Member

Choose a reason for hiding this comment

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

My wish is that user can see the scoring rule in this document.

Copy link
Author

Choose a reason for hiding this comment

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

I added it, but are you sure this is needed? isn't it too much math?

@yaeldekel yaeldekel requested a review from shmoradims April 20, 2019 16:07
@shmoradims
Copy link

Duplicate of #3429. Closing for now.

@shmoradims shmoradims closed this Apr 20, 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.

4 participants