File tree Expand file tree Collapse file tree 3 files changed +15
-16
lines changed Expand file tree Collapse file tree 3 files changed +15
-16
lines changed Original file line number Diff line number Diff line change @@ -31,7 +31,7 @@ Dependencies
31
31
^^^^^^^^^^^^
32
32
33
33
scikit-learn-extra requires,
34
-
34
+
35
35
- Python (>=3.6)
36
36
- scikit-learn (>=0.23), and its dependencies
37
37
@@ -48,26 +48,20 @@ Latest release can be installed with conda,
48
48
or from PyPi with,
49
49
50
50
.. code ::
51
-
51
+
52
52
pip install scikit-learn-extra
53
53
54
54
Note that installing from PyPi requires a working C compiler (cf `installation
55
55
instructions
56
56
<https://scikit-learn.org/dev/developers/advanced_installation.html#platform-specific-instructions> `_).
57
-
57
+
58
58
The developement version can be installed with,
59
59
60
60
.. code ::
61
61
62
62
pip install https://github.com/scikit-learn-contrib/scikit-learn-extra/archive/master.zip
63
63
64
- Contributing
65
- -------------
66
- We appreciate and welcome contributions. If you would like to take part in scikit-learn development, take a look at the file `CONTRIBUTING.rst `_.
67
-
68
- .. _CONTRIBUTING.rst : https://github.com/scikit-learn-contrib/scikit-learn-extra/CONTRIBUTING.rst
69
64
License
70
65
-------
71
66
72
67
This package is released under the 3-Clause BSD license.
73
-
Original file line number Diff line number Diff line change @@ -13,21 +13,21 @@ The preferred workflow to contribute is:
13
13
14
14
1. Fork this repository into your own github account.
15
15
2. Clone the fork on your account onto your local disk:
16
-
16
+
17
17
.. code-block :: console
18
18
19
19
git clone [email protected] :YourLogin/scikit-learn-extra.git
20
20
cd scikit-learn-extra
21
-
21
+
22
22
3. Create a branch for your new feature, do not work in the master branch:
23
23
24
24
.. code-block :: console
25
25
26
26
git checkout -b new-feature
27
-
27
+
28
28
4. Write some code, or docs, or tests.
29
29
5. When you are done, submit a pull request.
30
-
30
+
31
31
Guidelines
32
32
==========
33
33
@@ -47,11 +47,10 @@ To run the tests, use:
47
47
.. code-block :: console
48
48
49
49
pytest
50
-
50
+
51
51
Easy Issues / Getting Started
52
52
=============================
53
53
54
54
There are usually some issues in the project github page looking for contributors, if not you're welcome to propose some
55
- ideas there, or a great first step is often to just use the library, and add to the examples directory. This helps us
55
+ ideas there, or a great first step is often to just use the library, and add to the examples directory. This helps us
56
56
with documentation, and often helps to find things that would make the library better to use.
57
-
Original file line number Diff line number Diff line change @@ -21,3 +21,9 @@ scikit-learn-extra is a Python module for machine learning that extends scikit-l
21
21
:caption: Examples
22
22
23
23
auto_examples/index
24
+
25
+ .. toctree ::
26
+ :maxdepth: 2
27
+ :caption: Project
28
+
29
+ contributing
You can’t perform that action at this time.
0 commit comments