scikit-learn: machine learning in Python
Python C C++ PowerShell Shell Batchfile
Permalink
Failed to load latest commit information.
benchmarks [MRG+2] Faster isotonic rebased (#7444) Sep 16, 2016
build_tools [MRG] CI build web site from branches (#7498) Sep 29, 2016
doc add warning about python 2.6 being no longer supported (#7532) Sep 30, 2016
examples minor doc fixes (#7514) Sep 28, 2016
sklearn BUGFIX _store train_scores only if return_train_score is True (#7535) Sep 30, 2016
.coveragerc coverall added Oct 8, 2013
.gitattributes ENH added elkan k_means algorithm Apr 5, 2016
.gitignore MNT Tags built by sublime ctags may be of form (.)tags* (#7494) Sep 29, 2016
.landscape.yml make landscape.io much more useful Mar 10, 2015
.mailmap more mailmap and whatsnew additions Sep 23, 2016
.travis.yml [MRG+1] #7466 add pandas to CI jobs (#7499) Sep 28, 2016
AUTHORS.rst @ogrisel's suggestions Sep 6, 2016
CONTRIBUTING.md Fix docs links (#7005) Jul 27, 2016
COPYING First pull request of 2016! Jan 1, 2016
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Jun 15, 2016
MANIFEST.in MAINT Include binary_tree.pxi in source distribution Jul 4, 2014
Makefile [MRG+3] Add flake8 linting of the diff in Travis (#7127) Aug 30, 2016
PULL_REQUEST_TEMPLATE.md DOC Make the PR/Issue headers smaller (#6685) Apr 20, 2016
README.rst Add @raghavrv suggested changes Sep 22, 2016
appveyor.yml enh: reorganize build files Feb 18, 2016
circle.yml [MRG] CI build web site from branches (#7498) Sep 29, 2016
setup.cfg Do not ignore files starting with _ in nose Mar 11, 2016
setup.py FIX missing import in setup.py Sep 14, 2016
setup32.cfg skip doctests on 32 bits Nov 5, 2015
site.cfg Remove obsolete info. Feb 8, 2011

README.rst

Travis AppVeyor Coveralls CircleCI Python27 Python35 PyPi DOI

scikit-learn

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

The project was started in 2007 by David Cournapeau as a Google Summer of Code project, and since then many volunteers have contributed. See the AUTHORS.rst file for a complete list of contributors.

It is currently maintained by a team of volunteers.

Website: http://scikit-learn.org

Installation

Dependencies

Scikit-learn requires:

- Python (>= 2.6 or >= 3.3),
- NumPy (>= 1.6.1),
- SciPy (>= 0.9).

scikit-learn also uses CBLAS, the C interface to the Basic Linear Algebra Subprograms library. scikit-learn comes with a reference implementation, but the system CBLAS will be detected by the build system and used if present. CBLAS exists in many implementations; see Linear algebra libraries for known issues.

User installation

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

pip install -U scikit-learn

or conda:

conda install scikit-learn

The documentation includes more detailed installation instructions.

Development

We welcome new contributors of all experience levels. The scikit-learn community goals are to be helpful, welcoming, and effective. The Contributor's Guide has detailed information about contributing code, documentation, tests, and more. We've included some basic information in this README.

Important links

Source code

You can check the latest sources with the command:

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

Setting up a development environment

Quick tutorial on how to go about setting up your environment to contribute to scikit-learn: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md

Testing

After installation, you can launch the test suite from outside the source directory (you will need to have the nose package installed):

$ nosetests -v sklearn

Under Windows, it is recommended to use the following command (adjust the path to the python.exe program) as using the nosetests.exe program can badly interact with tests that use multiprocessing:

C:\Python34\python.exe -c "import nose; nose.main()" -v sklearn

See the web page http://scikit-learn.org/stable/install.html#testing for more information.

Random number generation can be controlled during testing by setting the SKLEARN_SEED environment variable.

Submitting a Pull Request

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

Project history

The project was started in 2007 by David Cournapeau as a Google Summer of Code project, and since then many volunteers have contributed. See the AUTHORS.rst file for a complete list of contributors.

The project is currently maintained by a team of volunteers.

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

Help and Support

Documentation

Communication