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

Add a page to the dataset documentation #156

Open
maks-sh opened this issue Aug 16, 2021 · 2 comments
Open

Add a page to the dataset documentation #156

maks-sh opened this issue Aug 16, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@maks-sh
Copy link
Owner

maks-sh commented Aug 16, 2021

📚 Documentation

There should be a table with approximately the following columns:

  • Dataset name,
  • what is the task,
  • the share of the treatment,
  • the share of the target,
  • a link to the API function
  • link to EDA notebook,
  • In which tutorials were used,
  • Source
@maks-sh maks-sh added documentation Improvements or additions to documentation good first issue Good for newcomers ODS Summer of Code labels Aug 16, 2021
@rishawsingh
Copy link

Do you want this new page in this (scikit-uplift/sklift/datasets/ )file path?

@maks-sh
Copy link
Owner Author

maks-sh commented Aug 17, 2021

Good question👍

Let's add it to User Guide: docs/user_guide/datasets.rst

It is important to add a link to new file in the docs/user_guide/index.rst

@maks-sh maks-sh added help wanted Extra attention is needed and removed ODS Summer of Code labels Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants