.. image:: docs/logos/logo.png

|文档状态| |PyPI版本| |构建状态| |GitHub Issues| |codecov| |许可证| |下载量| |Python版本|

---

MLBox 是一个功能强大的自动化机器学习 Python 库。 它提供以下功能：

• 快速读取和分布式数据预处理/清洗/格式化
• 高度鲁棒的特征选择和泄露检测
• 在高维空间中进行精确的超参数优化
• 用于分类和回归的最先进预测模型（深度学习、堆叠、LightGBM等）
• 带有模型解释的预测

更多详情，请参阅 官方文档 <https://mlbox.readthedocs.io/en/latest/>__

---

如何贡献

MLBox 已经由许多活跃的社区成员开发并使用。您的帮助对于让它对所有人更好非常宝贵。

• 查看 贡献征集 <https://github.com/AxeldeRomblay/MLBox/labels/call-for-contributions>__ ，了解有哪些可以改进的地方，或者如果您有需求，也可以直接提交一个问题。
• 参与 测试 <https://github.com/AxeldeRomblay/MLBox/tree/master/tests>__ 的编写，以提高其可靠性。
• 参与 文档 <https://github.com/AxeldeRomblay/MLBox/tree/master/docs>__ 的编写，使其更加清晰易懂。
• 参与 示例 <https://github.com/AxeldeRomblay/MLBox/tree/master/examples>__ 的编写，与其他用户分享您的经验。
• 如果在开发过程中遇到问题，请提交 问题 <https://github.com/AxeldeRomblay/MLBox/issues>__。

更多详情，请参阅 CONTRIBUTING <https://github.com/AxeldeRomblay/MLBox/blob/master/docs/contributing.rst>__。

.. |Documentation Status| image:: https://readthedocs.org/projects/mlbox/badge/?version=latest :target: https://mlbox.readthedocs.io/en/latest/ .. |PyPI version| image:: https://badge.fury.io/py/mlbox.svg :target: https://pypi.python.org/pypi/mlbox .. |Build Status| image:: https://travis-ci.org/AxeldeRomblay/MLBox.svg?branch=master :target: https://travis-ci.org/AxeldeRomblay/MLBox .. |GitHub Issues| image:: https://img.shields.io/github/issues/AxeldeRomblay/MLBox.svg :target: https://github.com/AxeldeRomblay/MLBox/issues .. |codecov| image:: https://codecov.io/gh/AxeldeRomblay/MLBox/branch/master/graph/badge.svg :target: https://codecov.io/gh/AxeldeRomblay/MLBox .. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg :target: https://github.com/AxeldeRomblay/MLBox/blob/master/LICENSE .. |Downloads| image:: https://pepy.tech/badge/mlbox :target: https://pepy.tech/project/mlbox .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/mlbox.svg :target: https://pypi.org/project/mlbox

MLBox 快速上手指南

MLBox 是一个功能强大的 Python 自动化机器学习（AutoML）库，支持快速数据读取、分布式预处理、鲁棒的特征选择、高维空间超参数优化以及基于深度学习、Stacking 和 LightGBM 等前沿模型的预测与解释。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：支持 Python 3.x（具体兼容版本请参考 PyPI 页面）
• 前置依赖：
  • 建议先安装基础科学计算库（如 numpy, pandas, scikit-learn）。
  • 若需使用分布式功能或深度学习模型，请确保已安装对应的后端依赖（如 dask, tensorflow 或 pytorch，MLBox 安装时通常会尝试自动处理部分依赖，但手动预装更稳定）。

安装步骤

推荐使用 pip 进行安装。国内开发者可使用清华源或阿里源加速下载。

使用官方源安装：

pip install mlbox

使用国内镜像源加速安装（推荐）：

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

基本使用

以下是一个最简单的分类任务示例，展示从数据读取到模型预测的完整流程。

from mlbox.preprocessing import read_data, preprocess_data
from mlbox.optimisation import Optimiser
from mlbox.prediction import Predictor

# 1. 定义路径和目标变量
path = "data/"  # 数据文件夹路径
target_name = "target"  # 目标列名

# 2. 读取数据
data = read_data(path)

# 3. 数据预处理（自动清洗、格式化、特征选择等）
preprocessed_data = preprocess_data(data)

# 4. 超参数优化
opt = Optimiser(scoring="roc_auc", n_folds=5)
best_params = opt.optimise(preprocessed_data, target_name)

# 5. 训练与预测
pred = Predictor()
pred.fit_predict(best_params, preprocessed_data, target_name)

说明：

• read_data：自动识别并读取指定目录下的训练集和测试集。
• preprocess_data：执行缺失值填充、编码、特征选择及泄露检测。
• Optimiser：在高维空间中搜索最佳超参数。
• Predictor：使用最优参数训练最终模型并生成预测结果（结果通常保存在 predictions 文件夹中）。