scikit-learn


Namescikit-learn JSON
Version 0.19.0 PyPI version JSON
download
home_pagehttp://scikit-learn.org
SummaryA set of python modules for machine learning and data mining
upload_time2017-08-11 18:38:26
maintainer
docs_urlNone
authorAndreas Mueller
requires_python
licensenew BSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. -*- mode: rst -*-

|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |Python27|_ |Python35|_ |PyPi|_ |DOI|_

.. |Travis| image:: https://api.travis-ci.org/scikit-learn/scikit-learn.svg?branch=master
.. _Travis: https://travis-ci.org/scikit-learn/scikit-learn

.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/scikit-learn/scikit-learn?branch=master&svg=true
.. _AppVeyor: https://ci.appveyor.com/project/sklearn-ci/scikit-learn/history

.. |Codecov| image:: https://codecov.io/github/scikit-learn/scikit-learn/badge.svg?branch=master&service=github
.. _Codecov: https://codecov.io/github/scikit-learn/scikit-learn?branch=master

.. |CircleCI| image:: https://circleci.com/gh/scikit-learn/scikit-learn/tree/master.svg?style=shield&circle-token=:circle-token
.. _CircleCI: https://circleci.com/gh/scikit-learn/scikit-learn

.. |Python27| image:: https://img.shields.io/badge/python-2.7-blue.svg
.. _Python27: https://badge.fury.io/py/scikit-learn

.. |Python35| image:: https://img.shields.io/badge/python-3.5-blue.svg
.. _Python35: https://badge.fury.io/py/scikit-learn

.. |PyPi| image:: https://badge.fury.io/py/scikit-learn.svg
.. _PyPi: https://badge.fury.io/py/scikit-learn

.. |DOI| image:: https://zenodo.org/badge/21369/scikit-learn/scikit-learn.svg
.. _DOI: https://zenodo.org/badge/latestdoi/21369/scikit-learn/scikit-learn

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 <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.8.2)
- SciPy (>= 0.13.3)

For running the examples Matplotlib >= 1.1.1 is required.

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
<http://scikit-learn.org/stable/modules/computational_performance.html#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 <http://scikit-learn.org/stable/install.html>`_.


Development
-----------

We welcome new contributors of all experience levels. The scikit-learn
community goals are to be helpful, welcoming, and effective. The
`Development Guide <http://scikit-learn.org/stable/developers/index.html>`_
has detailed information about contributing code, documentation, tests, and
more. We've included some basic information in this README.

Important links
~~~~~~~~~~~~~~~

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

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 <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
~~~~~~~~~~~~~

- 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

Communication
~~~~~~~~~~~~~

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

