.. -- mode: rst --

|GitHubActions| |Codecov| |CircleCI| |Nightly wheels| |Ruff| |PythonVersion| |PyPI| |DOI| |Benchmark|

.. |GitHubActions| image:: https://github.com/scikit-learn/scikit-learn/actions/workflows/unit-tests.yml/badge.svg :target: https://github.com/scikit-learn/scikit-learn/actions/workflows/unit-tests.yml?query=branch%3Amain

.. |CircleCI| image:: https://circleci.com/gh/scikit-learn/scikit-learn/tree/main.svg?style=shield :target: https://circleci.com/gh/scikit-learn/scikit-learn

.. |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/actions/workflows/wheels.yml/badge.svg?event=schedule :target: https://github.com/scikit-learn/scikit-learn/actions?query=workflow%3A%22Wheel+builder%22+event%3Aschedule

.. |Ruff| image:: https://img.shields.io/badge/code%20style-ruff-000000.svg :target: https://github.com/astral-sh/ruff

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

.. |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.11 .. |NumPyMinVersion| replace:: 1.24.1 .. |SciPyMinVersion| replace:: 1.10.0 .. |JoblibMinVersion| replace:: 1.3.0 .. |ThreadpoolctlMinVersion| replace:: 3.2.0 .. |MatplotlibMinVersion| replace:: 3.6.1 .. |Scikit-ImageMinVersion| replace:: 0.22.0 .. |PandasMinVersion| replace:: 1.5.0 .. |SeabornMinVersion| replace:: 0.13.0 .. |PytestMinVersion| replace:: 7.1.2 .. |PlotlyMinVersion| replace:: 5.18.0

.. image:: https://raw.githubusercontent.com/scikit-learn/scikit-learn/main/doc/logos/scikit-learn-logo.png :target: https://scikit-learn.org/

scikit-learn 是一个基于 SciPy 构建的 Python 机器学习模块，采用 3 条款 BSD 许可证进行分发。

该项目于 2007 年由 David Cournapeau 作为 Google Summer of Code 项目启动，此后吸引了众多志愿者参与贡献。核心贡献者名单请参见 关于我们 <https://scikit-learn.org/dev/about.html#authors>__ 页面。

目前，scikit-learn 由一群志愿者维护。

官网：https://scikit-learn.org

安装

依赖项

scikit-learn 需要以下依赖：

- Python (>= |PythonMinVersion|)
- NumPy (>= |NumPyMinVersion|)
- SciPy (>= |SciPyMinVersion|)
- joblib (>= |JoblibMinVersion|)
- threadpoolctl (>= |ThreadpoolctlMinVersion|)

=======

scikit-learn 的绘图功能（即以 ``plot_`` 开头的函数和以 ``Display`` 结尾的类）需要 Matplotlib (>= |MatplotlibMinVersion|)。运行示例时，同样需要 Matplotlib >= |MatplotlibMinVersion|。部分示例还要求 scikit-image >= |Scikit-ImageMinVersion|、pandas >= |PandasMinVersion|、seaborn >= |SeabornMinVersion| 以及 Plotly >= |PlotlyMinVersion|。

用户安装

如果您已经安装了可用的 NumPy 和 SciPy，最简单的安装方式是使用 pip::

pip install -U scikit-learn

或者使用 conda::

conda install -c conda-forge scikit-learn

更多详细的安装说明，请参阅文档：https://scikit-learn.org/stable/install.html

变更日志

有关 scikit-learn 的重要变更历史，请参阅 变更日志 <https://scikit-learn.org/dev/whats_new.html>__。

开发

我们欢迎所有经验水平的新贡献者。scikit-learn 社区的目标是提供帮助、友好且高效的工作环境。开发指南 <https://scikit-learn.org/stable/developers/index.html>_ 提供了关于代码、文档、测试等方面贡献的详细信息。本 README 中也包含了一些基本信息。

重要链接

- 官方源码仓库：https://github.com/scikit-learn/scikit-learn
- 发布版本下载：https://pypi.org/project/scikit-learn/
- 问题追踪器：https://github.com/scikit-learn/scikit-learn/issues

源码
~~~~

您可以通过以下命令获取最新源码：

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

贡献
~~~~

如需了解更多关于如何为 scikit-learn 做出贡献的信息，请参阅我们的 `贡献指南 <https://scikit-learn.org/dev/developers/contributing.html>`_。

测试
~~~~

安装完成后，您可以在源码目录外运行测试套件（需安装 pytest >= |PytestMinVersion|）：

    pytest sklearn

更多信息请访问：https://scikit-learn.org/dev/developers/contributing.html#testing-and-improving-test-coverage

