Ax 项目使用教程

Ax 项目使用教程

Ax Adaptive Experimentation Platform 项目地址: https://gitcode.com/gh_mirrors/ax2/Ax

1. 项目目录结构及介绍

Ax 项目是一个自适应实验平台，其目录结构如下：

• .github/：包含 GitHub 的工作流文件，如分支保护规则等。
• ax/：核心代码库，包含 Ax 平台的主要功能和模块。
• docs/：文档目录，存放项目的文档和教程。
• scripts/：脚本目录，包含项目构建和部署的脚本文件。
• sphinx/：用于构建文档的 Sphinx 项目文件。
• tutorials/：教程目录，包含项目使用教程和示例代码。
• website/：项目网站相关文件。
• .flake8：Python linter 配置文件。
• .gitignore：Git 忽略文件配置。
• .pre-commit-config.yaml：预提交钩子配置文件。
• .readthedocs.yaml：Read the Docs 配置文件。
• CHANGELOG.md：项目更新日志。
• CODE_OF_CONDUCT.md：项目行为准则。
• CONTRIBUTING.md：贡献指南。
• LICENSE：项目许可证。
• README.md：项目自述文件。
• pyproject.toml：Python 项目配置文件。
• pytest.ini：pytest 配置文件。
• requirements-fmt.txt：格式化的项目依赖文件。
• setup.py：项目设置文件，用于打包和分发。

2. 项目的启动文件介绍

项目的启动通常是通过 ax 目录中的 Python 模块进行的。例如，运行一个简单的优化循环，可以使用 optimize.py 文件：

from ax import optimize

best_parameters, best_values, experiment, model = optimize(
    parameters=[
        {"name": "x1", "type": "range", "bounds": [-10.0, 10.0]},
        {"name": "x2", "type": "range", "bounds": [-10.0, 10.0]},
    ],
    evaluation_function=lambda p: (p["x1"] + 2 * p["x2"] - 7) ** 2 + (2 * p["x1"] + p["x2"] - 5) ** 2,
    minimize=True,
)

这段代码定义了两个参数 x1 和 x2，它们的范围都是从 -10.0 到 10.0，然后定义了一个评估函数，并指定了要最小化评估函数。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 文件进行。这个文件包含了项目的元数据、依赖项和其他构建系统指令。例如：

[tool.poetry]
name = "ax-platform"
version = "0.1.0"
description = "Adaptive experimentation platform"
authors = ["Facebook, Inc."]

[tool.poetry.dependencies]
python = "^3.10"
botorch = "^0.2.1"
jinja2 = "^3.0"
pandas = "^1.3"
scipy = "^1.7"
sklearn = "^0.24"
plotly = "^2.2.1"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

在这个配置文件中，指定了项目名称、版本、描述和作者信息，同时也列出了项目的依赖项和开发依赖项。

以上是 Ax 项目的目录结构、启动文件和配置文件的介绍。使用前请确保正确安装了所有依赖项，并按照项目官方文档进行操作。

Ax Adaptive Experimentation Platform 项目地址: https://gitcode.com/gh_mirrors/ax2/Ax