Hi Satra,
On Tue, Sep 20, 2011 at 01:14:46AM -0400, Satrajit Ghosh wrote:
> exchange between me and a student on current documentation. i don't know
> what level you are expecting people to be at. this is somebody who is using
> sklearn and understands cross-validation in principle (a 2nd year
> undergraduate).
> *
> *
> *---*
> me: in ipython if you do StratifiedKFold? it will give you help and example
> F: yeah, i just wish it was a little more detailed, if you're using those
> functions for the first time, its really not 100% clear what they do with y
> and everything
> ---
I can give two perspectives on this subject:
1. Docstrings are really not the place you except to learn about
cross-validation. Docstrings cannot really give a high-level picture.
They cannot give a narration, introduce concepts, or display figures.
The narrative documentation (e.g. the webpage) is there for this.
2. The docs, especially the narrative documentation, for
cross-validation are really below standards. It is one of the parts
of the scikit that isn't documented right. Nowadays we try not to
merge code that doesn't have some narrative documentation giving the
big picture.
And finally, I should add that we would indeed like the scikit to be
usable by someone who doesn't know before hand what cross-validation is.
There is a will, and it's just a question of finding the horsepower.
Cheers,
Gaël
------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Scikit-learn-general mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
