baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
scikit-learn/doc
History
Arnaud Joly 0807e19dc2 MAINT deprecate fit_ovr, fit_ovo, fit_ecoc, predict_ovr, predict_ovo, predict_ecoc and predict_proba_ovr 2014-07-19 12:17:22 +02:00
..
datasets move around examples for better structure. 2014-07-17 09:35:30 +02:00
developers move around examples for better structure. 2014-07-17 09:35:30 +02:00
images Add artwork with reference to logos in about.rst 2014-04-23 11:15:22 +02:00
includes DOC: Less warnings during build 2011-04-10 13:59:29 +02:00
logos DOC optimize some PNG images, shaves off 24kB 2014-07-09 17:40:57 +02:00
modules MAINT deprecate fit_ovr, fit_ovo, fit_ecoc, predict_ovr, predict_ovo, predict_ecoc and predict_proba_ovr 2014-07-19 12:17:22 +02:00
sphinxext MAINT: more explicit glob pattern in doc generation 2014-07-14 15:47:17 +02:00
templates DOC: some underlines were too short 2014-01-21 09:13:05 +01:00
testimonials DOC optimize some PNG images, shaves off 24kB 2014-07-09 17:40:57 +02:00
themes/scikit-learn MAINT update doc version navigation 2014-07-15 00:08:48 +02:00
tutorial move around examples for better structure. 2014-07-17 09:35:30 +02:00
Makefile DOC run optipng before uploading website 2014-07-09 17:58:47 +02:00
README MAINT point to the configuration of the docbuilder server 2014-07-15 11:27:55 +02:00
about.rst Minor fixes in the docs 2014-06-07 16:38:53 +02:00
conf.py MAINT master to 0.16-git 2014-07-14 21:42:06 +02:00
data_transforms.rst DOC: put feature extraction before pre-processing. 2013-04-18 22:50:51 +09:00
documentation.rst MAINT update doc version navigation 2014-07-15 00:08:48 +02:00
faq.rst Minor fixes in the docs 2014-06-07 16:38:53 +02:00
index.rst Add related project to website. 2014-07-17 14:30:40 +02:00
install.rst DOC phrasing 2014-07-14 20:40:37 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst Move model persistence doc inside model selection section 2014-06-27 08:57:23 -03:00
presentations.rst Fix Machine Learning for NeuroImaging in Python link. 2014-06-05 15:56:46 -04:00
related_projects.rst Add related project to website. 2014-07-17 14:30:40 +02:00
supervised_learning.rst DOC reference and rename cross decomposition module 2013-07-28 02:56:12 +02:00
support.rst MAINT update doc version links in support.rst 2014-07-15 10:55:47 +02:00
tune_toc.rst cleaner toctree collapsing 2013-10-14 16:19:33 +02:00
unsupervised_learning.rst DOC remove HMM documentation 2014-06-16 21:44:52 +02:00
user_guide.rst Move model persistence doc inside model selection section 2014-06-27 08:57:23 -03:00
whats_new.rst MAINT deprecate fit_ovr, fit_ovo, fit_ecoc, predict_ovr, predict_ovo, predict_ecoc and predict_proba_ovr 2014-07-19 12:17:22 +02:00

README 

Documentation for scikit-learn
-------------------------------

This section contains the full manual and web page as displayed in
http://scikit-learn.sf.net. 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


Upload the generated doc to sourceforge
---------------------------------------

First off, generate HTML documentation::

    make html

This should create a directory _build/html/stable with the documentation in
html format.

Next, make sure you have the PNG optimizer OptiPNG installed.
The PNG files generated by Matplotlib tend to be ~20% too big, and they're
costing us bandwidth. Then issue::

    make optipng

This may take some time. If you have a big machine at your disposal,
check the ``Makefile``; it has a hint on how to speed up this target.

Now can upload the generated HTML documentation using scp or some other SFTP
clients.

    * Project web Hostname: web.sourceforge.net
    * Path: htdocs/
    * Username: Combine your SourceForge.net Username with your SourceForge.net
      project UNIX name using a comma ( "," ); see below
    * Password: Your SourceForge.net Password

An example session might look like the following for Username "jsmith"
uploading a file for this project, using rsync with the right switch for the
permissions:

[jsmith@linux ~]$ rsync -rltvz --delete _build/html/stable/ \
> jsmith,scikit-learn@web.sourceforge.net:htdocs/dev -essh
Connecting to web.sourceforge.net...
The authenticity of host 'web.sourceforge.net (216.34.181.57)' can't be established.
RSA key fingerprint is 68:b3:26:02:a0:07:e4:78:d4:ec:7f:2f:6a:4d:32:c5.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'web.sourceforge.net,216.34.181.57' (RSA) to the list of known hosts.
jsmith,fooproject@web.sourceforge.net's password:
sending incremental file list
...


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:

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