scikit-learn: machine learning in Python
Python C C++ PowerShell Shell Batchfile
Latest commit acf8368 Aug 27, 2016 @nelson-liu nelson-liu committed with agramfort [MRG + 1] doc: specifically address reinforcement learning in faq (#6479
)

* doc: specifically address reinforcement learning in faq

* doc: grammar fix

* doc: edit wording about RL GPU requirements

* edit wording and rerun CI
Permalink
Failed to load latest commit information.
benchmarks Fix typos (#6942) Jun 27, 2016
build_tools Fix CircleCI failure (#6903) Jun 17, 2016
doc [MRG + 1] doc: specifically address reinforcement learning in faq (#6479 Aug 27, 2016
examples phrasing Aug 24, 2016
sklearn fix error in boolean mask usage in GaussianNB. (#7258) Aug 27, 2016
.coveragerc coverall added Oct 8, 2013
.gitattributes ENH added elkan k_means algorithm Apr 5, 2016
.gitignore [DOC] Added return values to _intercept_dot docstring in linear.logistic Apr 28, 2016
.landscape.yml make landscape.io much more useful Mar 10, 2015
.mailmap Adding email to the mailmap Nov 17, 2015
.travis.yml [MRG+1] Reenable MKL for python 3.5 in Travis (#6661) May 3, 2016
AUTHORS.rst Fix docs links (#7005) Jul 27, 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 Fixes the 'make cython' by adjusting the path to cythonize.py Feb 21, 2016
PULL_REQUEST_TEMPLATE.md DOC Make the PR/Issue headers smaller (#6685) Apr 20, 2016
README.rst Updated README, removed git clone with write reference (#7009) Jul 16, 2016
appveyor.yml enh: reorganize build files Feb 18, 2016
circle.yml enh: reorganize build files Feb 18, 2016
setup.cfg Do not ignore files starting with _ in nose Mar 11, 2016
setup.py update setup.py PyPI trove classifier section (#7197) Aug 22, 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.

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

Important links

Dependencies

scikit-learn is tested to work under Python 2.6, Python 2.7, and Python 3.5. (using the same codebase thanks to an embedded copy of six). It should also work with Python 3.3 and 3.4.

The required dependencies to build the software are NumPy >= 1.6.1, SciPy >= 0.9 and a working C/C++ compiler. For the development version, you will also require Cython >=0.23.

For running the examples Matplotlib >= 1.1.1 is required and for running the tests you need nose >= 1.1.2.

This configuration matches the Ubuntu Precise 12.04 LTS release from April 2012.

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.

Install

This package uses distutils, which is the default way of installing python modules. To install in your home directory, use:

python setup.py install --user

To install for all users on Unix/Linux:

python setup.py build
sudo python setup.py install

For more detailed installation instructions, see the web page http://scikit-learn.org/stable/install.html

Development

Code

GIT

You can check the latest sources with the command:

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

Contributing

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

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

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.