Olivier, Gael,
Thanks for the detailed suggestions.
The tutorial I'm preparing for is on Monday, July 16, so I'll be putting
in a lot of effort in the next couple weeks. I think for present
purposes, I'll plan to keep the tutorial and examples in the old
paradigm of rst + source code with skeletons, and translate the four
examples by-hand into iPython notebooks for the purpose of teaching (but
separate from the scikit-learn repository for now). As the nbconvert
utility matures, I think we should strive to provide automatically
generated notebooks along side the standard format.
The doctest discussion brings up one of my earlier concerns, however: if
the example code concerns the loading and plotting of large example
datasets, then adding it to doctests would require large downloads when
a user runs the tests. I think in this case, skipping doctests is the
better route.
Jake
On 07/05/12 09:47, Olivier Grisel wrote:
> The tutorial itself and inline examples can stay in sphinx + doctests.
> I agree this is a great format for online publishing and maintenance
> checks using doctests.
>
> But converting the 3 or 4 short exercises in notebook format would be great:
>
> Here is the current code for the exercise snippets in my tutorial:
>
> Skeleton for the user to start the exercises with inline comments with
> a short description of the tasks to complete:
>
> https://github.com/ogrisel/scikit-learn/blob/sklearn-tutorial/doc/tutorial/text_analytics/skeletons/exercise_00_digits.py
>
> Solution for the previous exercise:
>
> https://github.com/ogrisel/scikit-learn/blob/sklearn-tutorial/doc/tutorial/text_analytics/solutions/exercise_00_digits.py
>
> Scripts to regenerate the skeleton out of the solution:
>
> https://github.com/ogrisel/scikit-learn/blob/sklearn-tutorial/doc/tutorial/text_analytics/solutions/generate_skeletons.py
>
> None of this is doctested. And I don't want to put pollute the code
> with boilerplate to make that testable. It's up to the teacher to
> check that those exercises still work prior to using them in an
> interactive session.
>
> I think the notebook would perfectly for this scenario. Maybe we could
> write a second script that generates notebooks with empty sections out
> of the solutions.
>
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Scikit-learn-general mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
