[Doc] translate notes/changelog.md, contribution_guide.md, faq.md (#542)

* Update contribution_guides.md * Update contribution_guides.md * Update contribution_guides.md * Update faq.md * Update faq.md * Update faq.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * m * Update changelog.md * Update contribution_guides.md * Update contribution_guide.md * Update faq.md * Update faq.md * update * Update docs/zh_cn/notes/changelog.md * Update contribution_guides.md * Update contribution_guides.md * Update faq.md * Update contribution_guides.md Co-authored-by: Yixiao Fang <36138628+fangyixiao18@users.noreply.github.com>
2022-10-31 17:45:10 +08:00 · 2022-10-31 17:45:10 +08:00 · 8136a5c2cf
parent 0c873137d0
commit 8136a5c2cf
4 changed files with 390 additions and 170 deletions
--- a/docs/en/notes/contribution_guide.md
+++ b/docs/en/notes/contribution_guide.md
@ -31,7 +31,7 @@ git checkout -b xxxx # xxxx is the name of new branch
 3. Edit the related files follow the code style mentioned below
 4. Use **pre-commit hook** to check and format your changes.
 5. Commit your changes
-6. Create a PR with related information
+6. Create a PR to merge it into dev-1.x branch

 ```{note}
 If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
--- a/docs/zh_cn/notes/changelog.md
+++ b/docs/zh_cn/notes/changelog.md
@ -1,246 +1,372 @@
-# Changelog
+# 更新日志

 ## MMSelfSup

+### v1.0.0rc2 (12/10/2022)
+
+`master` 仍然是 0.x 版本，我们将会 checkout 一个新的 `1.x` 用来发布 1.x 版本。 未来我们会同时维护两个版本。
+
+我们简要的列出主要的改变。 请参考[迁移文档](../migration.md)来查看细节和迁移指引
+
+#### 亮点
+
+- 全量支持 `MAE`, `SimMIM`, `MoCoV3`.
+
+#### 新特性
+
+- 全量支持 `MAE` ([#483](https://github.com/open-mmlab/mmselfsup/pull/483))
+- 全量支持 `SimMIM` ([#487](https://github.com/open-mmlab/mmselfsup/pull/487))
+- 全量支持 of `MoCoV3` ([#496](https://github.com/open-mmlab/mmselfsup/pull/496))
+
+#### 修复 Bug
+
+- 修复 classification configs ([#488](https://github.com/open-mmlab/mmselfsup/pull/488))
+- 修复 MAE config 中名字问题([#498](https://github.com/open-mmlab/mmselfsup/pull/498))
+
+#### 改进
+
+- 修改 colab 指引 ([#470](https://github.com/open-mmlab/mmselfsup/pull/470)))
+- 更新 readthedocs 要求 ([#472](https://github.com/open-mmlab/mmselfsup/pull/472))
+- 更新 CI ([#476](https://github.com/open-mmlab/mmselfsup/pull/476))
+- 优化 `mim_slurm_test.sh` 和 `mim_dist_test.sh` 为 benchmarks ([#477](https://github.com/open-mmlab/mmselfsup/pull/477))
+- 更新 Metafile format 和 content ([#478](https://github.com/open-mmlab/mmselfsup/pull/478))
+
+#### 文档
+
+- 添加 advanced_guides/engine.md ([#454](https://github.com/open-mmlab/mmselfsup/pull/454))
+- 添加 advanced_guides/evaluation.md ([#456](https://github.com/open-mmlab/mmselfsup/pull/456))
+- 添加 advanced_guides/transforms.md ([#463](https://github.com/open-mmlab/mmselfsup/pull/463))
+- 添加 dataset docs ([#437](https://github.com/open-mmlab/mmselfsup/pull/437))
+- 优化 contribution guide ([#492](https://github.com/open-mmlab/mmselfsup/pull/492))
+- 更新 convention ([#475](https://github.com/open-mmlab/mmselfsup/pull/475))
+
+### v1.0.0rc1 (01/09/2022)
+
+我们很高兴宣布发布 MMSelfSup v1.0.0rc1。
+We are excited to announce the release of MMSelfSup v1.0.0rc1. MMSelfSup v1.0.0rc1 是 MMSelfSup 1.x 的第一个版本，是 OpenMMLab 2.0 项目中的一部分。
+`master` 仍然是 0.x 版本，我们将会 checkout 一个新的 `1.x` 用来发布 1.x 版本。 未来我们会同时维护两个版本。
+
+我们简要的列出主要的改变。 请参考[迁移文档](../migration.md)来查看细节和迁移指引
+
+#### 亮点
+
+- 基于 [MMEngine](https://github.com/open-mmlab/mmengine) 和 [MMCV](https://github.com/open-mmlab/mmcv).
+- 发布重构.
+  - Datasets
+  - Models
+  - Config
+  - ...
+- 优化所有文档.
+
+#### 新特性
+
+- 增加 `SelfSupDataSample` 来统一接口。
+- 增加 `SelfSupVisualizer` 可视化功能。
+- 增加 `SelfSupDataPreprocessor` 来进行模型的数据预处理。
+
+#### 改进
+
+- 大部分方法都支持非分布式方法。
+- 改变不同的数据增强的接口为 `dict`。
+- 使用MMCLassification运行下游分类任务。
+
+#### 文档
+
+- 优化所有文档和重新整理路径。
+- 为不同组件增加新的概念。
+
+## MMSelfSup
+
+### v0.10.0 (30/09/2022)
+
+#### 亮点
+
+- 支持 MaskFeat ([#485](https://github.com/open-mmlab/mmselfsup/pull/485))
+- 更新 README 宣传 1.0.0rc 版本 ([#474](https://github.com/open-mmlab/mmselfsup/pull/474))
+
+#### 新特性
+
+- 支持 MaskFeat ([#485](https://github.com/open-mmlab/mmselfsup/pull/485))
+
+#### Bug 修复
+
+- 修复 DenseCL 初始化的问题 ([#411](https://github.com/open-mmlab/mmselfsup/pull/411))
+- 修复配置文件中归一化的错误 ([#418](https://github.com/open-mmlab/mmselfsup/pull/418))
+- 修复读取图片的问题 ([#386](https://github.com/open-mmlab/mmselfsup/pull/386))
+
+#### 改进
+
+- 更新 hook_cfg 获取方式 ([#409](https://github.com/open-mmlab/mmselfsup/pull/409))
+- 支持输出配置文件 ([#410](https://github.com/open-mmlab/mmselfsup/pull/410))
+- 支持保存 MAE 可视化结果 ([#388](https://github.com/open-mmlab/mmselfsup/pull/388))
+- 删除废弃项的默认值 ([#490](https://github.com/open-mmlab/mmselfsup/pull/490))
+
+#### 文档
+
+- 更新 MAE 配置文件链接 ([#497](https://github.com/open-mmlab/mmselfsup/pull/497))
+- 更新 README 宣传 1.0.0rc 版本 ([#474](https://github.com/open-mmlab/mmselfsup/pull/474))
+- 更新 get_started 文档 ([#402](https://github.com/open-mmlab/mmselfsup/pull/402))
+
+### v0.9.2 (28/07/2022)
+
+#### 新特性
+
+- 支持 MAE 重建图像的可视化 ([#376](https://github.com/open-mmlab/mmselfsup/pull/376))
+
+#### Bug 修复
+
+- 修复 extract.py 文件中 cfg/args 路径问题，应用 cfg 中的路径进行处理 ([#357](https://github.com/open-mmlab/mmselfsup/pull/357))
+- 修复 SimMIM 配置文件中掩码生成器类型名称的错误 ([#360](https://github.com/open-mmlab/mmselfsup/pull/360))
+
+#### 改进
+
+- 更新 mdformat 设置 ([#323](https://github.com/open-mmlab/mmselfsup/pull/323))
+- 添加 circle ci 配置 ([#374](https://github.com/open-mmlab/mmselfsup/pull/374))
+
+#### 文档
+
+- 修复语言更换链接问题 ([#327](https://github.com/open-mmlab/mmselfsup/pull/327))
+- 更新 tutorials/4_schedule.md 中的文档链接([#354](https://github.com/open-mmlab/mmselfsup/pull/354))
+
 ### v0.9.1 (31/05/2022)

-#### Highlight
+#### 亮点

- Update **BYOL** model and results ([#319](https://github.com/open-mmlab/mmselfsup/pull/319))
- Refine some documentation
+- 更新 **BYOL** 模型和结果 ([#319](https://github.com/open-mmlab/mmselfsup/pull/319))
+- 改进部分文档

-#### New Features
+#### 新特性

- Update **BYOL** models and results ([#319](https://github.com/open-mmlab/mmselfsup/pull/319))
+- 更新 **BYOL** 模型和结果 ([#319](https://github.com/open-mmlab/mmselfsup/pull/319))

-#### Bug Fixes
+#### Bug 修复

- Set qkv bias to False for cae and True for mae ([#303](https://github.com/open-mmlab/mmselfsup/pull/303))
- Fix spelling errors in MAE config ([#307](https://github.com/open-mmlab/mmselfsup/pull/307))
+- 对于 CAE 和 MAE 设置 qkv 偏置参数 ([#303](https://github.com/open-mmlab/mmselfsup/pull/303))
+- 修复 MAE 配置文件拼写错误 ([#307](https://github.com/open-mmlab/mmselfsup/pull/307))

-#### Improvements
+#### 改进

- Change the file name of cosine annealing hook ([#304](https://github.com/open-mmlab/mmselfsup/pull/304))
- Replace markdownlint with mdformat ([#311](https://github.com/open-mmlab/mmselfsup/pull/311))
+- 修改文件名 ([#304](https://github.com/open-mmlab/mmselfsup/pull/304))
+- 应用 mdformat ([#311](https://github.com/open-mmlab/mmselfsup/pull/311))

-#### Docs
+#### 文档

- Fix typo in tutotial ([#308](https://github.com/open-mmlab/mmselfsup/pull/308))
- Configure Myst-parser to parse anchor tag ([#309](https://github.com/open-mmlab/mmselfsup/pull/309))
- Update readthedocs algorithm README ([#310](https://github.com/open-mmlab/mmselfsup/pull/310))
- Rewrite install.md ([#317](https://github.com/open-mmlab/mmselfsup/pull/317))
- refine README.md file ([#318](https://github.com/open-mmlab/mmselfsup/pull/318))
+- 改正教程中的打字错误 ([#308](https://github.com/open-mmlab/mmselfsup/pull/308))
+- 配置 Myst-parser ([#309](https://github.com/open-mmlab/mmselfsup/pull/309))
+- 更新文档算法简介 ([#310](https://github.com/open-mmlab/mmselfsup/pull/310))
+- 改进安装文档 ([#317](https://github.com/open-mmlab/mmselfsup/pull/317))
+- 改进首页 README ([#318](https://github.com/open-mmlab/mmselfsup/pull/318))

 ### v0.9.0 (29/04/2022)

-#### Highlight
+#### 亮点

- Support **CAE** ([#284](https://github.com/open-mmlab/mmselfsup/pull/284))
- Support **Barlow Twins** ([#207](https://github.com/open-mmlab/mmselfsup/pull/207))
+- 支持 **CAE** ([#284](https://github.com/open-mmlab/mmselfsup/pull/284))
+- 支持 **Barlow Twins** ([#207](https://github.com/open-mmlab/mmselfsup/pull/207))

-#### New Features
+#### 新特性

- Support CAE ([#284](https://github.com/open-mmlab/mmselfsup/pull/284))
- Support Barlow twins ([#207](https://github.com/open-mmlab/mmselfsup/pull/207))
- Add SimMIM 192 pretrain and 224 fine-tuning results ([#280](https://github.com/open-mmlab/mmselfsup/pull/280))
- Add MAE pretrain with fp16 ([#271](https://github.com/open-mmlab/mmselfsup/pull/271))
+- 支持 CAE ([#284](https://github.com/open-mmlab/mmselfsup/pull/284))
+- 支持 Barlow twins ([#207](https://github.com/open-mmlab/mmselfsup/pull/207))
+- 增加 SimMIM 192 预训练及 224 微调的结果 ([#280](https://github.com/open-mmlab/mmselfsup/pull/280))
+- 增加 MAE fp16 预训练设置 ([#271](https://github.com/open-mmlab/mmselfsup/pull/271))

-#### Bug Fixes
+#### Bug 修复

- Fix args error ([#290](https://github.com/open-mmlab/mmselfsup/pull/290))
- Change imgs_per_gpu to samples_per_gpu in MAE config ([#278](https://github.com/open-mmlab/mmselfsup/pull/278))
- Avoid GPU memory leak with prefetch dataloader ([#277](https://github.com/open-mmlab/mmselfsup/pull/277))
- Fix key error bug when registering custom hooks ([#273](https://github.com/open-mmlab/mmselfsup/pull/273))
+- 修复参数问题 ([#290](https://github.com/open-mmlab/mmselfsup/pull/290))
+- 在 MAE 配置中修改 imgs_per_gpu 为 samples_per_gpu ([#278](https://github.com/open-mmlab/mmselfsup/pull/278))
+- 使用 prefetch dataloader 时避免 GPU 内存溢出 ([#277](https://github.com/open-mmlab/mmselfsup/pull/277))
+- 修复在注册自定义钩子时键值错误的问题 ([#273](https://github.com/open-mmlab/mmselfsup/pull/273))

-#### Improvements
+#### 改进

- Update SimCLR models and results ([#295](https://github.com/open-mmlab/mmselfsup/pull/295))
- Reduce memory usage while running unit test ([#291](https://github.com/open-mmlab/mmselfsup/pull/291))
- Remove pytorch1.5 test ([#288](https://github.com/open-mmlab/mmselfsup/pull/288))
- Rename linear probing config file names ([#281](https://github.com/open-mmlab/mmselfsup/pull/281))
- add unit test for apis ([#276](https://github.com/open-mmlab/mmselfsup/pull/276))
+- 更新 SimCLR 模型和结果 ([#295](https://github.com/open-mmlab/mmselfsup/pull/295))
+- 单元测试减少内存使用 ([#291](https://github.com/open-mmlab/mmselfsup/pull/291))
+- 去除 pytorch 1.5 测试 ([#288](https://github.com/open-mmlab/mmselfsup/pull/288))
+- 重命名线性评估配置文件 ([#281](https://github.com/open-mmlab/mmselfsup/pull/281))
+- 为 api 增加单元测试 ([#276](https://github.com/open-mmlab/mmselfsup/pull/276))

-#### Docs
+#### 文档

- Fix SimMIM config link, and add SimMIM to model_zoo ([#272](https://github.com/open-mmlab/mmselfsup/pull/272))
+- 在模型库增加 SimMIM 并修复链接 ([#272](https://github.com/open-mmlab/mmselfsup/pull/272))

 ### v0.8.0 (31/03/2022)

-#### Highlight
+#### 亮点

- Support **SimMIM** ([#239](https://github.com/open-mmlab/mmselfsup/pull/239))
- Add **KNN** benchmark, support KNN test with checkpoint and extracted backbone weights ([#243](https://github.com/open-mmlab/mmselfsup/pull/243))
- Support ImageNet-21k dataset ([#225](https://github.com/open-mmlab/mmselfsup/pull/225))
+- 支持 **SimMIM** ([#239](https://github.com/open-mmlab/mmselfsup/pull/239))
+- 增加 **KNN** 基准测试，支持中间 checkpoint 和提取的 backbone 权重进行评估 ([#243](https://github.com/open-mmlab/mmselfsup/pull/243))
+- 支持 ImageNet-21k 数据集 ([#225](https://github.com/open-mmlab/mmselfsup/pull/225))

-#### New Features
+#### 新特性

- Support SimMIM ([#239](https://github.com/open-mmlab/mmselfsup/pull/239))
- Add KNN benchmark, support KNN test with checkpoint and extracted backbone weights ([#243](https://github.com/open-mmlab/mmselfsup/pull/243))
- Support ImageNet-21k dataset ([#225](https://github.com/open-mmlab/mmselfsup/pull/225))
- Resume latest checkpoint automatically ([#245](https://github.com/open-mmlab/mmselfsup/pull/245))
+- 支持 SimMIM ([#239](https://github.com/open-mmlab/mmselfsup/pull/239))
+- 增加 KNN 基准测试，支持中间 checkpoint 和提取的 backbone 权重进行评估 ([#243](https://github.com/open-mmlab/mmselfsup/pull/243))
+- 支持 ImageNet-21k 数据集 ([#225](https://github.com/open-mmlab/mmselfsup/pull/225))
+- 支持自动继续 checkpoint 文件的训练 ([#245](https://github.com/open-mmlab/mmselfsup/pull/245))

-#### Bug Fixes
+#### Bug 修复

- Add seed to distributed sampler ([#250](https://github.com/open-mmlab/mmselfsup/pull/250))
- Fix positional parameter error in dist_test_svm_epoch.sh ([#260](https://github.com/open-mmlab/mmselfsup/pull/260))
- Fix 'mkdir' error in prepare_voc07_cls.sh ([#261](https://github.com/open-mmlab/mmselfsup/pull/261))
+- 在分布式 sampler 中增加种子 ([#250](https://github.com/open-mmlab/mmselfsup/pull/250))
+- 修复 dist_test_svm_epoch.sh 中参数位置问题 ([#260](https://github.com/open-mmlab/mmselfsup/pull/260))
+- 修复 prepare_voc07_cls.sh 中 mkdir 潜在错误 ([#261](https://github.com/open-mmlab/mmselfsup/pull/261))

-#### Improvements
+#### 改进

- Update args format from command line ([#253](https://github.com/open-mmlab/mmselfsup/pull/253))
+- 更新命令行参数模式 ([#253](https://github.com/open-mmlab/mmselfsup/pull/253))

-#### Docs
+#### 文档

- Fix command errors in 6_benchmarks.md ([#263](https://github.com/open-mmlab/mmselfsup/pull/263))
- Translate 6_benchmarks.md to Chinese ([#262](https://github.com/open-mmlab/mmselfsup/pull/262))
+- 修复 6_benchmarks.md 中命令文档([#263](https://github.com/open-mmlab/mmselfsup/pull/263))
+- 翻译 6_benchmarks.md 到中文 ([#262](https://github.com/open-mmlab/mmselfsup/pull/262))

 ### v0.7.0 (03/03/2022)

-#### Highlight
+#### 亮点

- Support MAE ([#221](https://github.com/open-mmlab/mmselfsup/pull/221))
- Add Places205 benchmarks ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))
- Add test Windows in workflows ([#215](https://github.com/open-mmlab/mmselfsup/pull/215))
+- 支持 MAE 算法 ([#221](https://github.com/open-mmlab/mmselfsup/pull/221))
+- 增加 Places205 下游基准测试 ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))
+- 在 CI 工作流中添加 Windows 测试 ([#215](https://github.com/open-mmlab/mmselfsup/pull/215))

-#### New Features
+#### 新特性

- Support MAE ([#221](https://github.com/open-mmlab/mmselfsup/pull/221))
- Add Places205 benchmarks ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))
+- 支持 MAE 算法 ([#221](https://github.com/open-mmlab/mmselfsup/pull/221))
+- 增加 Places205 下游基准测试 ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))

-#### Bug Fixes
+#### Bug 修复

- Fix config typos for rotation prediction and deepcluster ([#200](https://github.com/open-mmlab/mmselfsup/pull/200))
- Fix image channel bgr/rgb bug and update benchmarks ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))
- Fix the bug when using prefetch under multi-view methods ([#218](https://github.com/open-mmlab/mmselfsup/pull/218))
- Fix tsne 'no init_cfg' error ([#222](https://github.com/open-mmlab/mmselfsup/pull/222))
+- 修复部分配置文件中的错误 ([#200](https://github.com/open-mmlab/mmselfsup/pull/200))
+- 修复图像读取通道问题并更新相关结果 ([#210](https://github.com/open-mmlab/mmselfsup/pull/210))
+- 修复在使用 prefetch 时，部分 dataset 输出格式不匹配的问题 ([#218](https://github.com/open-mmlab/mmselfsup/pull/218))
+- 修复 t-sne 'no init_cfg' 的错误 ([#222](https://github.com/open-mmlab/mmselfsup/pull/222))

-#### Improvements
+#### 改进

- Deprecate `imgs_per_gpu` and use `samples_per_gpu` ([#204](https://github.com/open-mmlab/mmselfsup/pull/204))
- Update the installation of MMCV ([#208](https://github.com/open-mmlab/mmselfsup/pull/208))
- Add pre-commit hook for algo-readme and copyright ([#213](https://github.com/open-mmlab/mmselfsup/pull/213))
- Add test Windows in workflows ([#215](https://github.com/open-mmlab/mmselfsup/pull/215))
+- 配置文件中弃用 `imgs_per_gpu`， 改用 `samples_per_gpu` ([#204](https://github.com/open-mmlab/mmselfsup/pull/204))
+- 更新 MMCV 的安装方式 ([#208](https://github.com/open-mmlab/mmselfsup/pull/208))
+- 为 算法 readme 和代码版权增加 pre-commit 钩子 ([#213](https://github.com/open-mmlab/mmselfsup/pull/213))
+- 在 CI 工作流中添加 Windows 测试 ([#215](https://github.com/open-mmlab/mmselfsup/pull/215))

-#### Docs
+#### 文档

- Translate 0_config.md into Chinese ([#216](https://github.com/open-mmlab/mmselfsup/pull/216))
- Reorganizing OpenMMLab projects and update algorithms in readme ([#219](https://github.com/open-mmlab/mmselfsup/pull/219))
+- 将 0_config.md 翻译成中文 ([#216](https://github.com/open-mmlab/mmselfsup/pull/216))
+- 更新主页 OpenMMLab 项目和介绍 ([#219](https://github.com/open-mmlab/mmselfsup/pull/219))

 ### v0.6.0 (02/02/2022)

-#### Highlight
+#### 亮点

- Support vision transformer based MoCo v3 ([#194](https://github.com/open-mmlab/mmselfsup/pull/194))
- Speed up training and start time ([#181](https://github.com/open-mmlab/mmselfsup/pull/181))
- Support cpu training ([#188](https://github.com/open-mmlab/mmselfsup/pull/188))
+- 支持基于 vision transformer 的 MoCo v3 ([#194](https://github.com/open-mmlab/mmselfsup/pull/194))
+- 加速训练和启动时间 ([#181](https://github.com/open-mmlab/mmselfsup/pull/181))
+- 支持 cpu 训练 ([#188](https://github.com/open-mmlab/mmselfsup/pull/188))

-#### New Features
+#### 新特性

- Support vision transformer based MoCo v3 ([#194](https://github.com/open-mmlab/mmselfsup/pull/194))
- Support cpu training ([#188](https://github.com/open-mmlab/mmselfsup/pull/188))
+- 支持基于 vision transformer 的 MoCo v3 ([#194](https://github.com/open-mmlab/mmselfsup/pull/194))
+- 支持 cpu 训练 ([#188](https://github.com/open-mmlab/mmselfsup/pull/188))

-#### Bug Fixes
+#### Bug 修复

- Fix issue ([#159](https://github.com/open-mmlab/mmselfsup/issues/159), [#160](https://github.com/open-mmlab/mmselfsup/issues/160)) related bugs ([#161](https://github.com/open-mmlab/mmselfsup/pull/161))
- Fix missing prob assignment in `RandomAppliedTrans` ([#173](https://github.com/open-mmlab/mmselfsup/pull/173))
- Fix bug of showing k-means losses ([#182](https://github.com/open-mmlab/mmselfsup/pull/182))
- Fix bug in non-distributed multi-gpu training/testing ([#189](https://github.com/open-mmlab/mmselfsup/pull/189))
- Fix bug when loading cifar dataset ([#191](https://github.com/open-mmlab/mmselfsup/pull/191))
- Fix `dataset.evaluate` args bug ([#192](https://github.com/open-mmlab/mmselfsup/pull/192))
+- 修复问题 ([#159](https://github.com/open-mmlab/mmselfsup/issues/159), [#160](https://github.com/open-mmlab/mmselfsup/issues/160)) 中提到的相关 bugs ([#161](https://github.com/open-mmlab/mmselfsup/pull/161))
+- 修复 `RandomAppliedTrans` 中缺失的 prob 赋值 ([#173](https://github.com/open-mmlab/mmselfsup/pull/173))
+- 修复 k-means losses 显示的 bug ([#182](https://github.com/open-mmlab/mmselfsup/pull/182))
+- 修复非分布式多 gpu 训练/测试中的 bug ([#189](https://github.com/open-mmlab/mmselfsup/pull/189))
+- 修复加载 cifar 数据集时的 bug ([#191](https://github.com/open-mmlab/mmselfsup/pull/191))
+- 修复 `dataset.evaluate` 的参数 bug ([#192](https://github.com/open-mmlab/mmselfsup/pull/192))

-#### Improvements
+#### 改进

- Cancel previous runs that are not completed in CI ([#145](https://github.com/open-mmlab/mmselfsup/pull/145))
- Enhance MIM function ([#152](https://github.com/open-mmlab/mmselfsup/pull/152))
- Skip CI when some specific files were changed ([#154](https://github.com/open-mmlab/mmselfsup/pull/154))
- Add `drop_last` when building eval optimizer ([#158](https://github.com/open-mmlab/mmselfsup/pull/158))
- Deprecate the support for "python setup.py test" ([#174](https://github.com/open-mmlab/mmselfsup/pull/174))
- Speed up training and start time ([#181](https://github.com/open-mmlab/mmselfsup/pull/181))
- Upgrade `isort` to 5.10.1 ([#184](https://github.com/open-mmlab/mmselfsup/pull/184))
+- 取消之前在 CI 中未完成的运行 ([#145](https://github.com/open-mmlab/mmselfsup/pull/145))
+- 增强 MIM 功能 ([#152](https://github.com/open-mmlab/mmselfsup/pull/152))
+- 更改某些特定文件时跳过 CI ([#154](https://github.com/open-mmlab/mmselfsup/pull/154))
+- 在构建 eval 优化器时添加 `drop_last` 选项 ([#158](https://github.com/open-mmlab/mmselfsup/pull/158))
+- 弃用对 “python setup.py test” 的支持 ([#174](https://github.com/open-mmlab/mmselfsup/pull/174))
+- 加速训练和启动时间 ([#181](https://github.com/open-mmlab/mmselfsup/pull/181))
+- 升级 `isort` 到 5.10.1 ([#184](https://github.com/open-mmlab/mmselfsup/pull/184))

-#### Docs
+#### 文档

- Refactor the directory structure of docs ([#146](https://github.com/open-mmlab/mmselfsup/pull/146))
- Fix readthedocs ([#148](https://github.com/open-mmlab/mmselfsup/pull/148), [#149](https://github.com/open-mmlab/mmselfsup/pull/149), [#153](https://github.com/open-mmlab/mmselfsup/pull/153))
- Fix typos and dead links in some docs ([#155](https://github.com/open-mmlab/mmselfsup/pull/155), [#180](https://github.com/open-mmlab/mmselfsup/pull/180), [#195](https://github.com/open-mmlab/mmselfsup/pull/195))
- Update training logs and benchmark results in model zoo ([#157](https://github.com/open-mmlab/mmselfsup/pull/157), [#165](https://github.com/open-mmlab/mmselfsup/pull/165), [#195](https://github.com/open-mmlab/mmselfsup/pull/195))
- Update and translate some docs into Chinese ([#163](https://github.com/open-mmlab/mmselfsup/pull/163), [#164](https://github.com/open-mmlab/mmselfsup/pull/164), [#165](https://github.com/open-mmlab/mmselfsup/pull/165), [#166](https://github.com/open-mmlab/mmselfsup/pull/166), [#167](https://github.com/open-mmlab/mmselfsup/pull/167), [#168](https://github.com/open-mmlab/mmselfsup/pull/168), [#169](https://github.com/open-mmlab/mmselfsup/pull/169), [#172](https://github.com/open-mmlab/mmselfsup/pull/172), [#176](https://github.com/open-mmlab/mmselfsup/pull/176), [#178](https://github.com/open-mmlab/mmselfsup/pull/178), [#179](https://github.com/open-mmlab/mmselfsup/pull/179))
- Update algorithm README with the new format ([#177](https://github.com/open-mmlab/mmselfsup/pull/177))
+- 重构文档目录结构 ([#146](https://github.com/open-mmlab/mmselfsup/pull/146))
+- 修复 readthedocs ([#148](https://github.com/open-mmlab/mmselfsup/pull/148), [#149](https://github.com/open-mmlab/mmselfsup/pull/149), [#153](https://github.com/open-mmlab/mmselfsup/pull/153))
+- 修复一些文档中的拼写错误和无效链接 ([#155](https://github.com/open-mmlab/mmselfsup/pull/155), [#180](https://github.com/open-mmlab/mmselfsup/pull/180), [#195](https://github.com/open-mmlab/mmselfsup/pull/195))
+- 更新模型库里的训练日志和基准测试结果 ([#157](https://github.com/open-mmlab/mmselfsup/pull/157), [#165](https://github.com/open-mmlab/mmselfsup/pull/165), [#195](https://github.com/open-mmlab/mmselfsup/pull/195))
+- 更新部分文档并翻译成中文 ([#163](https://github.com/open-mmlab/mmselfsup/pull/163), [#164](https://github.com/open-mmlab/mmselfsup/pull/164), [#165](https://github.com/open-mmlab/mmselfsup/pull/165), [#166](https://github.com/open-mmlab/mmselfsup/pull/166), [#167](https://github.com/open-mmlab/mmselfsup/pull/167), [#168](https://github.com/open-mmlab/mmselfsup/pull/168), [#169](https://github.com/open-mmlab/mmselfsup/pull/169), [#172](https://github.com/open-mmlab/mmselfsup/pull/172), [#176](https://github.com/open-mmlab/mmselfsup/pull/176), [#178](https://github.com/open-mmlab/mmselfsup/pull/178), [#179](https://github.com/open-mmlab/mmselfsup/pull/179))
+- 更新算法 README 到新格式 ([#177](https://github.com/open-mmlab/mmselfsup/pull/177))

 ### v0.5.0 (16/12/2021)

-#### Highlight
+#### 亮点

- Released with code refactor.
- Add 3 new self-supervised learning algorithms.
- Support benchmarks with MMDet and MMSeg.
- Add comprehensive documents.
+- 代码重构后发版。
+- 添加 3 个新的自监督学习算法。
+- 支持 MMDet 和 MMSeg 的基准测试。
+- 添加全面的文档。

-#### Refactor
+#### 重构

- Merge redundant dataset files.
- Adapt to new version of MMCV and remove old version related codes.
- Inherit MMCV BaseModule.
- Optimize directory.
- Rename all config files.
+- 合并冗余数据集文件。
+- 适配新版 MMCV，去除旧版相关代码。
+- 继承 MMCV BaseModule。
+- 优化目录结构。
+- 重命名所有配置文件。

-#### New Features
+#### 新特性

- Add SwAV, SimSiam, DenseCL algorithms.
- Add t-SNE visualization tools.
- Support MMCV version fp16.
+- 添加 SwAV、SimSiam、DenseCL 算法。
+- 添加 t-SNE 可视化工具。
+- 支持 MMCV 版本 fp16。

-#### Benchmarks
+#### 基准

- More benchmarking results, including classification, detection and segmentation.
- Support some new datasets in downstream tasks.
- Launch MMDet and MMSeg training with MIM.
+- 更多基准测试结果，包括分类、检测和分割。
+- 支持下游任务中的一些新数据集。
+- 使用 MIM 启动 MMDet 和 MMSeg 训练。

-#### Docs
+#### 文档

- Refactor README, getting_started, install, model_zoo files.
- Add data_prepare file.
- Add comprehensive tutorials.
+- 重构 README、getting_started、install、model_zoo 文档。
+- 添加数据准备文档。
+- 添加全面的教程。

-## OpenSelfSup (History)
+## OpenSelfSup (历史)

 ### v0.3.0 (14/10/2020)

-#### Highlight
+#### 亮点

- Support Mixed Precision Training
- Improvement of GaussianBlur doubles the training speed
- More benchmarking results
+- 支持混合精度训练。
+- 改进 GaussianBlur 使训练速度加倍。
+- 更多基准测试结果。

-#### Bug Fixes
+#### Bug 修复

- Fix bugs in moco v2, now the results are reproducible.
- Fix bugs in byol.
+- 修复 moco v2 中的 bugs，现在结果可复现。
+- 修复 byol 中的 bugs。

-#### New Features
+#### 新特性

- Mixed Precision Training
- Improvement of GaussianBlur doubles the training speed of MoCo V2, SimCLR, BYOL
- More benchmarking results, including Places, VOC, COCO
+- 混合精度训练。
+- 改进 GaussianBlur 使 MoCo V2、SimCLR、BYOL 的训练速度加倍。
+- 更多基准测试结果，包括 Places、VOC、COCO。

 ### v0.2.0 (26/6/2020)

-#### Highlights
+#### 亮点

- Support BYOL
- Support semi-supervised benchmarks
+- 支持 BYOL。
+- 支持半监督基准测试。

-#### Bug Fixes
+#### Bug 修复

- Fix hash id in publish_model.py
+- 修复 publish_model.py 中的哈希 id。

-#### New Features
+#### 新特性

- Support BYOL.
- Separate train and test scripts in linear/semi evaluation.
- Support semi-supevised benchmarks: benchmarks/dist_train_semi.sh.
- Move benchmarks related configs into configs/benchmarks/.
- Provide benchmarking results and model download links.
- Support updating network every several iterations.
- Support LARS optimizer with nesterov.
- Support excluding specific parameters from LARS adaptation and weight decay required in SimCLR and BYOL.
+- 支持 BYOL。
+- 在线性和半监督评估中将训练和测试脚本分开。
+- 支持半监督基准测试：benchmarks/dist_train_semi.sh。
+- 将基准测试相关的配置文件移动到 configs/benchmarks/。
+- 提供基准测试结果和模型下载链接。
+- 支持每隔几次迭代更新网络。
+- 支持带有 Nesterov 的 LARS 优化器。
+- 支持 SimCLR 和 BYOL 从 LARS 适应和权重衰减中排除特定参数的需求。
--- a/docs/zh_cn/notes/contribution_guides.md
+++ b/docs/zh_cn/notes/contribution_guides.md
@ -0,0 +1,78 @@
+# 向MMSelfSup贡献代码
+
+- [向MMSelfSup贡献代码](#向MMSelfSup贡献代码)
+  - [流程](#流程)
+  - [代码风格](#代码风格)
+    - [Python](#python)
+    - [C++ and CUDA](#c-and-cuda)
+
+感谢您对参与 MMSelfsup 贡献的兴趣。我们欢迎各种形式的贡献，包括但不限于：
+
+- 修复 bug 或者错误
+- 添加或翻译文档为另外一种语言
+- 添加新特性或者组件
+
+## 流程
+
+我们推荐潜在的贡献者使用下面的流程来添加贡献：
+
+1. Fork 并 pull 最新的 MMSelfSup 仓库，并根据 [get_started](../get_started.md) 来配置环境。
+2. Checkout 一个新的分支 (**不要使用 master/dev branch 提交 PR**)
+
+请从 `dev-1.x` 分支 checkout 一个新的分支，并按照下面指令：
+
+```bash
+git clone git@github.com:open-mmlab/mmselfsup.git
+cd mmselfsup
+git checkout dev-1.x
+git checkout -b xxxx # xxxx is the name of new branch
+```
+
+3. 根据后面提到的代码风格编辑相关的文件
+4. 使用 **pre-commit hook** 来检查和格式化您的修改。
+5. 提交您的修改。
+6. 创建一个 PR，并往 dev-1.x 合入。
+
+```{note}
+如果您计划去增添一些涉及到很大变化的新特性，我们推荐您先创建一个 issue 与我们讨论。
+```
+
+## 代码风格
+
+### Python
+
+我们采用 [PEP8](https://www.python.org/dev/peps/pep-0008/) 作为我们的代码风格。
+我们采用一下工具来进行 linting 和 formatting：
+
+- [flake8](https://github.com/PyCQA/flake8): 一个 linter 工具装饰器.
+- [isort](https://github.com/timothycrosley/isort): 一个为 Python 导入排序的工具。
+- [yapf](https://github.com/google/yapf): 一个为 Python 文件格式化的工具。
+- [codespell](https://github.com/codespell-project/codespell): 一个修改错误拼写的 Python 工具。
+- [mdformat](https://github.com/executablebooks/mdformat): Mdformat 是一个可选的 Markdorn 的格式化工具，可以让 Markdown 文件中的格式保持一致。
+- [docformatter](https://github.com/myint/docformatter): 一个格式化 docstring 的工具.
+
+配置 yapf 和 isort 放在在 [setup.cfg](./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`, sorts `requirments.txt` 在每一次提交。
+为 pre-commit hook 的配置储存在 [.pre-commit-config](./.pre-commit-config.yaml)。
+
+在您 clone 仓库之后，您需要安装并初始化 pre-commit hook。
+
+```shell
+pip install -U pre-commit
+```
+
+在仓库的文件夹中
+
+```shell
+pre-commit install
+pre-commit run
+```
+
+在此之后，在每一次提交时 linters 和 formatter 都会进行。
+
+> 在您创建一个 PR 前，请确保您的代码 lint 并被 yapf 格式化过。
+
+### C++ and CUDA
+
+我们采用[Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)。
--- a/docs/zh_cn/notes/faq.md
+++ b/docs/zh_cn/notes/faq.md
@ -1,24 +1,40 @@
 # FAQ

-We list some common troubles faced by many users and their corresponding solutions here. Feel free to enrich the list if you find any frequent issues and have ways to help others to solve them. If the contents here do not cover your issue, please create an issue using the [provided templates](https://github.com/open-mmlab/mmselfsup/tree/master/.github/ISSUE_TEMPLATE) and make sure you fill in all required information in the template.
+我们列出来一些用户常见的问题，并将他们的解决方案列出。 您可以将一些您发现的常见的问题添加进列表中，来帮助其他用户解决问题。 如果这里面的内容没有覆盖您的问题，请按照 [模板](https://github.com/open-mmlab/mmselfsup/tree/master/.github/ISSUE_TEMPLATE) 创建一个 issue，并确保您在模板中填写了所有要求的信息。

 - [FAQ](#faq)
-  - [Installation](#installation)
+  - [安装](#安装)
+  - [DeepCluster 在 A100 GPU](#deepcluster-在-a100-gpu)

-## Installation
+## 安装

-Compatible MMCV, MMClassification, MMDetection and MMSegmentation versions are shown below. Please install the correct version of them to avoid installation issues.
+MMCV, MMClassification, MMDetection and MMSegmentation 的版本兼容性如下所示。 请安装正确的版本来避免安装问题。

-| MMSelfSup version |    MMCV version     |  MMClassification version   | MMSegmentation version | MMDetection version |
-| :---------------: | :-----------------: | :-------------------------: | :--------------------: | :-----------------: |
-|  0.9.1 (master)   | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.9.0       | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.8.0       | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.7.1       | mmcv-full >= 1.3.16 | mmcls >= 0.19.0, \<= 0.20.1 |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
-|       0.6.0       | mmcv-full >= 1.3.16 |       mmcls >= 0.19.0       |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
-|       0.5.0       | mmcv-full >= 1.3.16 |              /              |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+| MMSelfSup version | MMEngine version  |    MMCV version     |  MMClassification version   | MMSegmentation version | MMDetection version |
+| :---------------: | :---------------: | :-----------------: | :-------------------------: | :--------------------: | :-----------------: |
+|  1.0.0rc2 (1.x)   | mmengine >= 0.1.0 |  mmcv >= 2.0.0rc1   |      mmcls >= 1.0.0rc0      |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|     1.0.0rc1      | mmengine >= 0.1.0 |  mmcv >= 2.0.0rc1   |      mmcls >= 1.0.0rc0      |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|  0.9.1 (master)   |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.9.0       |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.8.0       |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.7.1       |         /         | mmcv-full >= 1.3.16 | mmcls >= 0.19.0, \<= 0.20.1 |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+|       0.6.0       |         /         | mmcv-full >= 1.3.16 |       mmcls >= 0.19.0       |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+|       0.5.0       |         /         | mmcv-full >= 1.3.16 |              /              |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |

 **Note:**

- You need to run `pip uninstall mmcv` first if you have mmcv installed. If mmcv and mmcv-full are both installed, there will be `ModuleNotFoundError`.
- If you still have version problem, please create an issue and provide your package versions.
+- MMDetection 和 MMSegmentation 是可选的。
+- 如果您仍然有版本错误，请创建一个issue并提供您的包的版本信息。
+
+## DeepCluster 在 A100 GPU
+
+如果您想尝试 [DeepCluster](https://github.com/open-mmlab/mmselfsup/blob/master/configs/selfsup/deepcluster/README.md) 在 A100 GPU 上，使用 pip 安装 `faiss` 将会引发错误，
+他在[这里](https://github.com/facebookresearch/faiss/issues/2076)被提及过。
+
+请使用 conda 安装：
+
+```bash
+conda install -c pytorch faiss-gpu cudatoolkit=11.3
+```
+
+> 同时您需要安装支持 CUDA11.3 的 PyTorch，同时 faiss-gpu==1.7.2 要求 python 3.6-3.8。