Skip to content
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

Create learners document #5698

Closed
wants to merge 6 commits into from
Closed

Conversation

aditidugar-zz
Copy link
Contributor

@aditidugar-zz aditidugar-zz commented May 30, 2018

Document to describe learning algorithms.

@GalOshri I will need help from your team to fill out the definitions/descriptions of the learners.

Internal Review URL

@mairaw mairaw requested review from GalOshri and OliaG June 12, 2018 21:47
@mairaw mairaw added waiting-on-reviews and removed waiting-on-reviews waiting-on-feedback Waiting for feedback from SMEs before they can be merged labels Jun 12, 2018
@aditidugar-zz
Copy link
Contributor Author

@CESARDELATORRE will be helping with these docs too. He is now a collaborator on my forked docs repo so he should be able to take it from here.

@GalOshri are you able to help review the table accuracy as a first step?

@@ -0,0 +1,67 @@
# Learning Algorithms
The following table will help you understand the different learning algorithms (learners) included in ML.NET and the [machine learning tasks](tasks.md) that they can be used for. Click on the learner name for more in-depth explanations on each of these learning methods.

Choose a reason for hiding this comment

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

Perhaps "the machine learning tasks where they can be used"?

| [Generalized Additive Models](#generalized-additive-models) |:heavy_check_mark:||:heavy_check_mark:||||
| [K-Means++](#k-means) |||||:heavy_check_mark:||
| [Linear SVM](#linear-svm) |:heavy_check_mark:||||||
| [Logistic Regressor](#logistic-regressor) |:heavy_check_mark:|:heavy_check_mark:|||||

Choose a reason for hiding this comment

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

The name of the Logistic Regression learner has been updated (should just be Logistic Regression)

## Linear SVM


## Logistic Regressor

Choose a reason for hiding this comment

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

Each learner has description in the docs based on the description in the code. I'd recommend avoiding duplication if possible, linking to the other description, and improving the description in the code.

@GalOshri
Copy link

Looks good so far, thank you for creating this!

> [!NOTE]
> ML.NET is currently in Preview. Not all learning algorithms are currently supported. To submit a request for a certain learner, please open an issue in the [dotnet/machinelearning repository](https://github.com/dotnet/machinelearning/issues).

| Learner Name | Binary classification | Multi-class classification | Regression | Ranking | Clustering | Anomaly Detection |
Copy link
Member

Choose a reason for hiding this comment

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

In other docs we are spelling "Multiclass", not "Multi-class". I'd suggest to be consistent. in ML world "Multiclass" seems to be more common (https://en.wikipedia.org/wiki/Multiclass_classification, http://www.mit.edu/~9.520/spring09/Classes/multiclass.pdf, https://www.coursera.org/learn/machine-learning/lecture/gFpiW/multiclass-classification) .

| [K-Means++](#k-means) |||||:heavy_check_mark:||
| [Linear SVM](#linear-svm) |:heavy_check_mark:||||||
| [Logistic Regressor](#logistic-regressor) |:heavy_check_mark:|:heavy_check_mark:|||||
| [Naïve Bayes](#naïve-bayes) ||:heavy_check_mark:|||||
Copy link
Member

Choose a reason for hiding this comment

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

Too many dots above the "i"? :) In our code and in majority of textbooks it's "Naive", which is also easier to search for users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants