1
1
.. -*- mode: rst -*-
2
+
2
3
|Travis |_ |AppVeyor |_ |Coveralls |_ |CircleCI |_ |Python27 |_ |Python35 |_ |PyPi |_ |DOI |_
3
4
4
5
.. |Travis | image :: https://api.travis-ci.org/scikit-learn/scikit-learn.svg?branch=master
@@ -45,11 +46,11 @@ Installation
45
46
Dependencies
46
47
~~~~~~~~~~~~
47
48
48
- Scikit -learn requires: :
49
+ scikit -learn requires:
49
50
50
- - Python (>= 2.6 or >= 3.3),
51
- - NumPy (>= 1.6.1),
52
- - SciPy (>= 0.9).
51
+ - Python (>= 2.7 or >= 3.3)
52
+ - NumPy (>= 1.6.1)
53
+ - SciPy (>= 0.9)
53
54
54
55
scikit-learn also uses CBLAS, the C interface to the Basic Linear Algebra
55
56
Subprograms library. scikit-learn comes with a reference implementation, but
@@ -78,7 +79,7 @@ Development
78
79
79
80
We welcome new contributors of all experience levels. The scikit-learn
80
81
community goals are to be helpful, welcoming, and effective. The
81
- `Development Guide <http://scikit-learn.org/stable/developers/index.html >`_
82
+ `Development Guide <http://scikit-learn.org/stable/developers/index.html >`_
82
83
has detailed information about contributing code, documentation, tests, and
83
84
more. We've included some basic information in this README.
84
85
@@ -108,15 +109,15 @@ Testing
108
109
After installation, you can launch the test suite from outside the
109
110
source directory (you will need to have the ``nose `` package installed)::
110
111
111
- $ nosetests -v sklearn
112
+ nosetests -v sklearn
112
113
113
114
Under Windows, it is recommended to use the following command (adjust the path
114
115
to the ``python.exe `` program) as using the ``nosetests.exe `` program can badly
115
116
interact with tests that use ``multiprocessing ``::
116
117
117
- C:\Python34\python.exe -c "import nose; nose.main()" -v sklearn
118
+ C:\Python34\python.exe -c "import nose; nose.main()" -v sklearn
118
119
119
- See the web page http://scikit-learn.org/stable/install .html#testing
120
+ See the web page http://scikit-learn.org/stable/developers/advanced_installation .html#testing
120
121
for more information.
121
122
122
123
Random number generation can be controlled during testing by setting
@@ -130,7 +131,7 @@ full Contributing page to make sure your code complies
130
131
with our guidelines: http://scikit-learn.org/stable/developers/index.html
131
132
132
133
133
- Project history
134
+ Project History
134
135
---------------
135
136
136
137
The project was started in 2007 by David Cournapeau as a Google Summer
@@ -139,7 +140,7 @@ the AUTHORS.rst file for a complete list of contributors.
139
140
140
141
The project is currently maintained by a team of volunteers.
141
142
142
- **Note ** `scikit-learn ` was previously referred to as `scikits.learn `.
143
+ **Note **: `scikit-learn ` was previously referred to as `scikits.learn `.
143
144
144
145
145
146
Help and Support
@@ -159,3 +160,8 @@ Communication
159
160
- IRC channel: ``#scikit-learn `` at ``irc.freenode.net ``
160
161
- Stack Overflow: http://stackoverflow.com/questions/tagged/scikit-learn
161
162
- Website: http://scikit-learn.org
163
+
164
+ Citation
165
+ ~~~~~~~~
166
+
167
+ If you use scikit-learn in a scientific publication, we would appreciate citations: http://scikit-learn.org/stable/about.html#citing-scikit-learn
0 commit comments