算法 - Jupyter

开始使用

您只需点击一下，即可使用免费的在线开发环境 Gitpod.io 来运行、编辑这些算法或为它们做出贡献。

贡献新算法

• 请确保您的拉取请求内容 具体 且 聚焦。不要一次性贡献“多个算法”，而是逐个单独提交（例如，一个拉取请求用于“逻辑回归”，另一个用于“K-均值聚类”，以此类推）。

• 每个新算法都必须包含：

  • 带有注释和易读命名的 源代码
  • 在 README.md 中与代码一起解释的 数学原理
  • 包含该新算法应用示例的 Jupyter 演示笔记本

如果您要添加新的 数据集，请将其保存在 /data 文件夹中。建议使用 CSV 文件格式。文件大小不应超过 30Mb。

贡献说明

在修复任何错误或添加新算法之前，请先阅读我们的 贡献指南 和 行为准则。

许可证

所有代码均采用 MIT 许可证 授权。

Jupyter 算法库快速上手指南

本指南基于 The Algorithms - Jupyter 项目，帮助开发者快速在本地或云端运行和贡献算法代码。

环境准备

本项目主要包含 Jupyter Notebook 文件（.ipynb）和相关数据文件。你可以选择以下两种方式之一开始：

方案 A：云端免安装（推荐）

无需配置本地环境，直接使用浏览器运行。

• 前置条件：拥有 GitHub 账号。
• 依赖：无（云端已预装所有依赖）。

方案 B：本地运行

如果你希望在本地编辑和运行，需要以下环境：

• 操作系统：Windows / macOS / Linux
• 核心依赖：
  • Python 3.8+
  • Jupyter Lab 或 Jupyter Notebook
  • 常用科学计算库（如 numpy, pandas, matplotlib, scikit-learn 等，具体视算法而定）

安装步骤

方式一：使用 Gitpod（一键启动）

这是最快捷的方式，点击按钮即可创建完整的开发环境：

或者在浏览器中访问：

https://gitpod.io/#https://github.com/TheAlgorithms/Jupyter

方式二：本地克隆与运行

如果选择本地运行，请执行以下命令：

1. 克隆仓库

   git clone https://github.com/TheAlgorithms/Jupyter.git
   cd Jupyter
   

2. 安装依赖 建议先更新 pip 源（使用清华镜像加速）：

   pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade pip
   

   安装 Jupyter 及常用数据科学库：

   pip install -i https://pypi.tuna.tsinghua.edu.cn/simple jupyterlab numpy pandas matplotlib scikit-learn
   

3. 启动 Jupyter

   jupyter lab
   

   浏览器将自动打开并显示项目目录。

基本使用

运行现有算法

1. 在 Jupyter 界面中，进入对应的算法分类文件夹（如 machine_learning）。
2. 点击任意 .ipynb 文件（例如 linear_regression.ipynb）。
3. 点击菜单栏的 Run -> Run All Cells 即可看到算法演示和数学原理讲解。

贡献新算法

如果你打算提交新的算法，请遵循以下规范：

1. 代码要求：

   • 代码需包含清晰的注释和可读的变量命名。
   • 每个 PR 应只包含一个具体的算法（例如：单独提交 "Logistic Regression"，不要混合多个算法）。

2. 文档要求：

   • 必须在 README.md 中解释算法背后的数学原理。
   • 必须提供 Jupyter Demo Notebook，展示该算法的实际应用示例。

3. 数据集处理：

   • 如需使用新数据集，请将其保存至 /data 文件夹。
   • 优先使用 CSV 格式。
   • 单个文件大小不得超过 30Mb。

4. 提交前检查： 在提交 Pull Request 之前，请务必阅读项目的 Contribution Guidelines 和 Code of Conduct。

提示：所有代码均遵循 MIT License 协议。