Skip to content
scikit-learn: machine learning in Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci MNT Correctly handle deprecated attribute warnings and docstrings (#1… Apr 18, 2019
benchmarks ENH Enable the "sufficient stats" mode of LARS (#11699) Mar 6, 2019
build_tools MNT Correctly handle deprecated attribute warnings and docstrings (#1… Apr 18, 2019
doc MNT Correctly handle deprecated attribute warnings and docstrings (#1… Apr 18, 2019
examples DOC Improve performance of the plot_rbm_logistic_classification.py ex… Apr 17, 2019
maint_tools [MRG] MNT Tools for working with what's new (#11800) Mar 4, 2019
sklearn MNT Correctly handle deprecated attribute warnings and docstrings (#1… Apr 18, 2019
.codecov.yml MAINT Ignores external in codecov (#13498) Mar 24, 2019
.coveragerc coverall added Oct 8, 2013
.gitattributes MAINT remove .c files from .gitattributes Nov 21, 2016
.gitignore LogisticRegression convert to float64 (for SAG solver) (#13243) Feb 27, 2019
.landscape.yml make landscape.io much more useful Mar 10, 2015
.mailmap Fix mailmap format (#9620) Aug 24, 2017
.travis.yml remove non-cron travis jobs (#13341) Feb 28, 2019
CONTRIBUTING.md DOC Added tips for reading the code base (#12874) Dec 31, 2018
COPYING DOC Update copyright year for 2019 (#12964) Jan 12, 2019
ISSUE_TEMPLATE.md MNT Converting http to https (#12277) Oct 4, 2018
MANIFEST.in DOC Remove mentions of removed AUTHORS.rst file (#12262) Oct 4, 2018
Makefile MNT refs to travis/flake8_diff -> circle/flake8_diff (#13163) Feb 14, 2019
PULL_REQUEST_TEMPLATE.md DOC Encourage contributors to use keywords to close issue automatical… Oct 20, 2017
README.rst
appveyor.yml BLD Appveyor checks for newer build after pip install (#13226) Feb 23, 2019
azure-pipelines.yml MAINT Unvendor joblib (#13531) Apr 17, 2019
conftest.py MAINT Unvendor joblib (#13531) Apr 17, 2019
lgtm.yml [MRG] Configure lgtm.yml for CPP (#13044) Jan 26, 2019
setup.cfg CLN Ignore maint_tools in pytest (#13431) Mar 11, 2019
setup.py MAINT Unvendor joblib (#13531) Apr 17, 2019
site.cfg Remove obsolete info. Feb 8, 2011

README.rst

Azure Travis Codecov CircleCI 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 About us page for a list of core contributors.

It is currently maintained by a team of volunteers.

Website: http://scikit-learn.org

Installation

Dependencies

scikit-learn requires:

  • Python (>= 3.5)
  • NumPy (>= 1.11.0)
  • SciPy (>= 0.17.0)
  • joblib (>= 0.11)

Scikit-learn 0.20 was the last version to support Python2.7. Scikit-learn 0.21 and later require Python 3.5 or newer.

For running the examples Matplotlib >= 1.5.1 is required. A few examples require scikit-image >= 0.12.3, a few examples require pandas >= 0.18.0 and a few example require joblib >= 0.11.

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.

Changelog

See the changelog for a history of notable changes to scikit-learn.

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 pytest >= 3.3.0 installed):

pytest sklearn

See the web page http://scikit-learn.org/dev/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 About us page for 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.

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

You can’t perform that action at this time.