Skip to content

WIP: reorganize datasets documentation page #11180

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
Merged
merged 4 commits into from
Jun 19, 2018
Merged

WIP: reorganize datasets documentation page #11180

merged 4 commits into from
Jun 19, 2018

Conversation

jeremiedbb
Copy link
Member

Reference Issues/PRs

Work in progress on #11083

What does this implement/fix? Explain your changes.

As a start, removed the descriptions of the toy datasets.

jnothman
jnothman reviewed Jun 4, 2018
View reviewed changes
doc/datasets/index.rst

.. _mldata:

Downloading datasets from the mldata.org repository
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit different because it is a generic fetcher. It fits more with load_svmlight and with pandas, scipy.io, than with fetch_xxx

@jnothman
Copy link
Member

jnothman commented Jun 5, 2018

Yes, it's too nested. Make the top-level headings the following:

  • Dataset API (although it looks like this section could be improved, e.g. with mentioning return_X_y)
  • Toy datasets
  • Real-world datasets
  • Generated datasets
  • Loading other datasets

@jeremiedbb
Copy link
Member Author

@jnothman Changed the structure the way you suggested. I haven't touched at the locations of the files yet. However, I agree with @jorisvandenbossche that at least the files in doc/datasets (i.e. the real world datasets) could be inserted as plain text in index.rst since they aren't used anywhere else.

@jnothman jnothman merged commit 1ff8364 into scikit-learn:master Jun 19, 2018
@jnothman
Copy link
Member

LGTM, thanks!

jnothman added a commit to jnothman/scikit-learn that referenced this pull request Jun 19, 2018
@jnothman
FIX doctests I broke in merging scikit-learn#11180
4653d8b
@jeremiedbb
Copy link
Member Author

@jnothman Thanks but I think you merged it too soon :)
I left some blanks and TODOs in there. I'll make a new PR to complete those soon.

@jnothman
Copy link
Member

jnothman commented Jun 19, 2018 via email

@qinhanmin2014
Copy link
Member

Thanks @jeremiedbb for the great work so far.
Since this PR has been merged, I'll add 0.20 milestone to #11083 (feel free to remove if you think current version is acceptable)

This was referenced Jun 20, 2018
Merged
Closed
georgipeev pushed a commit to georgipeev/scikit-learn that referenced this pull request Jun 20, 2018
@jeremiedbb
DOC reorganize datasets documentation page (scikit-learn#11180)
c9e48bf
@jeremiedbb jeremiedbb deleted the doc-datasets branch June 26, 2018 14:50
jnothman pushed a commit that referenced this pull request Jul 2, 2018
@jeremiedbb @jnothman
DOC: complete PR #11180 for the reorganization of the dataset loadin…
b56fa39 
…g utilities section (#11328)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jnothman jnothman jnothman left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jeremiedbb @jnothman @qinhanmin2014