2011/10/28 Gael Varoquaux <[email protected]>: > On Fri, Oct 28, 2011 at 05:29:51PM +0200, Andreas Mueller wrote: >> Am 28.10.2011 17:23, schrieb Gael Varoquaux: >> > On Fri, Oct 28, 2011 at 05:21:38PM +0200, Olivier Grisel wrote: >> >> Fair enough, but the user should also be aware of the API that turns a >> >> param grid (a dict of sequences) into an iterable param_list as done >> >> in GridSearchCV. >> > Good point. And I think that this is a documentation problem. It clearly >> > is a problem: documentation is hard, and matching users with what they >> > needs is an art. We probably need to work on the see-also sections. > >> As far as I can see, the IterGrid class is not in the API documentation >> at all. If I saw that, I might have come up with your three-liner >> by myself ;) > > So that's clearly a bad point on our side. > >> I thought all classes where in the auto generated Class reference. > > It is not autogenerated. The entries are added by hand in the > modules/reference.rst file. I'll do it right now, instead of doing the > review that I should be doing :} > > All my experience with autogenerated systems have been abysmal, for > technical reasons. Things have improved recently (The latest Sphinx now > seems to have some support for autogeneration). We might want to explore > these options at some point in a little while (not right now, this is too > bleeding edge for my taste.
Apparently this is what NLTK is now using and it looks nice. They run: sphinx-apidoc -F -o doc nltk It generates a new sphinx source folder and the result is published here: http://nltk.github.com/api/ I ran it on my local checkout of sklearn and it seems to work well but some work is required to make it reuse our own theme. -- Olivier http://twitter.com/ogrisel - http://github.com/ogrisel ------------------------------------------------------------------------------ Get your Android app more play: Bring it to the BlackBerry PlayBook in minutes. BlackBerry App World™ now supports Android™ Apps for the BlackBerry® PlayBook™. Discover just how easy and simple it is! http://p.sf.net/sfu/android-dev2dev _______________________________________________ Scikit-learn-general mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
