Skip to content

Commit ac9e356

Browse files
JasonYeYuhethinkall
JasonYeYuhe
and
thinkall
authored
docs: add Simplified Chinese translation (README.zh.md) (#1604)
* docs: add Simplified Chinese translation (README.zh.md) Signed-off-by: YE <yyyyy.yeyuhe@gmail.com> * docs: address maintainer review feedback on Chinese and English READMEs - Format README.zh.md separator according to mdformat - Use absolute GitHub URL for Chinese README in PyPI description - Update outdated GitHub help 404 URL to current GitHub docs URL - Preserve Zero-shot AutoML link in README.zh.md - Replace typographic ellipsis in tune.run code snippet with valid Python ellipsis - Accurately translate quality models claim without changing meaning Signed-off-by: YE <yyyyy.yeyuhe@gmail.com> --------- Signed-off-by: YE <yyyyy.yeyuhe@gmail.com> Co-authored-by: Li Jiang <bnujli@gmail.com>
1 parent c0a0b2f commit ac9e356

2 files changed

Lines changed: 129 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
<br>
1515
</p>
1616

17+
<p align="center">
18+
<b>English</b> · <a href="https://github.com/microsoft/FLAML/blob/main/README.zh.md">简体中文</a>
19+
</p>
20+
1721
:fire: FLAML supports AutoML and Hyperparameter Tuning in [Microsoft Fabric Data Science](https://learn.microsoft.com/en-us/fabric/data-science/automated-machine-learning-fabric). In addition, we've introduced Python 3.11+ support, along with a range of new estimators, and comprehensive integration with MLflow—thanks to contributions from the Microsoft Fabric product team.
1822

1923
:fire: Heads-up: [AutoGen](https://microsoft.github.io/autogen/) has moved to a dedicated [GitHub repository](https://github.com/microsoft/autogen). FLAML no longer includes the `autogen` module—please use AutoGen directly.
@@ -74,7 +78,7 @@ automl.fit(X_train, y_train, task="classification", estimator_list=["lgbm"])
7478
from flaml import tune
7579

7680
tune.run(
77-
evaluation_function, config={…}, low_cost_partial_config={…}, time_budget_s=3600
81+
evaluation_function, config={...}, low_cost_partial_config={...}, time_budget_s=3600
7882
)
7983
```
8084

@@ -109,7 +113,7 @@ This project welcomes contributions and suggestions. Most contributions require
109113
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
110114
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
111115

112-
If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub.
116+
If you are new to GitHub [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) is a detailed help source on getting involved with development on GitHub.
113117

114118
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
115119
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions

‎README.zh.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
[![PyPI version](https://badge.fury.io/py/FLAML.svg)](https://badge.fury.io/py/FLAML)
2+
![Conda version](https://img.shields.io/conda/vn/conda-forge/flaml)
3+
[![Build](https://github.com/microsoft/FLAML/actions/workflows/python-package.yml/badge.svg)](https://github.com/microsoft/FLAML/actions/workflows/python-package.yml)
4+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/FLAML)](https://pypi.org/project/FLAML/)
5+
[![Downloads](https://pepy.tech/badge/flaml)](https://pepy.tech/project/flaml)
6+
[![](https://img.shields.io/discord/1025786666260111483?logo=discord&style=flat)](https://discord.gg/Cppx2vSPVP)
7+
8+
<!-- [![Join the chat at https://gitter.im/FLAMLer/community](https://badges.gitter.im/FLAMLer/community.svg)](https://gitter.im/FLAMLer/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -->
9+
10+
# 快速高效的自动化机器学习与超参数调优算法库
11+
12+
<p align="center">
13+
<img src="https://github.com/microsoft/FLAML/blob/main/website/static/img/flaml.svg" width=200>
14+
<br>
15+
</p>
16+
17+
<p align="center">
18+
<a href="https://github.com/microsoft/FLAML/blob/main/README.md">English</a> · <b>简体中文</b>
19+
</p>
20+
21+
:fire: FLAML 全面支持 [Microsoft Fabric Data Science](https://learn.microsoft.com/zh-cn/fabric/data-science/automated-machine-learning-fabric) 中的 AutoML 与超参数调优。此外，得益于 Microsoft Fabric 产品团队的贡献，我们引入了对 Python 3.11+ 的支持、一系列全新的算法评估器（Estimators），并深度集成了 MLflow。
22+
23+
:fire: **重要提醒**：[AutoGen](https://microsoft.github.io/autogen/) 已迁移至专属的[独立 GitHub 仓库](https://github.com/microsoft/autogen)。FLAML 代码库中已不再内置 `autogen` 模块——请直接使用 AutoGen 独立包。
24+
25+
## 什么是 FLAML
26+
27+
FLAML 是一个轻量级 Python 算法库，专注于机器学习（ML）与人工智能操作（AI Operations）的高效自动化。它能够自动化编排基于大语言模型、经典机器学习模型等工作流，并极致优化其性能表现。
28+
29+
- **经济高效的自动化与调优**：FLAML 支持在严格的计算资源与时间约束下，对 ML/AI 工作流自动化完成模型选择与超参数优化。
30+
- **低算力开销的常见任务求解**：对于分类和回归等常见机器学习任务，它能够在极低算力开销下迅速针对用户提供的数据找到高质量模型。它易于定制或扩展，用户可以在平滑的自由度区间内随心设定所需的自定义程度。
31+
- **快速经济的通用自动化调优**：支持各类复杂场景下的自动调优（例如：基座大模型的推理超参数、MLOps/LMOps 工作流配置、流水线、数学与统计模型、特定算法、计算实验参数、底层软件系统配置等），能够从容应对具有异构评估开销（Heterogeneous Evaluation Cost）、复杂约束条件、先验引导以及早停机制的超大规模搜索空间。
32+
33+
FLAML 凝聚了微软研究院（Microsoft Research）以及宾夕法尼亚州立大学、斯蒂文斯理工学院、华盛顿大学和滑铁卢大学等合作科研机构的[系列前沿学术研究成果](https://microsoft.github.io/FLAML/docs/Research/)。
34+
35+
此外，FLAML 在微软官方跨平台开源机器学习框架 [ML.NET](http://dot.net/ml) 中提供了成熟的 .NET 原生实现。
36+
37+
## 安装指南
38+
39+
FLAML 最新版本要求 **Python >= 3.10 且 < 3.14**。虽然其他 Python 版本可能支持核心组件运行，但无法保证全部模型的完整兼容性。可通过 `pip` 直接安装：
40+
41+
```bash
42+
pip install flaml
43+
```
44+
45+
默认情况下仅安装最基础的轻量依赖。您可以根据所需的功能按需安装扩展选项。例如，若需使用 [`automl`](https://microsoft.github.io/FLAML/docs/Use-Cases/Task-Oriented-AutoML) 模块所需的全部依赖，请执行：
46+
47+
```bash
48+
pip install "flaml[automl]"
49+
```
50+
51+
查阅更多安装选项请见[安装文档 (Installation)](https://microsoft.github.io/FLAML/docs/Installation)。各类[示例 Notebook](https://github.com/microsoft/FLAML/tree/main/notebook) 可能需要安装对应的特定扩展组件。
52+
53+
## 快速上手
54+
55+
- **三行代码即可运行**：作为 [scikit-learn 风格评估器](https://microsoft.github.io/FLAML/docs/Use-Cases/Task-Oriented-AutoML) 体验高效、经济的 AutoML 引擎：
56+
57+
```python
58+
from flaml import AutoML
59+
60+
automl = AutoML()
61+
automl.fit(X_train, y_train, task="classification")
62+
```
63+
64+
- **限定基学习器**：将 FLAML 作为 XGBoost、LightGBM、随机森林（Random Forest）等模型的极速调参工具，或配合[自定义评估器](https://microsoft.github.io/FLAML/docs/Use-Cases/Task-Oriented-AutoML#estimator-and-search-space)使用：
65+
66+
```python
67+
automl.fit(X_train, y_train, task="classification", estimator_list=["lgbm"])
68+
```
69+
70+
- **通用自定义函数调优**：针对任意[用户自定义函数 (UDF)](https://microsoft.github.io/FLAML/docs/Use-Cases/Tune-User-Defined-Function) 运行通用超参数调优：
71+
72+
```python
73+
from flaml import tune
74+
75+
tune.run(
76+
evaluation_function, config={...}, low_cost_partial_config={...}, time_budget_s=3600
77+
)
78+
```
79+
80+
- [零样本 AutoML (Zero-shot AutoML)](https://microsoft.github.io/FLAML/docs/Use-Cases/Zero-Shot-AutoML) 允许直接沿用 lightgbm、xgboost 等现有原生训练 API，同时享受 AutoML 在各具体任务上自动精选的高性能超参数配置：
81+
82+
```python
83+
from flaml.default import LGBMRegressor
84+
85+
# 像平时使用 lightgbm.LGBMRegressor 一样直接使用 LGBMRegressor
86+
estimator = LGBMRegressor()
87+
# 超参数将根据输入的训练数据特征自动进行最优配置
88+
estimator.fit(X_train, y_train)
89+
```
90+
91+
## 文档指引
92+
93+
查阅 FLAML 的详尽官方文档请前往 [此处官方站点](https://microsoft.github.io/FLAML/)。
94+
95+
此外，您还可以了解：
96+
97+
- 围绕 FLAML 的[学术论文 (Research)](https://microsoft.github.io/FLAML/docs/Research) 与[技术博客 (Blogposts)](https://microsoft.github.io/FLAML/blog)。
98+
99+
- 加入官方 [Discord 交流社区](https://discord.gg/Cppx2vSPVP)。
100+
101+
- 查阅[开发者贡献指南 (Contributing Guide)](https://microsoft.github.io/FLAML/docs/Contribute)。
102+
103+
- ML.NET 相关文档与教程：[Model Builder 模型生成器](https://learn.microsoft.com/zh-cn/dotnet/machine-learning/tutorials/predict-prices-with-model-builder)、[ML.NET CLI 命令行](https://learn.microsoft.com/zh-cn/dotnet/machine-learning/tutorials/sentiment-analysis-cli) 以及 [AutoML API 接口指南](https://learn.microsoft.com/zh-cn/dotnet/machine-learning/how-to-guides/how-to-use-the-automl-api)。
104+
105+
## 参与贡献
106+
107+
本项目非常欢迎开源社区的贡献与建议。绝大多数贡献都需要您签署贡献者许可协议（CLA），声明您有权且确实授予我们使用您贡献内容的权利。详情请访问：<https://cla.opensource.microsoft.com>。
108+
109+
如果您刚接触 GitHub，[此处](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests)提供了关于参与 GitHub 开源协同开发的详尽指南。
110+
111+
当您提交 Pull Request 时，CLA 机器人将自动核验您是否需要签署 CLA，并在 PR 中进行相应的状态标识（如状态检查与评论提示）。只需根据机器人的提示完成确认即可。在所有采用微软 CLA 的代码仓库中，此步骤仅需签署一次。
112+
113+
本项目遵循 [Microsoft 开源行为准则](https://opensource.microsoft.com/codeofconduct/)。欲了解更多信息，请查阅[行为准则常见问题解答 (FAQ)](https://opensource.microsoft.com/codeofconduct/faq/)，如有其他疑问或建议，亦可联系 [opencode@microsoft.com](mailto:opencode@microsoft.com)。
114+
115+
## 贡献者墙
116+
117+
<a href="https://github.com/microsoft/flaml/graphs/contributors">
118+
<img src="https://contrib.rocks/image?repo=microsoft/flaml&max=204" />
119+
</a>
120+
121+
______________________________________________________________________
122+
123+
> 💡 **文档维护说明**：本中文文档由社区志愿者（@JasonYeYuhe）翻译维护，最后同步更新于 2026年09月16日。如发现内容与官方英文原版存在差异或新特性滞后，欢迎提交 PR 共同完善！

0 commit comments

Comments
 (0)