Skip to content

[DOC] Organize the API section (Package overview) #149

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
wdevazelhes opened this issue Jan 4, 2019 · 2 comments · Fixed by #208
Closed

[DOC] Organize the API section (Package overview) #149

wdevazelhes opened this issue Jan 4, 2019 · 2 comments · Fixed by #208
Milestone

Comments

@wdevazelhes
Copy link
Member

wdevazelhes commented Jan 4, 2019

See comment #145 (comment)

EDIT: This issue is for organizing the API section (e.g. separating the weakly supervised algorithms and the supervised algorithms) (see comment below)

@bellet
Copy link
Member

bellet commented Jan 4, 2019

I was thinking that the generic class methods could also be briefly demonstrated in the user guide. Maybe for each part (supervised/weakly sup), we could have a first subsection called something like "General API" which explains input data to give to fit as done currently, as well as the transformer_ attribute and methods like metric, score_pairs and transform. Then the second subsection "Algorithms".

But I also agree that the Package overview section could be better structured

@wdevazelhes
Copy link
Member Author

Oh OK yes I agree, it would fit nicely at the beginning of the User guides, I'll open a separate issue for that

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

Successfully merging a pull request may close this issue.

2 participants