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
Vighnesh Birodkar 2f099334f9 MAINT deprecate 1d input arrays for all estimators 
Passing 1D arrays to check_array, without setting `ensure_2d` to false now
raises a deprecation warning before reshaping it. This will later throw an
error.

All Scaler classes also throw warnings when 1D arrays are passed.

All unit tests/doctests are modified to ensure that no 1D arrays are passed,
except in explicit 1D array tests where the warnings have been silenced.

Additional tests are also included which check for different 1D array cases.

2D array tests with one samples and one features are also added and where
they failed, `check_array` call has been modified to give a more useful error
message
 		2015-09-09 15:49:58 +02:00
..
datasets ENH implement LYRL2004 train/test split of rcv1 2015-07-16 19:21:24 +02:00
developers Make more clear that adding algorithms is not the preferred way to start contributing. 2015-07-28 13:06:31 -05:00
images Merge pull request #3659 from chyikwei/onlineldavb 2015-08-09 19:13:01 +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 1d input arrays for all estimators 2015-09-09 15:49:58 +02:00
sphinxext DOC don't show example thumbnails in latex docs 2015-08-29 19:07:53 +10:00
templates DOC show referring examples on API reference pages 2014-07-20 01:32:42 +10:00
testimonials DOC resize images for latex 2015-09-01 19:17:43 +10:00
themes/scikit-learn DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
tutorial MAINT deprecate 1d input arrays for all estimators 2015-09-09 15:49:58 +02:00
Makefile DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
README MAINT point to the configuration of the docbuilder server 2014-07-15 11:27:55 +02:00
about.rst DOC resize images for latex 2015-09-01 19:17:43 +10:00
conf.py DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
data_transforms.rst DOC restructure data transformation user guide 2014-09-11 16:54:03 +10:00
documentation.rst remove links to old docs 2015-07-20 13:50:14 +02:00
faq.rst DOC update FAQ on multiprocessing forkserver 2015-09-01 16:23:13 +02:00
index.rst DOC hide web-specific links from latex build 2015-09-01 19:20:22 +10:00
install.rst Merge pull request #4542 from ogrisel/fix-doc-partial-pip-upgrades 2015-04-09 13:53:08 -04:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00:00
model_selection.rst DOC restructure data transformation user guide 2014-09-11 16:54:03 +10:00
preface.rst DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
presentations.rst add scipy2013 tutorial links to presentations on website. 2015-03-05 11:44:07 -05:00
related_projects.rst DOC rearrange related projects 2015-08-26 00:13:22 +10:00
supervised_learning.rst DOC Narrative doc for the calibration module 2015-02-20 19:37:11 +01:00
support.rst MAINT update doc version links in support.rst 2014-07-15 10:55:47 +02:00
tune_toc.rst sidebar hide on css 2015-05-25 18:25:11 +02:00
unsupervised_learning.rst DOC remove HMM documentation 2014-06-16 21:44:52 +02:00
user_guide.rst DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
whats_new.rst MAINT deprecate 1d input arrays for all estimators 2015-09-09 15:49:58 +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