Skip to content

Commit edfa77f

Browse files
authored
Merge pull request #4 from rth/improve-readme
DOC Improve readme
2 parents c5d4c27 + 12609e5 commit edfa77f

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.rst

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,32 @@ scikit-learn-extra - A set of useful tools compatible with scikit-learn
1919

2020
.. _scikit-learn: https://scikit-learn.org
2121

22+
scikit-learn-extra is a Python module for machine learning that extends scikit-learn. It includes algorithms that are useful but do not satisfy the scikit-learn `inclusion criteria <https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms>`_, for instance due to their novelty or lower citation number.
2223

23-
.. _documentation: https://scikit-learn-extra.readthedocs.io/en/latest/quick_start.html
24+
Installation
25+
------------
2426

25-
Refer to the documentation_ for additional information.
27+
Dependencies
28+
^^^^^^^^^^^^
2629

27-
*Thank you for contributing to the scikit-learn ecosystem!*
30+
scikit-learn-extra requires,
31+
32+
- Python (>=3.5)
33+
- scikit-learn (>=0.20), and its dependencies
34+
- Cython (>0.28)
35+
36+
37+
User installation
38+
^^^^^^^^^^^^^^^^^
39+
40+
Latest development version can be installed with,
41+
42+
.. code::
43+
44+
pip install https://github.com/scikit-learn-contrib/scikit-learn-extra/archive/master.zip
45+
46+
47+
License
48+
-------
49+
50+
This package is released under the 3-Clause BSD license.

0 commit comments

Comments
 (0)