Skip to content

Commit 9c3da77

Browse files
committed
Update cross refs
1 parent aeb89f9 commit 9c3da77

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/source/locale/zh_CN/tutorial/tutorial_part2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Linux 系统(如 Ubuntu)下安装 EvoX 相对直接,大部分情况下可
9393
pip install evox[vis,neuroevolution]
9494
```
9595

96-
这将同时安装可视化模块和 Brax 等神经进化相关依赖 ([EvoX Installation Guide — EvoX documentation](https://evox.readthedocs.io/en/latest/guide/install/install.html#:~:text=You%20can%20also%20assign%20extra,features%2C%20run%20the%20following%20command))。您也可以根据需要选择 extras,比如只安装 `vis``neuroevolution`
96+
这将同时安装可视化模块和 Brax 等神经进化相关依赖 ([EvoX Installation Guide](#EvoX Installation Guide))。您也可以根据需要选择 extras,比如只安装 `vis` 或 `neuroevolution`。
9797

9898
#### 使用容器安装 (Docker, Podman)
9999

@@ -119,7 +119,7 @@ docker run -it --gpus all --shm-size=8g pytorch/pytorch:rocm5.4_ubuntu20.04
119119
print(get_pretty_env_info())
120120
```
121121

122-
该代码将打印出 PyTorch 和系统的环境配置,如果包含 EvoX 并且没有错误信息,说明安装成功 ([EvoX Installation Guide — EvoX documentation](https://evox.readthedocs.io/en/latest/guide/install/install.html#:~:text=Verify%20the%20installation))。您也可以尝试 `import evox; print(evox.__version__)` 查看EvoX版本号,确认无误。
122+
该代码将打印出 PyTorch 和系统的环境配置,如果包含 EvoX 并且没有错误信息,说明安装成功。您也可以尝试 `import evox; print(evox.__version__)` 查看EvoX版本号,确认无误。
123123

124124
- **其他环境配置**:根据需要,您可以调整线程数等影响性能的参数。例如,设置环境变量 `OMP_NUM_THREADS` 控制CPU上并行线程数, 增加共享内存(`--shm-size`)避免 Docker 容器内的内存不足等。如果您使用 Jupyter Notebook 或 PyCharm 等 IDE 进行开发,请确保其 Interpreter 使用的是刚安装 EvoX 的 Python 环境。
125125

docs/source/locale/zh_CN/tutorial/tutorial_part5.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ import evox
257257
help(evox.algorithms.so.PSO)
258258
```
259259

260-
  这将显示 PSO 算法的文档字符串和参数说明。此外,您也可以查阅 EvoX 在线文档中的对应部分查看这些信息 ([API Reference/algorithms - Evox · Documentation](https://evox.readthedocs.io/en/latest/apidocs/evox/evox.algorithms.html))。
260+
  这将显示 PSO 算法的文档字符串和参数说明。此外,您也可以查阅 EvoX 在线文档中的对应部分查看这些信息 ([API Reference/algorithms - Evox · Documentation](#apidocs))。
261261

262262
**(2)问题模块** (`evox.problems`)
263263
  EvoX 的问题模块同样分类别进行了组织,涵盖了数值优化、神经进化、超参数优化等多种场景。
@@ -306,7 +306,7 @@ neuroevolution_problem = BraxProblem(
306306
)
307307
```
308308

309-
- `evox.problems.hpo_wrapper` 则提供了对机器学习训练过程的封装,适用于超参数优化任务(完整实例可参考 EvoX 文档 ([HPO example - EvoX Documentation](https://evox.readthedocs.io/en/latest/guide/user/3-hpo.html))。
309+
- `evox.problems.hpo_wrapper` 则提供了对机器学习训练过程的封装,适用于超参数优化任务(完整实例可参考 EvoX 文档 ([HPO example - EvoX Documentation](#Deploy HPO with Custom Algorithms))。
310310

311311
```python
312312
import torch
@@ -340,7 +340,7 @@ hpo_problem = HPOProblemWrapper(
340340
)
341341
```
342342

343-
  使用这些模块时,建议配合官方文档来了解对应问题类的构造参数。有的复杂问题可能需要提供额外数据,例如某些工程问题需要读入数据集或者设定实例规模。EvoX的API部分([API Reference/problems - EvoX Documentation](https://evox.readthedocs.io/en/latest/apidocs/evox/evox.problems.html))有详细说明。利用好这些现有API,可以大大减少自己编码的工作量。
343+
  使用这些模块时,建议配合官方文档来了解对应问题类的构造参数。有的复杂问题可能需要提供额外数据,例如某些工程问题需要读入数据集或者设定实例规模。EvoX的API部分([API Reference/problems - EvoX Documentation](#apidocs))有详细说明。利用好这些现有API,可以大大减少自己编码的工作量。
344344

345345
### 5.2.2 工作流与工具 API
346346

@@ -419,9 +419,9 @@ print(dir(evox.algorithms))
419419

420420
  当您在使用过程中需要寻求帮助时,EvoX 也提供了丰富的资源支持:
421421

422-
- **在线文档**:EvoX 提供详细的用户指南和 API 参考文档([EvoX Documentation](https://evox.readthedocs.io/en/latest/index.html)),涵盖了从基础到高级的各类主题。如果您遇到问题,可以查阅文档中的 `Developer Guide``API Reference` 等部分。
422+
- **在线文档**:EvoX 提供详细的用户指南和 API 参考文档([EvoX Documentation](#apidocs)),涵盖了从基础到高级的各类主题。如果您遇到问题,可以查阅文档中的 `Developer Guide``API Reference` 等部分。
423423
- **社区支持**:您可以通过 EvoX 的 GitHub 仓库([EvoX Github](https://github.com/EMI-Group/evox))提交 Issues,或在相关论坛和 QQ 讨论群 (ID: 297969717)中寻求帮助。
424-
- **示例代码**:对于初学者,多参考官方示例是快速掌握 API 用法的有效途径。EvoX 官方文档的 `examples` 目录中包含了许多示例脚本([Examples - EvoX Documentation](https://evox.readthedocs.io/en/latest/example/index.html)),您可以克隆仓库并运行这些脚本,边看代码边理解。
424+
- **示例代码**:对于初学者,多参考官方示例是快速掌握 API 用法的有效途径。EvoX 官方文档的 `examples` 目录中包含了许多示例脚本([Examples - EvoX Documentation](#examples)),您可以克隆仓库并运行这些脚本,边看代码边理解。
425425

426426
```
427427
掌握EvoX API的使用将使您更自如地实现复杂的功能。例如,您可以通过API组合来实现多层优化:外层用EvoX优化内层算法的参数,实现AutoML中的自动算法配置。这种高级应用需要对EvoX API非常熟练,但从技术上完全可行。我们鼓励您在逐步深入学习后尝试创新性地运用这些接口,打造出适合自己场景的优化方案。

0 commit comments

Comments
 (0)