Repository files navigation

scikit-learn is a Python module for machine learning built on top ofSciPy and is distributed under the 3-Clause BSD license.

The project was started in 2007 by David Cournapeau as a Google Summerof Code project, and since then many volunteers have contributed. SeetheAbout us pagefor a list of core contributors.

It is currently maintained by a team of volunteers.

Website:http://scikit-learn.org

scikit-learn requires:

• Python (>= 3.6)
• NumPy (>= 1.13.3)
• SciPy (>= 0.19.1)
• joblib (>= 0.11)

Scikit-learn 0.20 was the last version to support Python 2.7 and Python 3.4.scikit-learn 0.23 and later require Python 3.6 or newer.

Scikit-learn plotting capabilities (i.e., functions start withplot_and classes end with "Display") require Matplotlib (>= 2.1.1). For running theexamples Matplotlib >= 2.1.1 is required. A few examples requirescikit-image >= 0.13, a few examples require pandas >= 0.18.0.

If you already have a working installation of numpy and scipy,the easiest way to install scikit-learn is usingpip

pip install -U scikit-learn

orconda:

conda install scikit-learn

The documentation includes more detailedinstallation instructions.

See thechangelogfor a history of notable changes to scikit-learn.

We welcome new contributors of all experience levels. The scikit-learncommunity goals are to be helpful, welcoming, and effective. TheDevelopment Guidehas detailed information about contributing code, documentation, tests, andmore. We've included some basic information in this README.

• Official source code repo:https://github.com/scikit-learn/scikit-learn
• Download releases:https://pypi.org/project/scikit-learn/
• Issue tracker:https://github.com/scikit-learn/scikit-learn/issues

You can check the latest sources with the command:

git clone https://github.com/scikit-learn/scikit-learn.git

To learn more about making a contribution to scikit-learn, please see ourContributing guide.

After installation, you can launch the test suite from outside thesource directory (you will need to havepytest >= 3.3.0 installed):

pytest sklearn

See the web pagehttp://scikit-learn.org/dev/developers/advanced_installation.html#testingfor more information.

Random number generation can be controlled during testing by settingtheSKLEARN_SEED environment variable.

Before opening a Pull Request, have a look at thefull Contributing page to make sure your code complieswith our guidelines:http://scikit-learn.org/stable/developers/index.html

The project was started in 2007 by David Cournapeau as a Google Summerof Code project, and since then many volunteers have contributed. SeetheAbout us pagefor a list of core contributors.

The project is currently maintained by a team of volunteers.

Note: scikit-learn was previously referred to as scikits.learn.

• HTML documentation (stable release):http://scikit-learn.org
• HTML documentation (development version):http://scikit-learn.org/dev/
• FAQ:http://scikit-learn.org/stable/faq.html

• Mailing list:https://mail.python.org/mailman/listinfo/scikit-learn
• IRC channel:#scikit-learn atwebchat.freenode.net
• Stack Overflow:https://stackoverflow.com/questions/tagged/scikit-learn
• Website:http://scikit-learn.org

If you use scikit-learn in a scientific publication, we would appreciate citations:http://scikit-learn.org/stable/about.html#citing-scikit-learn