8000 DOC Update installation instructions (#58) · rth/scikit-learn-extra@dce9e4f · GitHub
[go: up one dir, main page]
Skip to content

Commit dce9e4f

Browse files
rthrth
authored
DOC Update installation instructions (scikit-learn-contrib#58)
* Fix PyPi badge
1 parent 4e72440 commit dce9e4f

File tree

2 files changed

+39
-6
lines changed

2 files changed

+39
-6
lines changed

‎README.rst

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
.. -*- mode: rst -*-
22
3-
|Travis|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_
3+
|PyPi|_ |Azure|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_
44

5-
.. |Travis| image:: https://travis-ci.org/scikit-learn-contrib/scikit-learn-extra.svg?branch=master
6-
.. _Travis: https://travis-ci.org/scikit-learn-contrib/project-template
5+
.. |PyPi| image:: https://badge.fury.io/py/scikit-learn-extra.svg
6+
.. _PyPi: https://badge.fury.io/py/scikit-learn-extra
7+
8+
.. |Azure| image:: https://dev.azure.com/scikit-learn-extra/scikit-learn-extra/_apis/build/status/scikit-learn-contrib.scikit-learn-extra?branchName=master
9+
.. _Azure: https://dev.azure.com/scikit-learn-extra/scikit-learn-extra/_build/latest?definitionId=1&branchName=master
710

811
.. |Codecov| image:: https://codecov.io/gh/scikit-learn-contrib/project-template/branch/master/graph/badge.svg
912
.. _Codecov: https://codecov.io/gh/scikit-learn-contrib/scikit-learn-extra
@@ -31,13 +34,28 @@ scikit-learn-extra requires,
3134

3235
- Python (>=3.5)
3336
- scikit-learn (>=0.21), and its dependencies
34-
- Cython (>0.28)
3537

3638

3739
User installation
3840
^^^^^^^^^^^^^^^^^
3941

40-
Latest development version can be installed with,
42+
Latest release can be installed with conda,
43+
44+
.. code::
45+
46+
conda install -c conda-forge scikit-learn-extra
47+
48+
or from PyPi with,
49+
50+
.. code::
51+
52+
pip install scikit-learn-extra
53+
54+
Note that installing from PyPi requires a working C compiler (cf `installation
55+
instructions
56+
<https://scikit-learn.org/dev/developers/advanced_installation.html#platform-specific-instructions>`_).
57+
58+
The developement version can be installed with,
4159

4260
.. code::
4361

‎doc/install.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,27 @@ scikit-learn-extra requires,
88

99
- Python (>=3.5)
1010
- scikit-learn (>=0.21), and its dependencies
11-
- Cython (>0.28)
1211

1312

1413
User installation
1514
^^^^^^^^^^^^^^^^^
1615

16+
Latest release can be installed with conda,
17+
18+
.. code::
19+
20+
conda install -c conda-forge scikit-learn-extra
21+
22+
or from PyPi with,
23+
24+
.. code::
25+
26+
pip install scikit-learn-extra
27+
28+
Note that installing from PyPi requires a working C compiler (cf `installation
29+
instructions
30+
<https://scikit-learn.org/dev/developers/advanced_installation.html#platform-specific-instructions>`_).
31+
1732
Latest development version can be installed with,
1833

1934
.. code::

0 commit comments

Comments
 (0)
0