11.. -*- mode: rst -*-
2-
32 |Travis |_ |AppVeyor |_ |Coveralls |_ |CircleCI |_ |Python27 |_ |Python35 |_ |PyPi |_ |DOI |_
43
54.. |Travis | image :: https://api.travis-ci.org/scikit-learn/scikit-learn.svg?branch=master
2322.. |PyPi | image :: https://badge.fury.io/py/scikit-learn.svg
2423.. _PyPi : https://badge.fury.io/py/scikit-learn
2524
26-
2725.. |DOI | image :: https://zenodo.org/badge/21369/scikit-learn/scikit-learn.svg
2826.. _DOI : https://zenodo.org/badge/latestdoi/21369/scikit-learn/scikit-learn
2927
30-
3128scikit-learn
3229============
3330
@@ -40,36 +37,19 @@ the `AUTHORS.rst <AUTHORS.rst>`_ file for a complete list of contributors.
4037
4138It is currently maintained by a team of volunteers.
4239
43- **Note ** `scikit-learn ` was previously referred to as `scikits.learn `.
44-
45-
46- Important links
47- ===============
40+ Website: http://scikit-learn.org
4841
49- - Official source code repo: https://github.com/scikit-learn/scikit-learn
50- - HTML documentation (stable release): http://scikit-learn.org
51- - HTML documentation (development version): http://scikit-learn.org/dev/
52- - Download releases: http://sourceforge.net/projects/scikit-learn/files/
53- - Issue tracker: https://github.com/scikit-learn/scikit-learn/issues
54- - Mailing list: https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
55- - IRC channel: ``#scikit-learn `` at ``irc.freenode.net ``
42+ Installation
43+ ------------
5644
5745Dependencies
58- ============
59-
60- scikit-learn is tested to work under Python 2.6, Python 2.7, and Python 3.5.
61- (using the same codebase thanks to an embedded copy of
62- `six <http://pythonhosted.org/six/ >`_). It should also work with Python 3.3 and 3.4.
63-
64- The required dependencies to build the software are NumPy >= 1.6.1,
65- SciPy >= 0.9 and a working C/C++ compiler. For the development version,
66- you will also require Cython >=0.23.
46+ ~~~~~~~~~~~~
6747
68- For running the examples Matplotlib >= 1.1.1 is required and for running the
69- tests you need nose >= 1.1.2.
48+ Scikit-learn requires::
7049
71- This configuration matches the Ubuntu Precise 12.04 LTS release from April
72- 2012.
50+ - Python (>= 2.6 or >= 3.3),
51+ - NumPy (>= 1.6.1),
52+ - SciPy (>= 0.9).
7353
7454scikit-learn also uses CBLAS, the C interface to the Basic Linear Algebra
7555Subprograms library. scikit-learn comes with a reference implementation, but
@@ -78,50 +58,52 @@ CBLAS exists in many implementations; see `Linear algebra libraries
7858<http://scikit-learn.org/stable/modules/computational_performance.html#linear-algebra-libraries> `_
7959for known issues.
8060
61+ User installation
62+ ~~~~~~~~~~~~~~~~~
8163
82- Install
83- =======
64+ If you already have a working installation of numpy and scipy,
65+ the easiest way to install scikit-learn is using `` pip `` ::
8466
85- This package uses distutils, which is the default way of installing
86- python modules. To install in your home directory, use::
67+ pip install -U scikit-learn
8768
88- python setup.py install --user
69+ or `` conda ``::
8970
90- To install for all users on Unix/Linux::
71+ conda install scikit-learn
9172
92- python setup.py build
93- sudo python setup.py install
73+ The documentation includes more detailed `installation instructions <http://scikit-learn.org/stable/install.html >`_.
9474
95- For more detailed installation instructions,
96- see the web page http://scikit-learn.org/stable/install.html
9775
9876Development
99- ===========
77+ -----------
10078
101- Code
102- ----
79+ We welcome new contributors of all experience levels. The scikit-learn
80+ community goals are to be helpful, welcoming, and effective. The
81+ `Contributor's Guide <http://scikit-learn.org/stable/developers/index.html >`_
82+ has detailed information about contributing code, documentation, tests, and
83+ more. We've included some basic information in this README.
10384
104- GIT
105- ~~~
85+ Important links
86+ ~~~~~~~~~~~~~~~
87+
88+ - Official source code repo: https://github.com/scikit-learn/scikit-learn
89+ - Download releases: http://sourceforge.net/projects/scikit-learn/files/
90+ - Issue tracker: https://github.com/scikit-learn/scikit-learn/issues
91+
92+ Source code
93+ ~~~~~~~~~~~
10694
10795You can check the latest sources with the command::
10896
10997 git clone https://github.com/scikit-learn/scikit-learn.git
11098
111-
112- Contributing
113- ~~~~~~~~~~~~
99+ Setting up a development environment
100+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114101
115102Quick tutorial on how to go about setting up your environment to
116103contribute to scikit-learn: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md
117104
118- Before opening a Pull Request, have a look at the
119- full Contributing page to make sure your code complies
120- with our guidelines: http://scikit-learn.org/stable/developers/index.html
121-
122-
123105Testing
124- -------
106+ ~~~~~~~
125107
126108After installation, you can launch the test suite from outside the
127109source directory (you will need to have the ``nose `` package installed)::
@@ -139,3 +121,41 @@ for more information.
139121
140122 Random number generation can be controlled during testing by setting
141123 the ``SKLEARN_SEED `` environment variable.
124+
125+ Submitting a Pull Request
126+ ~~~~~~~~~~~~~~~~~~~~~~~~~
127+
128+ Before opening a Pull Request, have a look at the
129+ full Contributing page to make sure your code complies
130+ with our guidelines: http://scikit-learn.org/stable/developers/index.html
131+
132+
133+ Project history
134+ ---------------
135+
136+ The project was started in 2007 by David Cournapeau as a Google Summer
137+ of Code project, and since then many volunteers have contributed. See
138+ the AUTHORS.rst file for a complete list of contributors.
139+
140+ The project is currently maintained by a team of volunteers.
141+
142+ **Note ** `scikit-learn ` was previously referred to as `scikits.learn `.
143+
144+
145+ Help and Support
146+ ----------------
147+
148+ Documentation
149+ ~~~~~~~~~~~~~
150+
151+ - HTML documentation (stable release): http://scikit-learn.org
152+ - HTML documentation (development version): http://scikit-learn.org/dev/
153+ - FAQ: http://scikit-learn.org/stable/faq.html
154+
155+ Communication
156+ ~~~~~~~~~~~~~
157+
158+ - Mailing list: https://mail.python.org/mailman/listinfo/scikit-learn
159+ - IRC channel: ``#scikit-learn `` at ``irc.freenode.net ``
160+ - Stack Overflow: http://stackoverflow.com/questions/tagged/scikit-learn
161+ - Website: http://scikit-learn.org
0 commit comments