Hi, What's the difference between tutorials in the user guide http://scikit-image.org/docs/dev/user_guide/tutorials.html and longer examples in the gallery ? http://scikit-image.org/docs/dev/auto_examples/#longer-examples-and-demonstr... Is there any reason to do not gather them? Cheers, -- François Boulogne. http://www.sciunto.org GPG fingerprint: 25F6 C971 4875 A6C1 EDD1 75C8 1AA7 216E 32D5 F22F
Hi Fran�ois,
What's the difference between tutorials in the user guide http://scikit-image.org/docs/dev/user_guide/tutorials.html
and longer examples in the gallery ? http://scikit-image.org/docs/dev/auto_examples/#longer-examples-and-demonstr...
Is there any reason to do not gather them?
The idea of the longer tutorials is to include them in the user guide, in a structured and progressive way (with a table of contents), while the examples are exposed in a "flatter" and less structured way. In my opinion, the user guide should be as comprehensive as possible, somewhat like a course in image processing the scikit-image. Also, the examples of the gallery are generated from python scripts (with docstrings converted to rst, that sphinx converts to html), while the user guide is directly written in rst. But it's true that it leads to some duplication (when I'm writing a tutorial, I typically also write an example for the gallery because I need this to generate the figures used in the tutorial). I think it's good to keep the two ways of accessing the documentation (the linear table of contents of the user guide, as well as the gallery) but having less source duplication would be nice. Cheers, Emmanuelle
Thank you Emmanuelle. Le 27/08/2013 22:22, Emmanuelle Gouillart a écrit :
The idea of the longer tutorials is to include them in the user guide, in a structured and progressive way (with a table of contents), while the examples are exposed in a "flatter" and less structured way. In my opinion, the user guide should be as comprehensive as possible, somewhat like a course in image processing the scikit-image.
So, in your mind, can the guide be also the place to have explanations on the general principles behind algorithms? (That would be really interesting but it represents a huge work.) Or is it the place to treat real examples? like this: http://pythonvision.org/basic-tutorial In my mind, I can distinguish two interesting documents: a/ Illustrations of techniques, like everything on segmentation or everything on denoising... b/ Real image processing with an example picked up from the real world They are two orthogonal points of view. a/ is a nice place to explain and compare algo, whereas b/ aims to train the reader to chain techniques.
I think it's good to keep the two ways of accessing the documentation (the linear table of contents of the user guide, as well as the gallery) but having less source duplication would be nice.
Actually, I was wondering why longer examples are not included in the user guide. I use the gallery to find which example looks like the problem I want to treat and longer examples do not really match this usage. Cheers, -- François Boulogne. http://www.sciunto.org GPG fingerprint: 25F6 C971 4875 A6C1 EDD1 75C8 1AA7 216E 32D5 F22F
participants (2)
-
Emmanuelle Gouillart -
François Boulogne