From a6d6c44c6fd23ace3958169be4505247718231cd Mon Sep 17 00:00:00 2001 From: Miao Zheng <76149310+MeowZheng@users.noreply.github.com> Date: Thu, 16 Jun 2022 13:24:03 +0800 Subject: [PATCH] [Docs] Fix mdformat version to support python3.6 and remove ruby install (#1672) * [Docs] Fix mdformat version to support python3.6 and remove ruby install * fix lint --- .github/workflows/lint.yml | 3 --- .pre-commit-config.yaml | 4 ++-- docs/zh_cn/get_started.md | 46 +++++++++++++++++++------------------- docs/zh_cn/useful_tools.md | 18 +++++++-------- 4 files changed, 34 insertions(+), 37 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 7f7a309280..a4d7baf7a1 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -21,9 +21,6 @@ jobs: pre-commit install - name: Linting run: | - sudo apt-add-repository ppa:brightbox/ruby-ng -y - sudo apt-get update - sudo apt-get install -y ruby2.7 pre-commit run --all-files - name: Check docstring coverage run: | diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d38d7e83f7..884f5cd1e9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -25,12 +25,12 @@ repos: - id: mixed-line-ending args: ["--fix=lf"] - repo: https://github.com/executablebooks/mdformat - rev: 0.7.14 + rev: 0.7.9 hooks: - id: mdformat args: ["--number"] additional_dependencies: - - mdformat-gfm + - mdformat-openmmlab - mdformat_frontmatter - linkify-it-py - repo: https://github.com/codespell-project/codespell diff --git a/docs/zh_cn/get_started.md b/docs/zh_cn/get_started.md index 642d24c3c3..c671ac67e2 100644 --- a/docs/zh_cn/get_started.md +++ b/docs/zh_cn/get_started.md @@ -9,29 +9,29 @@ 可编译的 MMSegmentation 和 MMCV 版本如下所示，请对照对应版本安装以避免安装问题。 -| MMSegmentation 版本 | MMCV 版本 | MMClassification 版本 | -| :---------------: | :-------------------------: | :---------------------: | -| master | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | -| 0.24.1 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | -| 0.23.0 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | -| 0.22.0 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | -| 0.21.1 | mmcv-full>=1.4.4, \<=1.6.0 | Not required | -| 0.20.2 | mmcv-full>=1.3.13, \<=1.6.0 | Not required | -| 0.19.0 | mmcv-full>=1.3.13, \<1.3.17 | Not required | -| 0.18.0 | mmcv-full>=1.3.13, \<1.3.17 | Not required | -| 0.17.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | -| 0.16.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | -| 0.15.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | -| 0.14.1 | mmcv-full>=1.3.7, \<1.3.17 | Not required | -| 0.14.0 | mmcv-full>=1.3.1, \<1.3.2 | Not required | -| 0.13.0 | mmcv-full>=1.3.1, \<1.3.2 | Not required | -| 0.12.0 | mmcv-full>=1.1.4, \<1.3.2 | Not required | -| 0.11.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | -| 0.10.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | -| 0.9.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | -| 0.8.0 | mmcv-full>=1.1.4, \<1.2.0 | Not required | -| 0.7.0 | mmcv-full>=1.1.2, \<1.2.0 | Not required | -| 0.6.0 | mmcv-full>=1.1.2, \<1.2.0 | Not required | +| MMSegmentation 版本 | MMCV 版本 | MMClassification 版本 | +| :-----------------: | :-------------------------: | :---------------------: | +| master | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | +| 0.24.1 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | +| 0.23.0 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | +| 0.22.0 | mmcv-full>=1.4.4, \<=1.6.0 | mmcls>=0.20.1, \<=1.0.0 | +| 0.21.1 | mmcv-full>=1.4.4, \<=1.6.0 | Not required | +| 0.20.2 | mmcv-full>=1.3.13, \<=1.6.0 | Not required | +| 0.19.0 | mmcv-full>=1.3.13, \<1.3.17 | Not required | +| 0.18.0 | mmcv-full>=1.3.13, \<1.3.17 | Not required | +| 0.17.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | +| 0.16.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | +| 0.15.0 | mmcv-full>=1.3.7, \<1.3.17 | Not required | +| 0.14.1 | mmcv-full>=1.3.7, \<1.3.17 | Not required | +| 0.14.0 | mmcv-full>=1.3.1, \<1.3.2 | Not required | +| 0.13.0 | mmcv-full>=1.3.1, \<1.3.2 | Not required | +| 0.12.0 | mmcv-full>=1.1.4, \<1.3.2 | Not required | +| 0.11.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | +| 0.10.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | +| 0.9.0 | mmcv-full>=1.1.4, \<1.3.0 | Not required | +| 0.8.0 | mmcv-full>=1.1.4, \<1.2.0 | Not required | +| 0.7.0 | mmcv-full>=1.1.2, \<1.2.0 | Not required | +| 0.6.0 | mmcv-full>=1.1.2, \<1.2.0 | Not required | 注意: 如果您已经安装好 mmcv， 您首先需要运行 `pip uninstall mmcv`。 如果 mmcv 和 mmcv-full 同时被安装，会报错 `ModuleNotFoundError`。 diff --git a/docs/zh_cn/useful_tools.md b/docs/zh_cn/useful_tools.md index 6d76c6168c..d6a498696f 100644 --- a/docs/zh_cn/useful_tools.md +++ b/docs/zh_cn/useful_tools.md @@ -126,15 +126,15 @@ python tools/deploy_test.py \ #### 结果和模型 -| 模型 | 配置文件 | 数据集 | 评价指标 | PyTorch | ONNXRuntime | TensorRT-fp32 | TensorRT-fp16 | -| :--------: | :---------------------------------------------: | :--------: | :--: | :-----: | :---------: | :-----------: | :-----------: | -| FCN | fcn_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 72.2 | 72.2 | 72.2 | 72.2 | -| PSPNet | pspnet_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 77.8 | 77.8 | 77.8 | 77.8 | -| deeplabv3 | deeplabv3_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 79.0 | 79.0 | 79.0 | 79.0 | -| deeplabv3+ | deeplabv3plus_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 79.6 | 79.5 | 79.5 | 79.5 | -| PSPNet | pspnet_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.2 | 78.1 | | | -| deeplabv3 | deeplabv3_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.5 | 78.3 | | | -| deeplabv3+ | deeplabv3plus_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.9 | 78.7 | | | +| 模型 | 配置文件 | 数据集 | 评价指标 | PyTorch | ONNXRuntime | TensorRT-fp32 | TensorRT-fp16 | +| :--------: | :---------------------------------------------: | :--------: | :------: | :-----: | :---------: | :-----------: | :-----------: | +| FCN | fcn_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 72.2 | 72.2 | 72.2 | 72.2 | +| PSPNet | pspnet_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 77.8 | 77.8 | 77.8 | 77.8 | +| deeplabv3 | deeplabv3_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 79.0 | 79.0 | 79.0 | 79.0 | +| deeplabv3+ | deeplabv3plus_r50-d8_512x1024_40k_cityscapes.py | cityscapes | mIoU | 79.6 | 79.5 | 79.5 | 79.5 | +| PSPNet | pspnet_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.2 | 78.1 | | | +| deeplabv3 | deeplabv3_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.5 | 78.3 | | | +| deeplabv3+ | deeplabv3plus_r50-d8_769x769_40k_cityscapes.py | cityscapes | mIoU | 78.9 | 78.7 | | | **注意**: TensorRT 仅在使用 `whole mode` 测试模式时的配置文件里可用。