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
He Chen ea752cd6d2 [MRG + 1] Added some documentation for loading external datasets (Issue 3808) (#7516) 
* Update tutorial.rst

* Update tutorial.rst

* Update tutorial.rst

* Update tutorial.rst

* Update index.rst

* Update index.rst

* Update tutorial.rst

* Update tutorial.rst

* Update tutorial.rst

* Update faq.rst

* Update faq.rst

* Divided in two cases (standard columnar and misc data)

I also added a preprocessing note at the end

* Update tutorial.rst

* Update faq.rst

* Update index.rst

Also added some references that were in the original FAQ and pointed the FAQ to here

* Update index.rst

Added the information from the removed part of the FAQ because I felt that the FAQ version was better than the explanation I gave.

* Update index.rst

reference to skimage and also has sklearn.preprocessing.OneHotEncoder instead of OneHotEncoder

* Update index.rst

* Update index.rst

Changed with @jnothman's feedback 
d16ac523ed

* Update faq.rst

* optimized file formats added to datasets/index.rst

Note: if you manage your own numerical data it is recommended to use an optimized file format such as HDF5 to reduce data load times. Various libraries such as H5Py, PyTables and pandas provides a Python interface for reading and writing data in that format.

- From the FAQ

* faq.rst: Moved the comment in bunch section to datasets index

This comment has been moved to the datasets index in the external_datasets section:
Note: if you manage your own numerical data it is recommended to use an optimized file format such as HDF5 to reduce data load times. Various libraries such as H5Py, PyTables and pandas provides a Python interface for reading and writing data in that format.

* Update index.rst

Included all changes mentioned by @amueller and @jnothman

* Update faq.rst

* Update faq.rst
 		2016-10-08 21:10:31 +11:00
..
datasets [MRG + 1] Added some documentation for loading external datasets (Issue 3808) (#7516) 2016-10-08 21:10:31 +11:00
developers DOC numpydoc requires space between name and column (#7601) 2016-10-07 22:52:39 -04:00
images website: added NYU funding to front-page footer and the about section. 2015-11-24 15:20:59 -05: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 DOC FIX: update warning about random seed with scipy (#7577) 2016-10-05 21:06:20 +11:00
sphinxext [MAINT] Upgrade to Sphinx-Gallery 0.1.4 (#7354) 2016-09-16 10:58:31 +02:00
templates DOC/SPHINX Add template for classes which don't have init (Exception classes) 2015-10-19 22:35:36 +02:00
testimonials Rangespan testimonial has misformatted link (#7576) 2016-10-04 12:41:27 -07:00
themes/scikit-learn [MRG] DOC Fixed the display of search results (#7517) (#7560) 2016-10-06 07:59:22 +11:00
tutorial [MRG + 1] Added some documentation for loading external datasets (Issue 3808) (#7516) 2016-10-08 21:10:31 +11:00
Makefile DOC provide PDF documentation for download 2015-09-01 19:22:50 +10:00
README.md [DOC] update and rename readme to readme.md (#6669) 2016-04-25 19:51:16 +02:00
about.rst [MRG] edit citation indentation in about.rst and add gsoc info for '15 '16 (#7191) 2016-08-16 12:11:36 +10:00
conf.py MAINT/DOC: pngmath deprecated for sphinx >= 1.4 (#7279) 2016-08-29 11:43:41 +02:00
data_transforms.rst minor grammatical fix 2015-11-16 14:27:51 -08:00
documentation.rst [MRG] bump master to 0.19-dev (#7413) 2016-09-23 10:43:31 +05:30
faq.rst [MRG + 1] Added some documentation for loading external datasets (Issue 3808) (#7516) 2016-10-08 21:10:31 +11:00
index.rst minor doc fixes (#7514) 2016-09-28 11:31:29 -07:00
install.rst Update install instructions for Windows (#7550) 2016-10-07 11:20:08 +02:00
make.bat Initial import of rst docs. 2010-01-14 15:13:39 +00: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 Address reviewer comments 2016-08-10 17:00:57 -07: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 fix an indentation issue in whatsnew (#7605) 2016-10-07 21:01:07 -04: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