scikit-learn: machine learning in Python
Python C C++ Shell PowerShell Batchfile
Latest commit 9616acf Jan 22, 2017 @jnothman jnothman CI remove obsolete comment
Permalink
Failed to load latest commit information.
benchmarks DOC Improve benchmark on NMF (#5779) Dec 20, 2016
build_tools CI remove obsolete comment Jan 22, 2017
doc [MRG] #8218: in FAQ, link deep learning question to GPU question (#8220) Jan 20, 2017
examples TST/FIX Add check for estimator: parameters not modified by `fit` (#7846 Jan 20, 2017
sklearn TST/FIX Add check for estimator: parameters not modified by `fit` (#7846 Jan 20, 2017
.coveragerc coverall added Oct 8, 2013
.gitattributes MAINT remove .c files from .gitattributes Nov 21, 2016
.gitignore MAINT remove cythonize.dat from .gitignore Nov 15, 2016
.landscape.yml make landscape.io much more useful Mar 10, 2015
.mailmap [MRG + 1] DOC Add whatsnew for the 3 model_selection bugfixes (#7868) Nov 15, 2016
.travis.yml [MRG] MAINT Python 3.6 fixes (#8123) Dec 27, 2016
AUTHORS.rst DOC Fix help link on about page (#8119) Dec 27, 2016
CONTRIBUTING.md DOC add CI details and commands to contributor guide (#8024) Dec 15, 2016
COPYING [MRG] update copyright years for 2017 (#8138) Jan 1, 2017
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Jun 15, 2016
MANIFEST.in MAINT Include binary_tree.pxi in source distribution Jul 4, 2014
Makefile BF: use setup.py build_src for "make cython" (Closes: #7873) (#7874) Nov 15, 2016
PULL_REQUEST_TEMPLATE.md DOC Make the PR/Issue headers smaller (#6685) Apr 20, 2016
README.rst Harmonized README, added link. (#7965) Dec 2, 2016
appveyor.yml MAINT make appveyor fail on old builds when PR is update (#6365) Oct 13, 2016
circle.yml MNT/BLD Use GitHub's merge refs to test PRs on CircleCI (#8211) Jan 18, 2017
setup.cfg Do not ignore files starting with _ in nose Mar 11, 2016
setup.py Revert "CI report which doc files were likely affected (#7938)" Dec 9, 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.7 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 Development 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/developers/advanced_installation.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

Citation

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