在测试过程中，可以通过设置环境变量 ``SKLEARN_SEED`` 来控制随机数生成。

提交 Pull Request

在打开 Pull Request 之前，请务必查看完整的贡献页面，确保您的代码符合我们的指南：https://scikit-learn.org/stable/developers/index.html

项目历史

该项目于 2007 年由 David Cournapeau 作为 Google Summer of Code 项目启动，此后吸引了众多志愿者参与贡献。核心贡献者名单请参见 关于我们 <https://scikit-learn.org/dev/about.html#authors>__ 页面。

目前，该项目由一组志愿者维护。

注意：scikit-learn 曾被称为 scikits.learn。

帮助与支持

文档

- HTML 文档（稳定版）：https://scikit-learn.org
- HTML 文档（开发版）：https://scikit-learn.org/dev/
- 常见问题解答：https://scikit-learn.org/stable/faq.html

沟通

主要渠道 ^^^^^^^^

• 官网：https://scikit-learn.org
• 博客：https://blog.scikit-learn.org
• 邮件列表：https://mail.python.org/mailman/listinfo/scikit-learn

开发者与支持 ^^^^^^^^^^^^^^^

• GitHub Discussions：https://github.com/scikit-learn/scikit-learn/discussions
• Stack Overflow：https://stackoverflow.com/questions/tagged/scikit-learn
• Discord：https://discord.gg/h9qyrK8Jc8

社交媒体平台 ^^^^^^^^^^^^^^

• 领英: https://www.linkedin.com/company/scikit-learn
• YouTube: https://www.youtube.com/channel/UCJosFjYm0ZYVUARxuOZqnnw/playlists
• 脸书: https://www.facebook.com/scikitlearnofficial/
• Instagram: https://www.instagram.com/scikitlearnofficial/
• TikTok: https://www.tiktok.com/@scikit.learn
• Bluesky: https://bsky.app/profile/scikit-learn.org
• Mastodon: https://mastodon.social/@sklearn@fosstodon.org

资源 ^^^^^^^^^

• 日历: https://blog.scikit-learn.org/calendar/
• 徽标与品牌资料: https://github.com/scikit-learn/scikit-learn/tree/main/doc/logos

引用

如果您在科学出版物中使用了 scikit-learn，我们非常感谢您进行引用：https://scikit-learn.org/stable/about.html#citing-scikit-learn

scikit-learn 快速上手指南

scikit-learn 是一个基于 SciPy 构建的 Python 机器学习模块，采用 3-Clause BSD 许可证分发。它提供了简单高效的工具用于数据挖掘和数据分析，适合各类经验水平的开发者。

环境准备

在开始之前，请确保您的系统满足以下最低要求：

• Python: >= 3.11
• 核心依赖:
  • NumPy >= 1.24.1
  • SciPy >= 1.10.0
  • joblib >= 1.3.0
  • threadpoolctl >= 3.2.0
• 可选依赖 (用于绘图和运行示例):
  • Matplotlib >= 3.6.1
  • pandas >= 1.5.0
  • scikit-image >= 0.22.0
  • seaborn >= 0.13.0

安装步骤

如果您已经安装了 working 版本的 NumPy 和 SciPy，推荐使用以下方式进行安装。

方式一：使用 pip 安装（推荐国内用户配置镜像）

使用官方源：

pip install -U scikit-learn

国内加速方案：建议使用清华大学或阿里云镜像源以提升下载速度：

pip install -U scikit-learn -i https://pypi.tuna.tsinghua.edu.cn/simple
# 或者
pip install -U scikit-learn -i https://mirrors.aliyun.com/pypi/simple/

方式二：使用 conda 安装

如果您使用 Anaconda 或 Miniconda 环境：

conda install -c conda-forge scikit-learn

基本使用

scikit-learn 的核心设计理念是统一的 API。以下是一个最简单的分类模型训练与预测示例：

from sklearn.datasets import load_iris
from sklearn.model_selection import train_test_split
from sklearn.ensemble import RandomForestClassifier
from sklearn.metrics import accuracy_score

# 1. 加载数据集
iris = load_iris()
X, y = iris.data, iris.target

# 2. 划分训练集和测试集
X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42)

# 3. 初始化并训练模型
clf = RandomForestClassifier(n_estimators=100, random_state=42)
clf.fit(X_train, y_train)

# 4. 进行预测
y_pred = clf.predict(X_test)

# 5. 评估模型
print(f"Accuracy: {accuracy_score(y_test, y_pred):.2f}")

更多详细文档和高级用法请访问官方网站：https://scikit-learn.org