Skip to content

Documentation samples for binary classifiers #1257

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
sfilipi opened this issue Oct 15, 2018 · 15 comments
Closed

Documentation samples for binary classifiers #1257

sfilipi opened this issue Oct 15, 2018 · 15 comments
Labels
API Issues pertaining the friendly API documentation Related to documentation of ML.NET good first issue Good for newcomers

Comments

@sfilipi
Copy link
Member

sfilipi commented Oct 15, 2018

Similar to the sample code for SDCA regression, we need samples for the binary classifiers:
SDCA
AveragedPerceptron
FastTree
LightGBM

There are two things to do, to resolve this issue:

  1. Add a sample for each of the trainers in Microsoft.ML.Samples/Trainers.cs
    The samples can look similar to the cookbook example
    Download the adult dataset for the data to use.
    Take a look at the SDCA example, for reference.

  2. Add a link to the xml documentation of SDCA
    AveragedPerceptron
    FastTree
    LightGBM
    to reference the new sample methods, like the one in SDCA has.

@sfilipi sfilipi added good first issue Good for newcomers API Issues pertaining the friendly API up-for-grabs A good issue to fix if you are trying to contribute to the project documentation Related to documentation of ML.NET labels Oct 15, 2018
@bojanmisic
Copy link
Contributor

I'd like to work on this one, but wouldn't want to enter in a collision with someone. Is it possible to be assigned to this one?

@sfilipi
Copy link
Member Author

sfilipi commented Oct 15, 2018

Thanks @bojanmisic. It doesn't look like we can assign it, but claiming it on the comments might be good enough. Tag me if you have questions.

@wschin
Copy link
Member

wschin commented Oct 16, 2018

Maybe add a new label "assigned"? @shauheen, any comment?

@justinormont
Copy link
Contributor

Well, once someone claims it, we can simply remove the help wanted and up-for-grabs tags.

@bojanmisic
Copy link
Contributor

@sfilipi, thanks! I believe the link to the cookbook examples has shifted, since the file has been changed recently. Would you like me to use static or dynamic API?

@sfilipi
Copy link
Member Author

sfilipi commented Oct 22, 2018

Dynamic is fine; I was going to log another bug for the static examples, after arranging the structure of that project.
Thanks for picking this up.

@sfilipi
Copy link
Member Author

sfilipi commented Oct 24, 2018

@bojanmisic checking: are you still planning to work on this?

@bojanmisic
Copy link
Contributor

@sfilipi, yes! I plan to work on that during the weekend. I have a strong will to contribute, just been crushed with work last two weeks. Sorry for the inconvenience, if you think someone can get it earlier, feel free to reassign.

@sfilipi
Copy link
Member Author

sfilipi commented Oct 24, 2018

@bojanmisic just checking, before putting the Assigned label and removing the other labels. It is yours, take your time. Take a look at PR #136. I am adding a dateset for binary trainers there.Feel free to adopt if it doesn't get merged soon.

@sfilipi sfilipi added Assigned and removed help wanted up-for-grabs A good issue to fix if you are trying to contribute to the project labels Oct 24, 2018
@bojanmisic
Copy link
Contributor

Added example for SDCA. @sfilipi, can you take a quick look at #1456 if that is what we want - I'll proceed adding other classifiers.

@rekhakodali
Copy link

Can I help on the documentation?

@shmoradims
Copy link

@bojanmisic / @rekhakodali could you please help out with some documentation and samples?
I have a table of BinaryClassification trainers that need work in #2522. You can claim StochasticDualCoordinateAscent or SymbolicStochasticGradientDescent and add yourself (removed me) as the owner on the table. You can replicate #2688 for those trainers.

@bojanmisic
Copy link
Contributor

@shmoradims, I'll be glad to contribute. Feel free to add me to the table for 1 or more (you can add me to both above) trainers, and I'll start working on those asap. I don't have edit permissions for the issue.

@jwood803
Copy link
Contributor

jwood803 commented Mar 1, 2019

@shmoradims @bojanmisic I'll be glad to take a couple of those, as well, if it helps out.

@sfilipi
Copy link
Member Author

sfilipi commented Apr 10, 2019

Closing, as most samples for binary classifiers are complete, and issue #2522 captures the broader work of trainer samples.

@sfilipi sfilipi closed this as completed Apr 10, 2019
@ghost ghost locked as resolved and limited conversation to collaborators Mar 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
API Issues pertaining the friendly API documentation Related to documentation of ML.NET good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

7 participants