Citation
~~~~~~~~

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



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2017-08-11 18:38:26", 
    "author": "Andreas Mueller", 
    "home_page": "http://scikit-learn.org", 
    "download_url": "https://pypi.org/project/scikit-learn/#files", 
    "platform": "", 
    "version": "0.19.0", 
    "cheesecake_documentation_id": null, 
    "description": ".. -*- mode: rst -*-\n\n|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |Python27|_ |Python35|_ |PyPi|_ |DOI|_\n\n.. |Travis| image:: https://api.travis-ci.org/scikit-learn/scikit-learn.svg?branch=master\n.. _Travis: https://travis-ci.org/scikit-learn/scikit-learn\n\n.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/scikit-learn/scikit-learn?branch=master&svg=true\n.. _AppVeyor: https://ci.appveyor.com/project/sklearn-ci/scikit-learn/history\n\n.. |Codecov| image:: https://codecov.io/github/scikit-learn/scikit-learn/badge.svg?branch=master&service=github\n.. _Codecov: https://codecov.io/github/scikit-learn/scikit-learn?branch=master\n\n.. |CircleCI| image:: https://circleci.com/gh/scikit-learn/scikit-learn/tree/master.svg?style=shield&circle-token=:circle-token\n.. _CircleCI: https://circleci.com/gh/scikit-learn/scikit-learn\n\n.. |Python27| image:: https://img.shields.io/badge/python-2.7-blue.svg\n.. _Python27: https://badge.fury.io/py/scikit-learn\n\n.. |Python35| image:: https://img.shields.io/badge/python-3.5-blue.svg\n.. _Python35: https://badge.fury.io/py/scikit-learn\n\n.. |PyPi| image:: https://badge.fury.io/py/scikit-learn.svg\n.. _PyPi: https://badge.fury.io/py/scikit-learn\n\n.. |DOI| image:: https://zenodo.org/badge/21369/scikit-learn/scikit-learn.svg\n.. _DOI: https://zenodo.org/badge/latestdoi/21369/scikit-learn/scikit-learn\n\nscikit-learn\n============\n\nscikit-learn is a Python module for machine learning built on top of\nSciPy and distributed under the 3-Clause BSD license.\n\nThe project was started in 2007 by David Cournapeau as a Google Summer\nof Code project, and since then many volunteers have contributed. See\nthe `AUTHORS.rst <AUTHORS.rst>`_ file for a complete list of contributors.\n\nIt is currently maintained by a team of volunteers.\n\nWebsite: http://scikit-learn.org\n\n\nInstallation\n------------\n\nDependencies\n~~~~~~~~~~~~\n\nscikit-learn requires:\n\n- Python (>= 2.7 or >= 3.3)\n- NumPy (>= 1.8.2)\n- SciPy (>= 0.13.3)\n\nFor running the examples Matplotlib >= 1.1.1 is required.\n\nscikit-learn also uses CBLAS, the C interface to the Basic Linear Algebra\nSubprograms library. scikit-learn comes with a reference implementation, but\nthe system CBLAS will be detected by the build system and used if present.\nCBLAS exists in many implementations; see `Linear algebra libraries\n<http://scikit-learn.org/stable/modules/computational_performance.html#linear-algebra-libraries>`_\nfor known issues.\n\nUser installation\n~~~~~~~~~~~~~~~~~\n\nIf you already have a working installation of numpy and scipy,\nthe easiest way to install scikit-learn is using ``pip`` ::\n\n    pip install -U scikit-learn\n\nor ``conda``::\n\n    conda install scikit-learn\n\nThe documentation includes more detailed `installation instructions <http://scikit-learn.org/stable/install.html>`_.\n\n\nDevelopment\n-----------\n\nWe welcome new contributors of all experience levels. The scikit-learn\ncommunity goals are to be helpful, welcoming, and effective. The\n`Development Guide <http://scikit-learn.org/stable/developers/index.html>`_\nhas detailed information about contributing code, documentation, tests, and\nmore. We've included some basic information in this README.\n\nImportant links\n~~~~~~~~~~~~~~~\n\n- Official source code repo: https://github.com/scikit-learn/scikit-learn\n- Download releases: https://pypi.python.org/pypi/scikit-learn\n- Issue tracker: https://github.com/scikit-learn/scikit-learn/issues\n\nSource code\n~~~~~~~~~~~\n\nYou can check the latest sources with the command::\n\n    git clone https://github.com/scikit-learn/scikit-learn.git\n\nSetting up a development environment\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nQuick tutorial on how to go about setting up your environment to\ncontribute to scikit-learn: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md\n\nTesting\n~~~~~~~\n\nAfter installation, you can launch the test suite from outside the\nsource directory (you will need to have the ``nose`` package installed)::\n\n    nosetests -v sklearn\n\nUnder Windows, it is recommended to use the following command (adjust the path\nto the ``python.exe`` program) as using the ``nosetests.exe`` program can badly\ninteract with tests that use ``multiprocessing``::\n\n    C:\\Python34\\python.exe -c \"import nose; nose.main()\" -v sklearn\n\nSee the web page http://scikit-learn.org/stable/developers/advanced_installation.html#testing\nfor more information.\n\n    Random number generation can be controlled during testing by setting\n    the ``SKLEARN_SEED`` environment variable.\n\nSubmitting a Pull Request\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nBefore opening a Pull Request, have a look at the\nfull Contributing page to make sure your code complies\nwith our guidelines: http://scikit-learn.org/stable/developers/index.html\n\n\nProject History\n---------------\n\nThe project was started in 2007 by David Cournapeau as a Google Summer\nof Code project, and since then many volunteers have contributed. See\nthe  `AUTHORS.rst <AUTHORS.rst>`_ file for a complete list of contributors.\n\nThe project is currently maintained by a team of volunteers.\n\n**Note**: `scikit-learn` was previously referred to as `scikits.learn`.\n\n\nHelp and Support\n----------------\n\nDocumentation\n~~~~~~~~~~~~~\n\n- HTML documentation (stable release): http://scikit-learn.org\n- HTML documentation (development version): http://scikit-learn.org/dev/\n- FAQ: http://scikit-learn.org/stable/faq.html\n\nCommunication\n~~~~~~~~~~~~~\n\n- Mailing list: https://mail.python.org/mailman/listinfo/scikit-learn\n- IRC channel: ``#scikit-learn`` at ``webchat.freenode.net``\n- Stack Overflow: http://stackoverflow.com/questions/tagged/scikit-learn\n- Website: http://scikit-learn.org\n\nCitation\n~~~~~~~~\n\nIf you use scikit-learn in a scientific publication, we would appreciate citations: http://scikit-learn.org/stable/about.html#citing-scikit-learn\n\n\n", 
    "lcname": "scikit-learn", 
    "bugtrack_url": "", 
    "github": false, 
    "name": "scikit-learn", 
    "license": "new BSD", 
    "summary": "A set of python modules for machine learning and data mining", 
    "split_keywords": [], 
    "author_email": "amueller@ais.uni-bonn.de", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-08-11T18:38:26", 
            "comment_text": "", 
            "python_version": "cp27", 
            "url": "https://pypi.python.org/packages/60/22/457acd1acad1ef22aa9e62483754defe4c78726ebaaa6bb358caeca8b7ab/scikit_learn-0.19.0-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl", 
            "md5_digest": "5ed7b39a5ea9ed1c8ebbf8b9286afc16", 
            "downloads": 0, 
            "filename": "scikit_learn-0.19.0-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl", 
            "packagetype": "bdist_wheel", 
            "path": "60/22/457acd1acad1ef22aa9e62483754defe4c78726ebaaa6bb358caeca8b7ab/scikit_learn-0.19.0-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl", 
            "size": 7833983
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-08-11T18:40:07", 
            "comment_text": "", 
            "python_version": "cp27", 
            "url": "https://pypi.python.org/packages/4e/ed/fab3f5dfcccae2174486da4564756b960b2c8f795555d3e6e84c1ca50bbb/scikit_learn-0.19.0-cp27-cp27m-manylinux1_i686.whl", 
            "md5_digest": "10be6d71e9b778f0a2b0e81531a2b175", 
            "downloads": 0, 
            "filename": "scikit_learn-0.19.0-cp27-cp27m-manylinux1_i686.whl", 
            "packagetype": "bdist_wheel", 
            "path": "4e/ed/fab3f5dfcccae2174486da4564756b960b2c8f795555d3e6e84c1ca50bbb/scikit_learn-0.19.0-cp27-cp27m-manylinux1_i686.whl", 
            "size": 11316503
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-08-11T18:42:05", 
            "comment_text": "", 
            "python_version": "cp27", 
            "url": "https://pypi.python.org/packages/ca/b6/f19303b0af2e87cedc7543b30678c9a5f511df6dff1eabaaeecd4e9aa0dd/scikit_learn-0.19.0-cp27-cp27m-manylinux1_x86_64.whl", 
            "md5_digest": "b960c6490b4118c7ead0f5f43c8c7494", 
            "downloads": 0, 
            "filename": "scikit_learn-0.19.0-cp27-cp27m-manylinux1_x86_64.whl", 
            "packagetype": "bdist_wheel", 
            "path": "ca/b6/f19303b0af2e87cedc7543b30678c9a5f511df6dff1eabaaeecd4e9aa0dd/scikit_learn-0.19.0-cp27-cp27m-manylinux1_x86_64.whl", 
            "size": 12158113
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-08-11T18:43:44", 
            "comment_text": "", 
            "python_version": "cp27", 
            "url": "https://pypi.python.org/packages/a7/88/9e84c9d84e8b79e926fc67594a03a86be34140a2fbf34666f5c58fc023b0/scikit_learn-0.19.0-cp27-cp27mu-manylinux1_i686.whl", 
            "md5_digest": "b9f184e8492e57b5578542e19a98af67", 
            "downloads": 0, 
            "filename": "scikit_learn-0.19.0-cp27-cp27mu-manylinux1_i686.whl", 
            "packagetype": "bdist_wheel", 
            "path": "a7/88/9e84c9d84e8b79e926fc67594a03a86be34140a2fbf34666f5c58fc023b0/scikit_learn-0.19.0-cp27-cp27mu-manylinux1_i686.whl", 
            "size": 11318637
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}