Skip to content

Update Docs #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Scikit-learn-extra Developer Documentation
**Most tips discussed [here](https://scikit-learn.org/stable/developers/index.html) also apply to this repo.**

### Scikit-learn-extra is a Python package that extends scikit-learn. It includes algorithms that do not satisfy scikit-learn [inclusion criteria](https://scikit-learn.org/stable/faq.html#what-are-the-inclusion-criteria-for-new-algorithms). For instance, this may be due to their novelty or lower citation number.
----
# Installation Instructions:
### scikit-learn-extra requires:
- Python (>= 3.5)
- scikit-learn(>=0.21)
- Cython (>0.28)
### User Installation:
You can install scikit-learn-extra using the following command:
`pip install https://github.com/scikit-learn-contrib/scikit-learn-extra/archive/master.zip`

----