scikit-learn/doc
Remi Rampin 623ee42260 Fix link to cross_validation (#9025)
Previously read "search [...] for the best Cross-validation: evaluating estimator performance score", because the title of 'cross_validation' changed.
2017-06-06 22:19:55 +02:00
..
datasets [MRG] DOC add function load_wine to the document (#8965) 2017-05-31 19:36:38 +02:00
developers DOC recommend editable install using pip in contributing (#8974) 2017-06-03 18:47:20 +10:00
images website: added NYU funding to front-page footer and the about section. 2015-11-24 15:20:59 -05:00
includes
logos DOC optimize some PNG images, shaves off 24kB 2014-07-09 17:40:57 +02:00
modules Fix link to cross_validation (#9025) 2017-06-06 22:19:55 +02:00
sphinxext Update to Sphinx-Gallery v0.1.11 (#8222) 2017-06-06 16:35:24 +02:00
templates [MRG+2] DOC framework for keeping API refs for deprecated classes/funcs (#7725) 2016-10-30 16:04:35 +01:00
testimonials Added Zopa testimonial (#8309) 2017-02-08 08:53:29 +01:00
themes/scikit-learn Update to Sphinx-Gallery v0.1.11 (#8222) 2017-06-06 16:35:24 +02:00
tutorial [MRG+1] MAINT drop SciPy < 0.13 (#8854) 2017-06-02 23:36:33 +02:00
Makefile DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
README.md Fixed markdown in doc/README.md (#8925) 2017-05-23 20:28:52 +02:00
about.rst Adding Columbia logo to sponsors listing (#7964) 2016-12-06 10:23:07 +11:00
conf.py Update to Sphinx-Gallery v0.1.11 (#8222) 2017-06-06 16:35:24 +02:00
data_transforms.rst minor grammatical fix 2015-11-16 14:27:51 -08:00
documentation.rst DOC Changed Contributor's Guide to Development Guide #7690 (#7691) 2016-10-19 10:16:11 +11:00
faq.rst [#8972] Add links to FAQ (#9002) 2017-06-06 15:18:57 +02:00
index.rst Adding Columbia logo to sponsors listing (#7964) 2016-12-06 10:23:07 +11:00
install.rst Update numpy refs to 1.8.2 (#8926) 2017-05-24 11:53:37 +10:00
make.bat add html-noplot and changed help message to make.bat (#8524) 2017-03-04 14:56:02 -05:00
model_selection.rst DOC Add the learning curve documentation to model_selection.rst 2015-11-04 15:22:09 +01:00
preface.rst minor fixes to the doc build 2015-09-11 17:32:51 -04:00
presentations.rst Fix docs links (#7005) 2016-07-27 16:58:25 -04:00
related_projects.rst [MRG+1] Documentation: Add xcessiv to related projects (#8985) 2017-06-05 15:25:03 +02:00
supervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) 2015-10-21 14:41:40 -04:00
support.rst [MRG] bump master to 0.19-dev (#7413) 2016-09-23 10:43:31 +05:30
tune_toc.rst sidebar hide on css 2015-05-25 18:25:11 +02:00
unsupervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) 2015-10-21 14:41:40 -04:00
user_guide.rst DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
whats_new.rst [MRG+1] Uncontroversial fixes from estimator tags branch (#8086) 2017-06-06 16:34:47 +02:00

README.md

Documentation for scikit-learn

This section contains the full manual and web page as displayed in http://scikit-learn.org. To generate the full web page, including the example gallery (this might take a while):

make html

Or, if you'd rather not build the example gallery:

make html-noplot

That should create all the doc in directory _build/html

To build the PDF manual, run

make latexpdf

The website is hosted at github and can be updated manually (for releases) by pushing to the https://github.com/scikit-learn/scikit-learn.github.io repository.

It's recommended to run OptiPNG, before uploading the website. The PNG files generated by Matplotlib tend to be ~20% too big, and they're costing us bandwidth. You can run OptiPNG with::

make optipng

Development documentation automated build

A Rackspace cloud server named 'docbuilder' is continuously building the master branch to update the http://scikit-learn.org/dev tree of the website.

The configuration of this server is managed at:

https://github.com/scikit-learn/sklearn-docbuilder