[Docs] Temporarily skip errors in building pdf docs at readthedocs (#928)

* temporarily skip readthedocs errors in building pdf docs

* fix error links

* remove useless links

* fix

* fix broken links as github url

* Update docs/zh_cn/notes/contributing.md

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
This commit is contained in:
Qian Zhao 2023-02-14 16:55:35 +08:00 committed by GitHub
parent c59899a65a
commit 30fe410b17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 8 additions and 7 deletions

View File

@ -1,6 +1,7 @@
version: 2
formats: all
formats:
- epub
python:
version: 3.7

View File

@ -4,7 +4,7 @@ Test time augmentation (TTA) is a data augmentation strategy used during the tes
The core implementation of TTA is usually divided into two parts
1. Data augmentation: This part is implemented in MMCV, see the api docs [TestTimeAug](mmcv.transform.TestTimeAug) for more information.
1. Data augmentation: This part is implemented in MMCV, see the api docs [TestTimeAug](mmcv.transforms.TestTimeAug) for more information.
2. Merge the predictions: The subclasses of `BaseTTAModel` will merge the predictions of enhanced data in the `test_step` method to improve the accuracy of predictions.
## Get started

View File

@ -214,11 +214,11 @@ We use the following tools for linting and formatting:
- [mdformat](https://github.com/executablebooks/mdformat): Mdformat is an opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files.
- [docformatter](https://github.com/myint/docformatter): A formatter to format docstring.
Style configurations of yapf and isort can be found in [setup.cfg](../../../setup.cfg).
Style configurations of yapf and isort can be found in [setup.cfg](https://github.com/open-mmlab/mmengine/blob/main/setup.cfg).
We use [pre-commit hook](https://pre-commit.com/) that checks and formats for `flake8`, `yapf`, `isort`, `trailing whitespaces`, `markdown files`,
fixes `end-of-files`, `double-quoted-strings`, `python-encoding-pragma`, `mixed-line-ending`, sorts `requirments.txt` automatically on every commit.
The config for a pre-commit hook is stored in [.pre-commit-config](../../../.pre-commit-config.yaml).
The config for a pre-commit hook is stored in [.pre-commit-config](https://github.com/open-mmlab/mmengine/blob/main/.pre-commit-config.yaml).
## PR Specs

View File

@ -4,7 +4,7 @@
TTA 的核心实现通常分为两个部分:
1. 测试时的数据增强:测试时数据增强主要在 MMCV 中实现,可以参考 [TestTimeAug 的 API 文档](mmcv.transform.TestTimeAug),本文档不再赘述。
1. 测试时的数据增强:测试时数据增强主要在 MMCV 中实现,可以参考 [TestTimeAug 的 API 文档](mmcv.transforms.TestTimeAug),本文档不再赘述。
2. 模型推理以及结果融合:`BaseTTAModel` 的主要功能就是实现这一部分,`BaseTTAModel.test_step` 会解析测试时增强后的数据并进行推理。用户继承 `BaseTTAModel` 后只需实现相应的融合策略即可。
## 快速上手

View File

@ -224,10 +224,10 @@ make html
- [mdformat](https://github.com/executablebooks/mdformat): 检查 markdown 文件的工具
- [docformatter](https://github.com/myint/docformatter): 格式化 docstring 的工具
yapf 和 isort 的配置可以在 [setup.cfg](../../../setup.cfg) 找到
yapf 和 isort 的配置可以在 [setup.cfg](https://github.com/open-mmlab/mmengine/blob/main/setup.cfg) 找到
通过配置 [pre-commit hook](https://pre-commit.com/) ,我们可以在提交代码时自动检查和格式化 `flake8``yapf``isort``trailing whitespaces``markdown files`,修复 `end-of-files``double-quoted-strings``python-encoding-pragma``mixed-line-ending`,调整 `requirments.txt` 的包顺序。
pre-commit 钩子的配置可以在 [.pre-commit-config](../../../.pre-commit-config.yaml) 找到。
pre-commit 钩子的配置可以在 [.pre-commit-config](https://github.com/open-mmlab/mmengine/blob/main/.pre-commit-config-zh-cn.yaml) 找到。
pre-commit 具体的安装使用方式见[拉取请求](#2-配置-pre-commit)。