From db861f30487c9a0b0cb3e35e176d6058887660bc Mon Sep 17 00:00:00 2001 From: Yixiao Fang <36138628+fangyixiao18@users.noreply.github.com> Date: Sun, 25 Jun 2023 10:30:27 +0800 Subject: [PATCH] Update issue template and ut (#750) * update issue template and ut * update ut requirements * update docs * update --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 4 ++-- docs/en/get_started.md | 11 ++--------- docs/zh_cn/get_started.md | 11 ++--------- requirements/tests.txt | 2 +- tests/test_models/test_algorithms/test_beitv1.py | 2 +- tests/test_models/test_algorithms/test_beitv2.py | 2 +- 6 files changed, 9 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index 4d3e51fa..a6df8a24 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -19,8 +19,8 @@ body: label: Branch description: Which branch/version are you using? options: - - master branch (0.x version, such as `v0.10.0`, or `dev` branch) - - 1.x branch (1.x version, such as `v1.0.0rc2`, or `dev-1.x` branch) + - main branch (1.x version) + - 0.x branch validations: required: true diff --git a/docs/en/get_started.md b/docs/en/get_started.md index ba83919c..7c863346 100644 --- a/docs/en/get_started.md +++ b/docs/en/get_started.md @@ -62,7 +62,7 @@ We recommend users to follow our best practices to install MMSelfSup. However, t ```shell pip install -U openmim mim install mmengine -mim install 'mmcv>=2.0.0rc1' +mim install 'mmcv>=2.0.0' ``` **Step 1.** Install MMSelfSup. @@ -79,25 +79,18 @@ In this case, install mmselfsup from source: ```shell git clone https://github.com/open-mmlab/mmselfsup.git cd mmselfsup -git checkout 1.x pip install -v -e . # "-v" means verbose, or more output # "-e" means installing a project in editable mode, # thus any local modifications made to the code will take effect without reinstallation. ``` -Optionally, if you want to [contribute](https://github.com/open-mmlab/mmselfsup/blob/main/docs/en/notes/contribution_guide.md) to MMSelfSup or experience experimental functions, please checkout to the `dev-1.x` branch: - -```shell -git checkout dev-1.x -``` - #### Install as a Python package Just install with pip. ```shell -pip install 'mmselfsup>=1.0.0rc0' +pip install 'mmselfsup>=1.0.0' ``` ### Verify the installation diff --git a/docs/zh_cn/get_started.md b/docs/zh_cn/get_started.md index ac9d2253..b94a81ff 100644 --- a/docs/zh_cn/get_started.md +++ b/docs/zh_cn/get_started.md @@ -62,7 +62,7 @@ conda install pytorch torchvision cpuonly -c pytorch ```shell pip install -U openmim mim install mmengine -mim install 'mmcv>=2.0.0rc1' +mim install 'mmcv>=2.0.0' ``` **步骤 1.** 安装 MMSelfSup。 @@ -79,25 +79,18 @@ mim install 'mmcv>=2.0.0rc1' ```shell git clone https://github.com/open-mmlab/mmselfsup.git cd mmselfsup -git checkout 1.x pip install -v -e . # "-v" 表示详细，或更多输出 # "-e" 表示以可编辑模式安装项目， # 因此，对代码所做的任何本地修改都将生效，无需重新安装。 ``` -或者，如果您想为 MMSelfSup 做出[贡献](https://github.com/open-mmlab/mmselfsup/blob/main/docs/zh_cn/notes/contribution_guides.md)或体验其正在实验中的功能，请查看 `dev-1.x` 分支： - -```shell -git checkout dev-1.x -``` - #### 作为 Python 包安装 直接用 pip 安装： ```shell -pip install 'mmselfsup>=1.0.0rc0' +pip install 'mmselfsup>=1.0.0' ``` ### 验证安装 diff --git a/requirements/tests.txt b/requirements/tests.txt index 7a1ec41a..65808d0c 100644 --- a/requirements/tests.txt +++ b/requirements/tests.txt @@ -1,5 +1,5 @@ asynctest -codecov +coverage flake8 interrogate isort==5.10.1 diff --git a/tests/test_models/test_algorithms/test_beitv1.py b/tests/test_models/test_algorithms/test_beitv1.py index d981f032..e3bc7752 100644 --- a/tests/test_models/test_algorithms/test_beitv1.py +++ b/tests/test_models/test_algorithms/test_beitv1.py @@ -9,7 +9,7 @@ from mmselfsup.models import BEiT from mmselfsup.structures import SelfSupDataSample data_preprocessor = dict( - type='TwoNormDataPreprocessor', + type='mmselfsup.TwoNormDataPreprocessor', mean=(123.675, 116.28, 103.53), std=(58.395, 57.12, 57.375), second_mean=(-20.4, -20.4, -20.4), diff --git a/tests/test_models/test_algorithms/test_beitv2.py b/tests/test_models/test_algorithms/test_beitv2.py index c02178bf..2b36ea59 100644 --- a/tests/test_models/test_algorithms/test_beitv2.py +++ b/tests/test_models/test_algorithms/test_beitv2.py @@ -9,7 +9,7 @@ from mmselfsup.models import BEiT from mmselfsup.structures import SelfSupDataSample data_preprocessor = dict( - type='TwoNormDataPreprocessor', + type='mmselfsup.TwoNormDataPreprocessor', mean=(123.675, 116.28, 103.53), std=(58.395, 57.12, 57.375), second_mean=(127.5, 127.5, 127.5),