Permalink
..
Failed to load latest commit information.
datasets various minor spelling tweaks (#9783) Sep 17, 2017
developers DOC fix misleading note about sphinx version Sep 14, 2017
images [MRG] Add Alfred P. Sloan foundation to sponsors and footer (#9402) Jul 22, 2017
includes DOC: Less warnings during build Apr 10, 2011
logos DOC optimize some PNG images, shaves off 24kB Jul 9, 2014
modules various minor spelling tweaks (#9783) Sep 17, 2017
sphinxext MAINT Stop vendoring sphinx-gallery (#9403) Sep 10, 2017
templates [MRG] update numpydoc to upstream, include fix for line numbers (#7355) Jul 18, 2017
testimonials Added Zopa testimonial (#8309) Feb 8, 2017
themes/scikit-learn various minor spelling tweaks (#9783) Sep 17, 2017
tutorial various minor spelling tweaks (#9783) Sep 17, 2017
whats_new [MRG+2] add `var_smoothing` parameter to GaussianNB (#9681) Sep 18, 2017
Makefile DOC provide PDF documentation for download Sep 1, 2015
README.md MAINT Stop vendoring sphinx-gallery (#9403) Sep 10, 2017
about.rst Credit University of Sydney sponsorship (#9466) Aug 1, 2017
conf.py [MRG] update numpydoc to upstream, include fix for line numbers (#7355) Jul 18, 2017
data_transforms.rst minor grammatical fix Nov 16, 2015
documentation.rst DOC Changed Contributor's Guide to Development Guide #7690 (#7691) Oct 18, 2016
faq.rst [MRG] DOC Fix known issues link in faq (#9418) Jul 20, 2017
index.rst [MRG+1] Split what's new into separate files (#9505) Sep 8, 2017
install.rst Update numpy refs to 1.8.2 (#8926) May 24, 2017
make.bat add html-noplot and changed help message to make.bat (#8524) Mar 4, 2017
model_selection.rst DOC Add the learning curve documentation to model_selection.rst Nov 4, 2015
preface.rst minor fixes to the doc build Sep 11, 2015
presentations.rst Fix docs links (#7005) Jul 27, 2016
related_projects.rst [MRG+1] DOC: related project: ML-Ensemble (#9637) Aug 29, 2017
supervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) Oct 21, 2015
support.rst [MRG] bump master to 0.19-dev (#7413) Sep 23, 2016
tune_toc.rst sidebar hide on css May 25, 2015
unsupervised_learning.rst (WIP) Added Multi-layer perceptron (MLP) Oct 21, 2015
user_guide.rst DOC organise documentation hierarchy / table of contents Jun 11, 2015
whats_new.rst [MRG+1] Split what's new into separate files (#9505) Sep 8, 2017

README.md

Documentation for scikit-learn

This section contains the full manual and web page as displayed in http://scikit-learn.org. Building the website requires the sphinx and sphinx-gallery packages:

pip install sphinx sphinx-gallery

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