|
Metadata-Version: 2.1 |
|
Name: scikit-learn |
|
Version: 1.6.1 |
|
Summary: A set of python modules for machine learning and data mining |
|
Maintainer-Email: scikit-learn developers <[email protected]> |
|
License: BSD 3-Clause License |
|
|
|
Copyright (c) 2007-2024 The scikit-learn developers. |
|
All rights reserved. |
|
|
|
Redistribution and use in source and binary forms, with or without |
|
modification, are permitted provided that the following conditions are met: |
|
|
|
* Redistributions of source code must retain the above copyright notice, this |
|
list of conditions and the following disclaimer. |
|
|
|
* Redistributions in binary form must reproduce the above copyright notice, |
|
this list of conditions and the following disclaimer in the documentation |
|
and/or other materials provided with the distribution. |
|
|
|
* Neither the name of the copyright holder nor the names of its |
|
contributors may be used to endorse or promote products derived from |
|
this software without specific prior written permission. |
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
SERVICES |
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
|
|
---- |
|
|
|
This binary distribution of scikit-learn also bundles the following software: |
|
|
|
---- |
|
|
|
Name: libomp runtime library |
|
Files: sklearn/.dylibs/libomp.dylib |
|
Availability: https://github.com/llvm/llvm-project |
|
|
|
============================================================================== |
|
The LLVM Project is under the Apache License v2.0 with LLVM Exceptions: |
|
============================================================================== |
|
|
|
Apache License |
|
Version 2.0, January 2004 |
|
http://www.apache.org/licenses/ |
|
|
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
|
|
|
1. Definitions. |
|
|
|
"License" shall mean the terms and conditions for use, reproduction, |
|
and distribution as defined by Sections 1 through 9 of this document. |
|
|
|
"Licensor" shall mean the copyright owner or entity authorized by |
|
the copyright owner that is granting the License. |
|
|
|
"Legal Entity" shall mean the union of the acting entity and all |
|
other entities that control, are controlled by, or are under common |
|
control with that entity. For the purposes of this definition, |
|
"control" means (i) the power, direct or indirect, to cause the |
|
direction or management of such entity, whether by contract or |
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
|
outstanding shares, or (iii) beneficial ownership of such entity. |
|
|
|
"You" (or "Your") shall mean an individual or Legal Entity |
|
exercising permissions granted by this License. |
|
|
|
"Source" form shall mean the preferred form for making modifications, |
|
including but not limited to software source code, documentation |
|
source, and configuration files. |
|
|
|
"Object" form shall mean any form resulting from mechanical |
|
transformation or translation of a Source form, including but |
|
not limited to compiled object code, generated documentation, |
|
and conversions to other media types. |
|
|
|
"Work" shall mean the work of authorship, whether in Source or |
|
Object form, made available under the License, as indicated by a |
|
copyright notice that is included in or attached to the work |
|
(an example is provided in the Appendix below). |
|
|
|
"Derivative Works" shall mean any work, whether in Source or Object |
|
form, that is based on (or derived from) the Work and for which the |
|
editorial revisions, annotations, elaborations, or other modifications |
|
represent, as a whole, an original work of authorship. For the purposes |
|
of this License, Derivative Works shall not include works that remain |
|
separable from, or merely link (or bind by name) to the interfaces of, |
|
the Work and Derivative Works thereof. |
|
|
|
"Contribution" shall mean any work of authorship, including |
|
the original version of the Work and any modifications or additions |
|
to that Work or Derivative Works thereof, that is intentionally |
|
submitted to Licensor for inclusion in the Work by the copyright owner |
|
or by an individual or Legal Entity authorized to submit on behalf of |
|
the copyright owner. For the purposes of this definition, "submitted" |
|
means any form of electronic, verbal, or written communication sent |
|
to the Licensor or its representatives, including but not limited to |
|
communication on electronic mailing lists, source code control systems, |
|
and issue tracking systems that are managed by, or on behalf of, the |
|
Licensor for the purpose of discussing and improving the Work, but |
|
excluding communication that is conspicuously marked or otherwise |
|
designated in writing by the copyright owner as "Not a Contribution." |
|
|
|
"Contributor" shall mean Licensor and any individual or Legal Entity |
|
on behalf of whom a Contribution has been received by Licensor and |
|
subsequently incorporated within the Work. |
|
|
|
2. Grant of Copyright License. Subject to the terms and conditions of |
|
this License, each Contributor hereby grants to You a perpetual, |
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
|
copyright license to reproduce, prepare Derivative Works of, |
|
publicly display, publicly perform, sublicense, and distribute the |
|
Work and such Derivative Works in Source or Object form. |
|
|
|
3. Grant of Patent License. Subject to the terms and conditions of |
|
this License, each Contributor hereby grants to You a perpetual, |
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
|
(except as stated in this section) patent license to make, have made, |
|
use, offer to sell, sell, import, and otherwise transfer the Work, |
|
where such license applies only to those patent claims licensable |
|
by such Contributor that are necessarily infringed by their |
|
Contribution(s) alone or by combination of their Contribution(s) |
|
with the Work to which such Contribution(s) was submitted. If You |
|
institute patent litigation against any entity (including a |
|
cross-claim or counterclaim in a lawsuit) alleging that the Work |
|
or a Contribution incorporated within the Work constitutes direct |
|
or contributory patent infringement, then any patent licenses |
|
granted to You under this License for that Work shall terminate |
|
as of the date such litigation is filed. |
|
|
|
4. Redistribution. You may reproduce and distribute copies of the |
|
Work or Derivative Works thereof in any medium, with or without |
|
modifications, and in Source or Object form, provided that You |
|
meet the following conditions: |
|
|
|
(a) You must give any other recipients of the Work or |
|
Derivative Works a copy of this License |
|
|
|
(b) You must cause any modified files to carry prominent notices |
|
stating that You changed the files |
|
|
|
(c) You must retain, in the Source form of any Derivative Works |
|
that You distribute, all copyright, patent, trademark, and |
|
attribution notices from the Source form of the Work, |
|
excluding those notices that do not pertain to any part of |
|
the Derivative Works |
|
|
|
(d) If the Work includes a "NOTICE" text file as part of its |
|
distribution, then any Derivative Works that You distribute must |
|
include a readable copy of the attribution notices contained |
|
within such NOTICE file, excluding those notices that do not |
|
pertain to any part of the Derivative Works, in at least one |
|
of the following places: within a NOTICE text file distributed |
|
as part of the Derivative Works |
|
documentation, if provided along with the Derivative Works |
|
within a display generated by the Derivative Works, if and |
|
wherever such third-party notices normally appear. The contents |
|
of the NOTICE file are for informational purposes only and |
|
do not modify the License. You may add Your own attribution |
|
notices within Derivative Works that You distribute, alongside |
|
or as an addendum to the NOTICE text from the Work, provided |
|
that such additional attribution notices cannot be construed |
|
as modifying the License. |
|
|
|
You may add Your own copyright statement to Your modifications and |
|
may provide additional or different license terms and conditions |
|
for use, reproduction, or distribution of Your modifications, or |
|
for any such Derivative Works as a whole, provided Your use, |
|
reproduction, and distribution of the Work otherwise complies with |
|
the conditions stated in this License. |
|
|
|
5. Submission of Contributions. Unless You explicitly state otherwise, |
|
any Contribution intentionally submitted for inclusion in the Work |
|
by You to the Licensor shall be under the terms and conditions of |
|
this License, without any additional terms or conditions. |
|
Notwithstanding the above, nothing herein shall supersede or modify |
|
the terms of any separate license agreement you may have executed |
|
with Licensor regarding such Contributions. |
|
|
|
6. Trademarks. This License does not grant permission to use the trade |
|
names, trademarks, service marks, or product names of the Licensor, |
|
except as required for reasonable and customary use in describing the |
|
origin of the Work and reproducing the content of the NOTICE file. |
|
|
|
7. Disclaimer of Warranty. Unless required by applicable law or |
|
agreed to in writing, Licensor provides the Work (and each |
|
Contributor provides its Contributions) on an "AS IS" BASIS, |
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
|
implied, including, without limitation, any warranties or conditions |
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
|
PARTICULAR PURPOSE. You are solely responsible for determining the |
|
appropriateness of using or redistributing the Work and assume any |
|
risks associated with Your exercise of permissions under this License. |
|
|
|
8. Limitation of Liability. In no event and under no legal theory, |
|
whether in tort (including negligence), contract, or otherwise, |
|
unless required by applicable law (such as deliberate and grossly |
|
negligent acts) or agreed to in writing, shall any Contributor be |
|
liable to You for damages, including any direct, indirect, special, |
|
incidental, or consequential damages of any character arising as a |
|
result of this License or out of the use or inability to use the |
|
Work (including but not limited to damages for loss of goodwill, |
|
work stoppage, computer failure or malfunction, or any and all |
|
other commercial damages or losses), even if such Contributor |
|
has been advised of the possibility of such damages. |
|
|
|
9. Accepting Warranty or Additional Liability. While redistributing |
|
the Work or Derivative Works thereof, You may choose to offer, |
|
and charge a fee for, acceptance of support, warranty, indemnity, |
|
or other liability obligations and/or rights consistent with this |
|
License. However, in accepting such obligations, You may act only |
|
on Your own behalf and on Your sole responsibility, not on behalf |
|
of any other Contributor, and only if You agree to indemnify, |
|
defend, and hold each Contributor harmless for any liability |
|
incurred by, or claims asserted against, such Contributor by reason |
|
of your accepting any such warranty or additional liability. |
|
|
|
END OF TERMS AND CONDITIONS |
|
|
|
APPENDIX: How to apply the Apache License to your work. |
|
|
|
To apply the Apache License to your work, attach the following |
|
boilerplate notice, with the fields enclosed by brackets "[]" |
|
replaced with your own identifying information. (Don't include |
|
the brackets!) The text should be enclosed in the appropriate |
|
comment syntax for the file format. We also recommend that a |
|
file or class name and description of purpose be included on the |
|
same "printed page" as the copyright notice for easier |
|
identification within third-party archives. |
|
|
|
Copyright [yyyy] [name of copyright owner] |
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); |
|
you may not use this file except in compliance with the License. |
|
You may obtain a copy of the License at |
|
|
|
http://www.apache.org/licenses/LICENSE-2.0 |
|
|
|
Unless required by applicable law or agreed to in writing, software |
|
distributed under the License is distributed on an "AS IS" BASIS, |
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
See the License for the specific language governing permissions and |
|
limitations under the License. |
|
|
|
|
|
---- LLVM Exceptions to the Apache 2.0 License ---- |
|
|
|
As an exception, if, as a result of your compiling your source code, portions |
|
of this Software are embedded into an Object form of such source code, you |
|
may redistribute such embedded portions in such Object form without complying |
|
with the conditions of Sections 4(a), 4(b) and 4(d) of the License. |
|
|
|
In addition, if you combine or link compiled forms of this Software with |
|
software that is licensed under the GPLv2 ("Combined Software") and if a |
|
court of competent jurisdiction determines that the patent provision (Section |
|
3), the indemnity provision (Section 9) or other Section of the License |
|
conflicts with the conditions of the GPLv2, you may retroactively and |
|
prospectively choose to deem waived or otherwise exclude such Section(s) of |
|
the License, but only in their entirety and only with respect to the Combined |
|
Software. |
|
|
|
============================================================================== |
|
Software from third parties included in the LLVM Project: |
|
============================================================================== |
|
The LLVM Project contains third party software which is under different license |
|
terms. All such code will be identified clearly using at least one of two |
|
mechanisms: |
|
1) It will be in a separate directory tree with its own `LICENSE.txt` or |
|
`LICENSE` file at the top containing the specific license and restrictions |
|
which apply to that software, or |
|
2) It will contain specific license and restriction terms at the top of every |
|
file. |
|
|
|
============================================================================== |
|
Legacy LLVM License (https://llvm.org/docs/DeveloperPolicy.html#legacy): |
|
============================================================================== |
|
University of Illinois/NCSA |
|
Open Source License |
|
|
|
Copyright (c) 2003-2019 University of Illinois at Urbana-Champaign. |
|
All rights reserved. |
|
|
|
Developed by: |
|
|
|
LLVM Team |
|
|
|
University of Illinois at Urbana-Champaign |
|
|
|
http://llvm.org |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of |
|
this software and associated documentation files (the "Software"), to deal with |
|
the Software without restriction, including without limitation the rights to |
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies |
|
of the Software, and to permit persons to whom the Software is furnished to do |
|
so, subject to the following conditions: |
|
|
|
* Redistributions of source code must retain the above copyright notice, |
|
this list of conditions and the following disclaimers. |
|
|
|
* Redistributions in binary form must reproduce the above copyright notice, |
|
this list of conditions and the following disclaimers in the |
|
documentation and/or other materials provided with the distribution. |
|
|
|
* Neither the names of the LLVM Team, University of Illinois at |
|
Urbana-Champaign, nor the names of its contributors may be used to |
|
endorse or promote products derived from this Software without specific |
|
prior written permission. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE |
|
SOFTWARE. |
|
|
|
Classifier: Intended Audience :: Science/Research |
|
Classifier: Intended Audience :: Developers |
|
Classifier: License :: OSI Approved :: BSD License |
|
Classifier: Programming Language :: C |
|
Classifier: Programming Language :: Python |
|
Classifier: Topic :: Software Development |
|
Classifier: Topic :: Scientific/Engineering |
|
Classifier: Development Status :: 5 - Production/Stable |
|
Classifier: Operating System :: Microsoft :: Windows |
|
Classifier: Operating System :: POSIX |
|
Classifier: Operating System :: Unix |
|
Classifier: Operating System :: MacOS |
|
Classifier: Programming Language :: Python :: 3 |
|
Classifier: Programming Language :: Python :: 3.9 |
|
Classifier: Programming Language :: Python :: 3.10 |
|
Classifier: Programming Language :: Python :: 3.11 |
|
Classifier: Programming Language :: Python :: 3.12 |
|
Classifier: Programming Language :: Python :: 3.13 |
|
Classifier: Programming Language :: Python :: Implementation :: CPython |
|
Project-URL: homepage, https://scikit-learn.org |
|
Project-URL: source, https://github.com/scikit-learn/scikit-learn |
|
Project-URL: download, https://pypi.org/project/scikit-learn/#files |
|
Project-URL: tracker, https://github.com/scikit-learn/scikit-learn/issues |
|
Project-URL: release notes, https://scikit-learn.org/stable/whats_new |
|
Requires-Python: >=3.9 |
|
Requires-Dist: numpy>=1.19.5 |
|
Requires-Dist: scipy>=1.6.0 |
|
Requires-Dist: joblib>=1.2.0 |
|
Requires-Dist: threadpoolctl>=3.1.0 |
|
Provides-Extra: build |
|
Requires-Dist: numpy>=1.19.5; extra == "build" |
|
Requires-Dist: scipy>=1.6.0; extra == "build" |
|
Requires-Dist: cython>=3.0.10; extra == "build" |
|
Requires-Dist: meson-python>=0.16.0; extra == "build" |
|
Provides-Extra: install |
|
Requires-Dist: numpy>=1.19.5; extra == "install" |
|
Requires-Dist: scipy>=1.6.0; extra == "install" |
|
Requires-Dist: joblib>=1.2.0; extra == "install" |
|
Requires-Dist: threadpoolctl>=3.1.0; extra == "install" |
|
Provides-Extra: benchmark |
|
Requires-Dist: matplotlib>=3.3.4; extra == "benchmark" |
|
Requires-Dist: pandas>=1.1.5; extra == "benchmark" |
|
Requires-Dist: memory_profiler>=0.57.0; extra == "benchmark" |
|
Provides-Extra: docs |
|
Requires-Dist: matplotlib>=3.3.4; extra == "docs" |
|
Requires-Dist: scikit-image>=0.17.2; extra == "docs" |
|
Requires-Dist: pandas>=1.1.5; extra == "docs" |
|
Requires-Dist: seaborn>=0.9.0; extra == "docs" |
|
Requires-Dist: memory_profiler>=0.57.0; extra == "docs" |
|
Requires-Dist: sphinx>=7.3.7; extra == "docs" |
|
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs" |
|
Requires-Dist: sphinx-gallery>=0.17.1; extra == "docs" |
|
Requires-Dist: numpydoc>=1.2.0; extra == "docs" |
|
Requires-Dist: Pillow>=7.1.2; extra == "docs" |
|
Requires-Dist: pooch>=1.6.0; extra == "docs" |
|
Requires-Dist: sphinx-prompt>=1.4.0; extra == "docs" |
|
Requires-Dist: sphinxext-opengraph>=0.9.1; extra == "docs" |
|
Requires-Dist: plotly>=5.14.0; extra == "docs" |
|
Requires-Dist: polars>=0.20.30; extra == "docs" |
|
Requires-Dist: sphinx-design>=0.5.0; extra == "docs" |
|
Requires-Dist: sphinx-design>=0.6.0; extra == "docs" |
|
Requires-Dist: sphinxcontrib-sass>=0.3.4; extra == "docs" |
|
Requires-Dist: pydata-sphinx-theme>=0.15.3; extra == "docs" |
|
Requires-Dist: sphinx-remove-toctrees>=1.0.0.post1; extra == "docs" |
|
Requires-Dist: towncrier>=24.8.0; extra == "docs" |
|
Provides-Extra: examples |
|
Requires-Dist: matplotlib>=3.3.4; extra == "examples" |
|
Requires-Dist: scikit-image>=0.17.2; extra == "examples" |
|
Requires-Dist: pandas>=1.1.5; extra == "examples" |
|
Requires-Dist: seaborn>=0.9.0; extra == "examples" |
|
Requires-Dist: pooch>=1.6.0; extra == "examples" |
|
Requires-Dist: plotly>=5.14.0; extra == "examples" |
|
Provides-Extra: tests |
|
Requires-Dist: matplotlib>=3.3.4; extra == "tests" |
|
Requires-Dist: scikit-image>=0.17.2; extra == "tests" |
|
Requires-Dist: pandas>=1.1.5; extra == "tests" |
|
Requires-Dist: pytest>=7.1.2; extra == "tests" |
|
Requires-Dist: pytest-cov>=2.9.0; extra == "tests" |
|
Requires-Dist: ruff>=0.5.1; extra == "tests" |
|
Requires-Dist: black>=24.3.0; extra == "tests" |
|
Requires-Dist: mypy>=1.9; extra == "tests" |
|
Requires-Dist: pyamg>=4.0.0; extra == "tests" |
|
Requires-Dist: polars>=0.20.30; extra == "tests" |
|
Requires-Dist: pyarrow>=12.0.0; extra == "tests" |
|
Requires-Dist: numpydoc>=1.2.0; extra == "tests" |
|
Requires-Dist: pooch>=1.6.0; extra == "tests" |
|
Provides-Extra: maintenance |
|
Requires-Dist: conda-lock==2.5.6; extra == "maintenance" |
|
Description-Content-Type: text/x-rst |
|
|
|
.. -*- mode: rst -*- |
|
|
|
|Azure| |CirrusCI| |Codecov| |CircleCI| |Nightly wheels| |Black| |PythonVersion| |PyPi| |DOI| |Benchmark| |
|
|
|
.. |Azure| image:: https://dev.azure.com/scikit-learn/scikit-learn/_apis/build/status/scikit-learn.scikit-learn?branchName=main |
|
:target: https://dev.azure.com/scikit-learn/scikit-learn/_build/latest?definitionId=1&branchName=main |
|
|
|
.. |CircleCI| image:: https://circleci.com/gh/scikit-learn/scikit-learn/tree/main.svg?style=shield |
|
:target: https://circleci.com/gh/scikit-learn/scikit-learn |
|
|
|
.. |CirrusCI| image:: https://img.shields.io/cirrus/github/scikit-learn/scikit-learn/main?label=Cirrus%20CI |
|
:target: https://cirrus-ci.com/github/scikit-learn/scikit-learn/main |
|
|
|
.. |Codecov| image:: https://codecov.io/gh/scikit-learn/scikit-learn/branch/main/graph/badge.svg?token=Pk8G9gg3y9 |
|
:target: https://codecov.io/gh/scikit-learn/scikit-learn |
|
|
|
.. |Nightly wheels| image:: https://github.com/scikit-learn/scikit-learn/workflows/Wheel%20builder/badge.svg?event=schedule |
|
:target: https://github.com/scikit-learn/scikit-learn/actions?query=workflow%3A%22Wheel+builder%22+event%3Aschedule |
|
|
|
.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/scikit-learn.svg |
|
:target: https://pypi.org/project/scikit-learn/ |
|
|
|
.. |PyPi| image:: https://img.shields.io/pypi/v/scikit-learn |
|
:target: https://pypi.org/project/scikit-learn |
|
|
|
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg |
|
:target: https://github.com/psf/black |
|
|
|
.. |DOI| image:: https://zenodo.org/badge/21369/scikit-learn/scikit-learn.svg |
|
:target: https://zenodo.org/badge/latestdoi/21369/scikit-learn/scikit-learn |
|
|
|
.. |Benchmark| image:: https://img.shields.io/badge/Benchmarked%20by-asv-blue |
|
:target: https://scikit-learn.org/scikit-learn-benchmarks |
|
|
|
.. |PythonMinVersion| replace:: 3.9 |
|
.. |NumPyMinVersion| replace:: 1.19.5 |
|
.. |SciPyMinVersion| replace:: 1.6.0 |
|
.. |JoblibMinVersion| replace:: 1.2.0 |
|
.. |ThreadpoolctlMinVersion| replace:: 3.1.0 |
|
.. |MatplotlibMinVersion| replace:: 3.3.4 |
|
.. |Scikit-ImageMinVersion| replace:: 0.17.2 |
|
.. |PandasMinVersion| replace:: 1.1.5 |
|
.. |SeabornMinVersion| replace:: 0.9.0 |
|
.. |PytestMinVersion| replace:: 7.1.2 |
|
.. |PlotlyMinVersion| replace:: 5.14.0 |
|
|
|
.. image:: https://raw.githubusercontent.com/scikit-learn/scikit-learn/main/doc/logos/scikit-learn-logo.png |
|
:target: https://scikit-learn.org/ |
|
|
|
**scikit-learn** is a Python module for machine learning built on top of |
|
SciPy and is 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 <https://scikit-learn.org/dev/about.html#authors>`__ page |
|
for a list of core contributors. |
|
|
|
It is currently maintained by a team of volunteers. |
|
|
|
Website: https://scikit-learn.org |
|
|
|
Installation |
|
------------ |
|
|
|
Dependencies |
|
~~~~~~~~~~~~ |
|
|
|
scikit-learn requires: |
|
|
|
- Python (>= |PythonMinVersion|) |
|
- NumPy (>= |NumPyMinVersion|) |
|
- SciPy (>= |SciPyMinVersion|) |
|
- joblib (>= |JoblibMinVersion|) |
|
- threadpoolctl (>= |ThreadpoolctlMinVersion|) |
|
|
|
======= |
|
|
|
**Scikit-learn 0.20 was the last version to support Python 2.7 and Python 3.4.** |
|
scikit-learn 1.0 and later require Python 3.7 or newer. |
|
scikit-learn 1.1 and later require Python 3.8 or newer. |
|
|
|
Scikit-learn plotting capabilities (i.e., functions start with ``plot_`` and |
|
classes end with ``Display``) require Matplotlib (>= |MatplotlibMinVersion|). |
|
For running the examples Matplotlib >= |MatplotlibMinVersion| is required. |
|
A few examples require scikit-image >= |Scikit-ImageMinVersion|, a few examples |
|
require pandas >= |PandasMinVersion|, some examples require seaborn >= |
|
|SeabornMinVersion| and plotly >= |PlotlyMinVersion|. |
|
|
|
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 -c conda-forge scikit-learn |
|
|
|
The documentation includes more detailed `installation instructions <https://scikit-learn.org/stable/install.html>`_. |
|
|
|
|
|
Changelog |
|
--------- |
|
|
|
See the `changelog <https://scikit-learn.org/dev/whats_new.html>`__ |
|
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 <https://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.org/project/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 |
|
|
|
Contributing |
|
~~~~~~~~~~~~ |
|
|
|
To learn more about making a contribution to scikit-learn, please see our |
|
`Contributing guide |
|
<https://scikit-learn.org/dev/developers/contributing.html>`_. |
|
|
|
Testing |
|
~~~~~~~ |
|
|
|
After installation, you can launch the test suite from outside the source |
|
directory (you will need to have ``pytest`` >= |PyTestMinVersion| installed):: |
|
|
|
pytest sklearn |
|
|
|
See the web page https://scikit-learn.org/dev/developers/contributing.html#testing-and-improving-test-coverage |
|
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: https://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 <https://scikit-learn.org/dev/about.html#authors>`__ 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 |
|
~~~~~~~~~~~~~ |
|
|
|
- HTML documentation (stable release): https://scikit-learn.org |
|
- HTML documentation (development version): https://scikit-learn.org/dev/ |
|
- FAQ: https://scikit-learn.org/stable/faq.html |
|
|
|
Communication |
|
~~~~~~~~~~~~~ |
|
|
|
- Mailing list: https://mail.python.org/mailman/listinfo/scikit-learn |
|
- Logos & Branding: https://github.com/scikit-learn/scikit-learn/tree/main/doc/logos |
|
- Blog: https://blog.scikit-learn.org |
|
- Calendar: https://blog.scikit-learn.org/calendar/ |
|
- Twitter: https://twitter.com/scikit_learn |
|
- Stack Overflow: https://stackoverflow.com/questions/tagged/scikit-learn |
|
- GitHub Discussions: https://github.com/scikit-learn/scikit-learn/discussions |
|
- Website: https://scikit-learn.org |
|
- LinkedIn: https://www.linkedin.com/company/scikit-learn |
|
- Bluesky: https://bsky.app/profile/scikit-learn.org |
|
- YouTube: https://www.youtube.com/channel/UCJosFjYm0ZYVUARxuOZqnnw/playlists |
|
- Facebook: https://www.facebook.com/scikitlearnofficial/ |
|
- Instagram: https://www.instagram.com/scikitlearnofficial/ |
|
- TikTok: https://www.tiktok.com/@scikit.learn |
|
- Mastodon: https://mastodon.social/@sklearn@fosstodon.org |
|
- Discord: https://discord.gg/h9qyrK8Jc8 |
|
|
|
|
|
Citation |
|
~~~~~~~~ |
|
|
|
If you use scikit-learn in a scientific publication, we would appreciate citations: https://scikit-learn.org/stable/about.html#citing-scikit-learn |
|
|