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
3131^^^^^^^^^^^^
3232
3333scikit-learn-extra requires,
34-
34+
3535- Python (>=3.6)
3636- scikit-learn (>=0.23), and its dependencies
3737
@@ -48,26 +48,20 @@ Latest release can be installed with conda,
4848 or from PyPi with,
4949
5050.. code ::
51-
51+
5252 pip install scikit-learn-extra
5353
5454 Note that installing from PyPi requires a working C compiler (cf `installation
5555instructions
5656<https://scikit-learn.org/dev/developers/advanced_installation.html#platform-specific-instructions> `_).
57-
57+
5858The developement version can be installed with,
5959
6060.. code ::
6161
6262 pip install https://github.com/scikit-learn-contrib/scikit-learn-extra/archive/master.zip
6363
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
6964 License
7065-------
7166
7267This 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:
1313
14141. Fork this repository into your own github account.
15152. Clone the fork on your account onto your local disk:
16-
16+
1717.. code-block :: console
1818
1919 git clone git@github.com:YourLogin/scikit-learn-extra.git
2020 cd scikit-learn-extra
21-
21+
2222 3. Create a branch for your new feature, do not work in the master branch:
2323
2424.. code-block :: console
2525
2626 git checkout -b new-feature
27-
27+
2828 4. Write some code, or docs, or tests.
29295. When you are done, submit a pull request.
30-
30+
3131Guidelines
3232==========
3333
@@ -47,11 +47,10 @@ To run the tests, use:
4747.. code-block :: console
4848
4949 pytest
50-
50+
5151 Easy Issues / Getting Started
5252=============================
5353
5454There 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
5656with 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
2121 :caption: Examples
2222
2323 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