Skip to content

[MRG] improve documentation on sample generators#3001

Merged
jnothman merged 1 commit intoscikit-learn:masterfrom
jnothman:doc_sample_gens
Aug 25, 2014
Merged

[MRG] improve documentation on sample generators#3001
jnothman merged 1 commit intoscikit-learn:masterfrom
jnothman:doc_sample_gens

Conversation

@jnothman
Copy link
Copy Markdown
Member

As pointed out by @GaelVaroquaux and @arjoly at #2828, sample generators could do with better narrative documentation, if not examples.

Here's a start towards that goal. I think I can have a go at describing and inserting plots related to the main classification/clustering and regression generators. It would be nice if someone could provide a comparative introduction to the decomposition generators.

In general, contributions are welcome.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same when pulling 180a2e1 on jnothman:doc_sample_gens into c49723d on scikit-learn:master.

@larsmans
Copy link
Copy Markdown
Member

Small doc fixes/copy edits/clarifications can be pushed straight to master, AFAIC. I find it hard to see the effect of patches on docs in GitHub since the diff context is small, so I'm not very likely to review these.

@jnothman
Copy link
Copy Markdown
Member Author

Fair enough. I don't think this will be that small once I'm done, and I'd
like a second pair of eyes to check it's sensible when it gets there.

On 31 March 2014 00:14, Lars Buitinck notifications@github.com wrote:

Small doc fixes/copy edits/clarifications can be pushed straight to
master, AFAIC. I find it hard to see the effect of patches on docs in
GitHub since the diff context is small, so I'm not very likely to review
these.

Reply to this email directly or view it on GitHubhttps://github.com//pull/3001#issuecomment-39025179
.

@jnothman jnothman changed the title [WIP] improve documentation on sample generators [MRG] improve documentation on sample generators Aug 21, 2014
@jnothman jnothman force-pushed the doc_sample_gens branch 2 times, most recently from 7251e7c to 1815725 Compare August 21, 2014 13:18
@jnothman
Copy link
Copy Markdown
Member Author

This is as far as I want to take this PR. It's touched examples and a bit of API in addition to narrative documentation, so review from another pair of eyes would be helpful.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage increased (+0.0%) when pulling 1815725 on jnothman:doc_sample_gens into 763af96 on scikit-learn:master.

@arjoly
Copy link
Copy Markdown
Member

arjoly commented Aug 25, 2014

+1 great addition to the doc

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It looks like these two are no longer linked now.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Well spotted!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ctrl+F'd the lot of them :)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Added under "generators for manifold learning" subheading.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ctrl+F'd the lot of them :)

Dedication!

@larsmans
Copy link
Copy Markdown
Member

Apart from the comment, +1 for merge (please squash).

Also allow make_multilabel_classification to return underlying
distributions.
@jnothman
Copy link
Copy Markdown
Member Author

Squashed.

@jnothman
Copy link
Copy Markdown
Member Author

And merging.

jnothman added a commit that referenced this pull request Aug 25, 2014
[MRG] improve documentation on sample generators
@jnothman jnothman merged commit da7f009 into scikit-learn:master Aug 25, 2014
@jnothman
Copy link
Copy Markdown
Member Author

Thanks @arjoly and @larsmans

IssamLaradji pushed a commit to IssamLaradji/scikit-learn that referenced this pull request Oct 13, 2014
[MRG] improve documentation on sample generators
@jnothman jnothman mentioned this pull request Dec 10, 2014
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 this pull request may close these issues.

4 participants