Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
larsmans committed Jun 11, 2011
1 parent 4a00ed5 commit e5f4b44
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ numpy and scipy.
Downloading the PDF
-------------------

Prebuilt versions of this tutorial are available from the `github download
Prebuilt versions of this tutorial are available from the `GitHub download
page`_.

While following the exercices you might find helpful to use the official
Expand All @@ -26,23 +26,23 @@ While following the exercices you might find helpful to use the official
If you need a numpy refresher please first have a look at the
`Scientific Python lecture notes (PDF)`_, esp. chapter 4.

.. _`github download page`: https://github.com/scikit-learn/scikit-learn-tutorial/archives/master
.. _`GitHub download page`: https://github.com/scikit-learn/scikit-learn-tutorial/archives/master
.. _`scikit-learn User Guide (PDF)`: http://downloads.sourceforge.net/project/scikit-learn/documentation/user_guide-0.7.pdf
.. _`Scientific Python lecture notes (PDF)`: http://scipy-lectures.github.com/_downloads/PythonScientific.pdf


Online HTML version
-------------------

The prebuilt HTML version is published as a github pages:
The prebuilt HTML version is at:

http://scikit-learn.github.com/scikit-learn-tutorial


Source code of the tutorial and exercises
-----------------------------------------

The project is hosted on github at https://github.com/scikit-learn/scikit-learn-tutorial
The project is hosted on GitHub at https://github.com/scikit-learn/scikit-learn-tutorial


Building the tutorial
Expand Down Expand Up @@ -70,25 +70,23 @@ To build the PDF variant::
You should get a file named ``scikit_learn_tutorial.pdf`` as output.



Testing
=======

To launch the docstests::
The example snippets in the rST source files can be tested with `nose`_::

$ nosetests -s --with-doctest --doctest-tests --doctest-extension=rst

Mailing list
============
.. _`nose`: http://somethingaboutorange.com/mrl/projects/nose/


Contact the developers
======================

If you have questions about this tutorial you can ask them on the
``scikit-learn`` mailing list on sourceforge:
https://lists.sourceforge.net/lists/listinfo/scikit-learn-general


IRC channel
===========

Some developers tend to hang around the channel ``#scikit-learn``
at ``irc.freenode.net``, especially during the week preparing a new
release. If nobody is available to answer your questions there don't
Expand All @@ -99,7 +97,7 @@ License
=======

This tutorial is distributed under the Creative Commons Attribution
3.0 license. The python source code and exercices solutions are
3.0 license. The Python example code and solutions to exercises are
distributed under the same license as the ``scikit-learn`` project
(Simplidied BSD).
(Simplified BSD).

0 comments on commit e5f4b44

Please sign in to comment.