From 2a741477fe295fa658aa308323e93c06f1dd177d Mon Sep 17 00:00:00 2001 From: Fengzhe Zhou Date: Wed, 13 Mar 2024 11:01:35 +0800 Subject: [PATCH] update links and checkers (#890) --- .github/workflows/link-check.yml | 6 +++++- docs/en/advanced_guides/code_eval_service.md | 2 +- docs/en/advanced_guides/evaluation_turbomind.md | 2 +- docs/zh_cn/advanced_guides/code_eval_service.md | 2 +- docs/zh_cn/advanced_guides/evaluation_turbomind.md | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml index f8da4a53..e41b1bc4 100644 --- a/.github/workflows/link-check.yml +++ b/.github/workflows/link-check.yml @@ -14,4 +14,8 @@ jobs: - name: linkchecker run: | pip install linkchecker - linkchecker https://opencompass.readthedocs.io/ --no-robots -t 30 + linkchecker https://opencompass.readthedocs.io/ --no-robots -t 30 --no-warnings | + --ignore-url https://opencompass\.readthedocs\.io/.*/static/images/opencompass_logo\.svg | + --ignore-url https://opencompass\.readthedocs\.io/.*/_static/images/icon-menu-dots\.svg | + --ignore-url https://opencompass\.readthedocs\.io/policy | + --ignore-url https://opencompass\.readthedocs\.io/(en|zh_CN)/[0-9a-f]{40}/.* diff --git a/docs/en/advanced_guides/code_eval_service.md b/docs/en/advanced_guides/code_eval_service.md index 8ddd4af0..88c7ef35 100644 --- a/docs/en/advanced_guides/code_eval_service.md +++ b/docs/en/advanced_guides/code_eval_service.md @@ -117,7 +117,7 @@ Model inference and code evaluation services located in different machines which ### Collect Inference Results(Only for Humanevalx) In OpenCompass's tools folder, there is a script called `collect_code_preds.py` provided to process and collect the inference results after providing the task launch configuration file during startup along with specifying the working directory used corresponding to the task. -It is the same with `-r` option in `run.py`. More details can be referred through the [documentation](https://opencompass.readthedocs.io/en/latest/get_started.html#launch-evaluation). +It is the same with `-r` option in `run.py`. More details can be referred through the [documentation](https://opencompass.readthedocs.io/en/latest/get_started/quick_start.html#launching-evaluation). ```shell python tools/collect_code_preds.py [config] [-r latest] diff --git a/docs/en/advanced_guides/evaluation_turbomind.md b/docs/en/advanced_guides/evaluation_turbomind.md index 9ace22f5..0f08ffec 100644 --- a/docs/en/advanced_guides/evaluation_turbomind.md +++ b/docs/en/advanced_guides/evaluation_turbomind.md @@ -6,7 +6,7 @@ We now support evaluation of models accelerated by the [LMDeploy](https://github ### Install OpenCompass -Please follow the [instructions](https://opencompass.readthedocs.io/en/latest/get_started.html) to install the OpenCompass and prepare the evaluation datasets. +Please follow the [instructions](https://opencompass.readthedocs.io/en/latest/get_started/installation.html) to install the OpenCompass and prepare the evaluation datasets. ### Install LMDeploy diff --git a/docs/zh_cn/advanced_guides/code_eval_service.md b/docs/zh_cn/advanced_guides/code_eval_service.md index 9ed39d55..5017a52d 100644 --- a/docs/zh_cn/advanced_guides/code_eval_service.md +++ b/docs/zh_cn/advanced_guides/code_eval_service.md @@ -115,7 +115,7 @@ humanevalx_datasets = [ ### 收集推理结果（仅针对Humanevalx） -OpenCompass 在 `tools` 中提供了 `collect_code_preds.py` 脚本对推理结果进行后处理并收集，我们只需要提供启动任务时的配置文件，以及指定复用对应任务的工作目录，其配置与 `run.py` 中的 `-r` 一致，细节可参考[文档](https://opencompass.readthedocs.io/zh_CN/latest/get_started.html#id7)。 +OpenCompass 在 `tools` 中提供了 `collect_code_preds.py` 脚本对推理结果进行后处理并收集，我们只需要提供启动任务时的配置文件，以及指定复用对应任务的工作目录，其配置与 `run.py` 中的 `-r` 一致，细节可参考[文档](https://opencompass.readthedocs.io/zh-cn/latest/get_started/quick_start.html#id4)。 ```shell python tools/collect_code_preds.py [config] [-r latest] diff --git a/docs/zh_cn/advanced_guides/evaluation_turbomind.md b/docs/zh_cn/advanced_guides/evaluation_turbomind.md index f52142e1..3d1414d8 100644 --- a/docs/zh_cn/advanced_guides/evaluation_turbomind.md +++ b/docs/zh_cn/advanced_guides/evaluation_turbomind.md @@ -6,7 +6,7 @@ ### 安装 OpenCompass -请根据 OpenCompass [安装指南](https://opencompass.readthedocs.io/en/latest/get_started.html) 来安装算法库和准备数据集。 +请根据 OpenCompass [安装指南](https://opencompass.readthedocs.io/en/latest/get_started/installation.html) 来安装算法库和准备数据集。 ### 安装 LMDeploy