Optuna 示例

本页面包含使用 Optuna 编写的示例代码列表。

import optuna


def objective(trial):
    x = trial.suggest_float("x", -100, 100)
    return x ** 2


if __name__ == "__main__":
    study = optuna.create_study()
    # 优化将在评估1000次或3秒后结束。
    study.optimize(objective, n_trials=1000, timeout=3)
    print(f"最佳参数为 {study.best_params}，对应的值为 {study.best_value}")

[!注意] 如果您想快速启动基于内存存储的 Optuna Dashboard，请查看此示例。

[!提示] 没找到适合您的用例吗？ 常见问题解答 可能对您实现所需功能有所帮助。 在本示例仓库中，您还可以找到以下场景的示例：

1. 带有额外参数的目标函数，当您希望向目标函数传递除 trial 之外的其他参数时非常有用。

2. 使用采样器手动提供试验，当您希望强制某些参数被采样时非常有用。

3. 用于控制研究终止条件的回调函数，当您希望定义不同于 n_trials 或 timeout 的自定义终止条件时非常有用。

多样化问题设置示例

以下是对应设置的示例代码块的 URL。

[!重要] 欢迎提交 PR 添加更多真实世界中的示例或项目！

使用 Optuna 的 Docker 镜像运行？

我们大多数示例的 Docker 镜像都带有以 -dev 结尾的标签。例如，PyTorch 简单示例可以通过以下命令运行：

$ docker run --rm -v $(pwd):/prj -w /prj optuna/optuna:py3.11-dev python pytorch/pytorch_simple.py

此外，我们的可视化示例也可以通过在浏览器中打开 localhost:8888 来在 Jupyter Notebook 中运行，只需执行以下命令：

$ docker run -p 8888:8888 --rm optuna/optuna:py3.11-dev jupyter notebook --allow-root --no-browser --port 8888 --ip 0.0.0.0 --NotebookApp.token='' --NotebookApp.password=''

Optuna Examples 快速上手指南

本指南基于 optuna-examples 仓库，帮助中国开发者快速掌握 Optuna 超参数优化框架的核心用法。

1. 环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：推荐 Python 3.8 及以上版本
• 前置依赖：
  • pip 包管理工具
  • （可选）Docker：若希望使用官方镜像运行示例，无需本地安装 Python 环境。

国内加速建议： 在安装依赖时，推荐使用清华或阿里镜像源以提升下载速度：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple <package_name>

2. 安装步骤

方式一：本地安装（推荐）

安装 Optuna 核心库及常用依赖：

pip install optuna

若需运行特定机器学习框架的示例（如 PyTorch, LightGBM, Scikit-learn 等），请额外安装对应库。例如：

pip install scikit-learn lightgbm xgboost pytorch

方式二：使用 Docker 镜像

Optuna 提供了包含常用依赖的官方开发镜像（标签以 -dev 结尾）。无需本地配置环境即可直接运行示例代码。

# 拉取并运行示例（以 PyTorch 简单示例为例）
docker run --rm -v $(pwd):/prj -w /prj optuna/optuna:py3.11-dev python pytorch/pytorch_simple.py

3. 基本使用

以下是最简化的黑盒优化示例，展示了如何定义目标函数并启动优化研究。

最简代码示例

创建一个名为 simple_optimize.py 的文件，写入以下内容：

import optuna


def objective(trial):
    # 在 -100 到 100 之间采样浮点数 x
    x = trial.suggest_float("x", -100, 100)
    # 目标是最小化 x 的平方
    return x ** 2


if __name__ == "__main__":
    # 创建研究对象
    study = optuna.create_study()
    
    # 开始优化：最多尝试 1000 次 或 运行 3 秒后停止
    study.optimize(objective, n_trials=1000, timeout=3)
    
    # 输出最佳结果
    print(f"Best params is {study.best_params} with value {study.best_value}")

运行代码

在终端执行：

python simple_optimize.py

预期输出

程序将输出类似以下的最佳参数和最优值：

[I 2023-10-27 10:00:00,000] Trial 0 finished with value: 1234.56...
...
Best params is {'x': 0.054321} with value 0.00295...

进阶场景提示

optuna-examples 仓库涵盖了更多实际应用场景，您可以根据需求参考以下方向：

• 机器学习集成：内置 Scikit-learn, PyTorch, LightGBM, XGBoost, TensorFlow, Hugging Face Transformers 等框架的专用示例。
• 多目标优化：支持同时优化多个冲突目标（如准确率与模型大小）。
• 剪枝 (Pruning)：自动终止表现不佳的试验，节省计算资源（支持各类主流深度学习框架）。
• 分布式优化：支持在 Dask, Kubernetes, Ray 等集群环境下并行运行优化任务。
• 可视化与监控：可结合 Optuna Dashboard, MLflow, Weights & Biases 等工具追踪优化过程。