-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Towards #2522 - LinearSvmTrainer documentation #3401
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
Conversation
/// | Required NuGet in addition to Microsoft.ML | None | | ||
/// | ||
/// ### Training Algorithm Details | ||
/// Linear SVM is an algorithm that trains a model which is a separating hyperplane (a linear binary classification model). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Linear SVM is an algorithm that trains a model which is a separating hyperplane (a linear binary classification model). | |
/// Linear [SVM](https://en.wikipedia.org/wiki/Support-vector_machine#Linear_SVM) trainer implements an algorithm that trains a hyperplane in the feature space for binary classification by solving [SVM problem](https://en.wikipedia.org/wiki/Support-vector_machine#Computing_the_SVM_classifier). | |
``` #Resolved |
@@ -26,8 +26,37 @@ | |||
namespace Microsoft.ML.Trainers | |||
{ | |||
/// <summary> | |||
/// The <see cref="IEstimator{TTransformer}"/> to predict a target using a linear binary classification model | |||
/// trained with Linear SVM. | |||
/// Linear SVM that implements PEGASOS for training. See: http://ttic.uchicago.edu/~shai/papers/ShalevSiSr07.pdf |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linear SVM that implements PEGASOS for training. See: http://ttic.uchicago.edu/~shai/papers/ShalevSiSr07.pdf [](start = 8, length = 108)
Oops. I should remove this line from here. #Resolved
@@ -829,21 +819,11 @@ private static ICalibratorTrainer GetCalibratorTrainerOrThrow(IExceptionContext | |||
} | |||
|
|||
/// <summary> | |||
/// Predict a target using a linear binary classification model trained with the <see cref="LinearSvmTrainer"/> trainer. | |||
/// Create a <see cref="LinearSvmTrainer"/>, which predicts a target using a linear binary classification model |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Create a [](start = 12, length = 39)
the second overload should say:
Create a with advanced options, #Resolved
Codecov Report
@@ Coverage Diff @@
## master #3401 +/- ##
==========================================
+ Coverage 72.69% 72.69% +<.01%
==========================================
Files 807 807
Lines 145171 145171
Branches 16225 16225
==========================================
+ Hits 105536 105537 +1
Misses 35220 35220
+ Partials 4415 4414 -1
|
Codecov Report
@@ Coverage Diff @@
## master #3401 +/- ##
==========================================
+ Coverage 72.69% 72.72% +0.03%
==========================================
Files 807 805 -2
Lines 145171 145168 -3
Branches 16225 16230 +5
==========================================
+ Hits 105536 105579 +43
+ Misses 35220 35173 -47
- Partials 4415 4416 +1
|
@@ -74,7 +74,7 @@ public sealed class AveragedPerceptronTrainer : AveragedLinearTrainer<BinaryPred | |||
|
|||
/// <summary> | |||
/// Options for the <see cref="AveragedPerceptronTrainer"/> as used in | |||
/// [AveragedPerceptron(Options)](xref:Microsoft.ML.StandardTrainersCatalog.AveragedPerceptron(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.AveragedPerceptronTrainer.Options). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[AveragedPerceptro [](start = 11, length = 19)
please revert this change:
please Use xref instead of cref for method overloads: In addition to working in markdown, the second usage of xref is to create links with short anchortext. For methods with overloads (e.g. trainer extension methods with and without options), the cref text is verbose and human-unreadable. We use xref for those links everywhere, except in <seealso ..> where xref doesn't work. #Resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding documentation for LinearSVM, as specified in #2252.