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.

Sign up for GitHub

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

Jump to bottom

Write documentation (for developers and users) on read-the-docs #23

Open
sgpjesus opened this issue Aug 3, 2022 · 0 comments
Open

Write documentation (for developers and users) on read-the-docs #23

sgpjesus opened this issue Aug 3, 2022 · 0 comments
Assignees
@AndreFCruz
Labels
documentation Improvements or additions to documentation enhancement New feature or request Important M effort T-shirt effort weighing: M
Milestone
Open-source Release

Comments

@sgpjesus
Copy link
Collaborator

sgpjesus commented Aug 3, 2022 •
edited by AndreFCruz
Loading

Including:

  • Getting started (install and run)
  • Minimal examples (load BAF and train a model in a 4-5 lines code example)
  • Detail FairGBM-specific parameters
  • Detail inner workings of FairGBM (not too detailed tho, point to the paper for that)
@sgpjesus sgpjesus added documentation Improvements or additions to documentation enhancement New feature or request Important labels Aug 3, 2022
@sgpjesus sgpjesus added this to the Open-source Release milestone Aug 3, 2022
@AndreFCruz AndreFCruz added S effort T-shirt effort weighing: S M effort T-shirt effort weighing: M and removed S effort T-shirt effort weighing: S labels Aug 9, 2022
@AndreFCruz AndreFCruz self-assigned this Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AndreFCruz AndreFCruz

Labels
documentation Improvements or additions to documentation enhancement New feature or request Important M effort T-shirt effort weighing: M
Projects
None yet
Milestone
Open-source Release
Development

No branches or pull requests
2 participants
@AndreFCruz @sgpjesus