Switch default branch to 1.x (#686)
* add schedule * update docs * update issue template * fix lint * update migration * fix lint * update version of isortpull/676/head
Yixiao Fang
GitHub
parent
54d4cf7275
commit
8593bef3ae
|
|
@ -0,0 +1,100 @@
|
|||
name: "🐞 Bug Report"
|
||||
description: "Create a report to help us reproduce and fix the bug"
|
||||
labels: Bug
|
||||
title: "[Bug] "
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmselfsup/pulls)!
|
||||
If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose).
|
||||
If you need our help, please fill in as much of the following form as you're able.
|
||||
|
||||
**The less clear the description, the longer it will take to solve it.**
|
||||
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
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)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Prerequisite
|
||||
description: Please check the following items before creating a new issue.
|
||||
options:
|
||||
- label: I have searched [Issues](https://github.com/open-mmlab/mmselfsup/issues) and [Discussions](https://github.com/open-mmlab/mmselfsup/discussions) but cannot get the expected help.
|
||||
required: true
|
||||
- label: I have read the [documentation](https://mmselfsup.readthedocs.io/en/latest/) but cannot get the expected help.
|
||||
required: true
|
||||
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmselfsup).
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
Please run `python mmselfsup/utils/collect_env.py` to collect necessary environment information and copy-paste it here.
|
||||
You may add additional information that may be helpful for locating the problem, such as
|
||||
- How you installed PyTorch \[e.g., pip, conda, source\]
|
||||
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: |
|
||||
Please provide a clear and concise description of what the bug is.
|
||||
Preferably a simple and minimal code snippet is provided below, so that we can reproduce the error by running the code.
|
||||
placeholder: |
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduces the problem - code sample
|
||||
description: |
|
||||
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
|
||||
Did you make any modifications on the code or config? Are you clear about what you have modified?
|
||||
placeholder: |
|
||||
```python
|
||||
# Sample code to reproduce the problem
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduces the problem - command or script
|
||||
description: |
|
||||
What command or script did you run?
|
||||
placeholder: |
|
||||
```shell
|
||||
The command or script you run.
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduces the problem - error message
|
||||
description: |
|
||||
Please provide the error message or logs you got, with the full traceback.
|
||||
placeholder: |
|
||||
```
|
||||
The error message or logs you got, with the full traceback.
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Tell us anything else you think we should know.
|
||||
placeholder: |
|
||||
1. What's your expected result?
|
||||
2. What dataset did you use?
|
||||
3. What do you think might be the reason?
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
name: 🚀 Feature Request
|
||||
description: Suggest an idea for this project
|
||||
labels: [Feature]
|
||||
title: "[Feature] "
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
We strongly appreciate you creating a PR to implete this feature [here](https://github.com/open-mmlab/mmselfsup/pulls)!
|
||||
If you need our help, please fill in as much of the following form as you're able.
|
||||
|
||||
**The less clear the description, the longer it will take to solve it.**
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is the problem this feature will solve?
|
||||
placeholder: |
|
||||
E.g., It is inconvenient when \[....\].
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is the feature?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What alternatives have you considered?
|
||||
description: |
|
||||
Add any other context or screenshots about the feature request here.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
name: 📚 Documentation Issue
|
||||
description: Report an issue related to https://mmselfsup.readthedocs.io/en/latest/.
|
||||
labels: "Documentation"
|
||||
title: "[Docs] "
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: The doc issue
|
||||
description: >
|
||||
A clear and concise description of what content in https://mmselfsup.readthedocs.io/en/latest/ is an issue.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Suggest a potential alternative/fix
|
||||
description: >
|
||||
Tell us how we could improve the documentation in this regard.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
Thanks for contributing 🎉!
|
||||
|
|
@ -1,6 +1,12 @@
|
|||
blank_issues_enabled: false
|
||||
|
||||
contact_links:
|
||||
- name: MMSelfSup Documentation
|
||||
- name: 📚 MMSelfSup Documentation (官方文档)
|
||||
url: https://mmselfsup.readthedocs.io/en/1.x/
|
||||
about: Check if your question is answered in docs
|
||||
- name: 💬 Forum (寻求帮助)
|
||||
url: https://github.com/open-mmlab/mmselfsup/discussions
|
||||
about: Ask general usage questions and discuss with other MMSelfSup community members
|
||||
- name: 🌐 Explore OpenMMLab (官网)
|
||||
url: https://openmmlab.com/
|
||||
about: Get know more about OpenMMLab
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the feature**
|
||||
|
||||
**Motivation**
|
||||
A clear and concise description of the motivation of the feature.
|
||||
Ex1. It is inconvenient when \[....\].
|
||||
Ex2. There is a recent paper \[....\], which is very helpful for \[....\].
|
||||
|
||||
**Related resources**
|
||||
If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated.
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
name: Unexpected Results
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
Thanks for reporting the unexpected results and we appreciate it a lot.
|
||||
|
||||
**Checklist**
|
||||
|
||||
1. I have searched related issues but cannot get the expected help.
|
||||
2. The unexpected results still exist in the latest version.
|
||||
|
||||
**Describe the Issue**
|
||||
A clear and concise description of what the bug is, including what results are expected and what the real results you got.
|
||||
|
||||
**Reproduction**
|
||||
|
||||
1. What command, code, or script did you run?
|
||||
|
||||
```bash
|
||||
A placeholder for the command.
|
||||
```
|
||||
|
||||
2. Did you make any modifications on the code? Did you understand what you have modified?
|
||||
|
||||
**Environment**
|
||||
|
||||
1. Please run `python -c "from mmselfsup.utils import collect_env; print(collect_env())"` to collect necessary environment information and paste it here.
|
||||
2. You may add addition that may be helpful for locating the problem, such as
|
||||
- How you installed PyTorch \[e.g., pip, conda, source\]
|
||||
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
|
||||
|
||||
**Error traceback**
|
||||
If applicable, paste the error traceback here.
|
||||
|
||||
```none
|
||||
A placeholder for traceback.
|
||||
```
|
||||
|
||||
**Bug fix**
|
||||
If you have already identified the reason, you can provide the information here. If you are willing to create a PR to fix it, please also leave a comment here and that would be much appreciated!
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# assign issues to owners automatically
|
||||
assign:
|
||||
issues: enabled # or disabled
|
||||
pull_requests: enabled # or disabled
|
||||
# assign strategy, both issues and pull requests follow the same strategy
|
||||
strategy:
|
||||
# random
|
||||
# round-robin
|
||||
daily-shift-based
|
||||
schedule:
|
||||
'*/1 * * * *'
|
||||
# assignees
|
||||
assignees:
|
||||
- fangyixiao18
|
||||
- YuanLiuuuuuu
|
||||
- Jiahao000
|
||||
- YuanLiuuuuuu
|
||||
- tonysy
|
||||
- wangbo-zhao
|
||||
- fangyixiao18
|
||||
|
|
@ -4,8 +4,8 @@ repos:
|
|||
rev: 5.0.4
|
||||
hooks:
|
||||
- id: flake8
|
||||
- repo: https://github.com/zhouzaida/isort
|
||||
rev: 5.12.1
|
||||
- repo: https://github.com/PyCQA/isort
|
||||
rev: 5.11.5
|
||||
hooks:
|
||||
- id: isort
|
||||
- repo: https://github.com/pre-commit/mirrors-yapf
|
||||
|
|
|
|||
|
|
@ -65,6 +65,8 @@ The master branch works with **PyTorch 1.6** or higher.
|
|||
|
||||
## What's New
|
||||
|
||||
**The default branch has been switched to `1.x` from `master`, and we encourage users to migrate to the latest version, though it comes with some cost. Please refer to [Migration Guide](https://mmselfsup.readthedocs.io/en/1.x/migration.html) for more details.**
|
||||
|
||||
MMSelfSup **v1.0.0rc5** was released in 30/12/2022.
|
||||
|
||||
- Support `BEiT v2`, `MixMIM`, `EVA`.
|
||||
|
|
|
|||
|
|
@ -65,6 +65,8 @@ MMSelfSup 是一个基于 PyTorch 实现的开源自监督表征学习工具箱
|
|||
|
||||
## 更新
|
||||
|
||||
**默认分支已经从 `master` 切换到 `1.x`。我们鼓励用户迁移到最新版本，请参考 [迁移指南](https://mmselfsup.readthedocs.io/zh_CN/1.x/migration.html) 以了解更多细节。**
|
||||
|
||||
**v1.0.0rc5** 版本已经在 2022.12.30 发布。
|
||||
|
||||
- 支持了 `BEiT v2`, `MixMIM`, `EVA`
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ html_theme_options = {
|
|||
},
|
||||
{
|
||||
'name': 'MMSelfSup 1.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/en/dev-1.x/',
|
||||
'url': 'https://mmselfsup.readthedocs.io/en/1.x/',
|
||||
'description': '1.x branch docs'
|
||||
},
|
||||
],
|
||||
|
|
|
|||
|
|
@ -11,10 +11,13 @@
|
|||
|
||||
## Migration from MMSelfSup 0.x
|
||||
|
||||
```{warning}
|
||||
MMSelfSup 1.x depends on some new packages, you should create a new environment for MMSelfSup 1.x even if you have a well-rounded MMSelfSup 0.x environment before. Please refer to the [install tutorial](./get_started.md) for required packages installation.
|
||||
```
|
||||
|
||||
We introduce some modifications of MMSelfSup 1.x, to help users to migrate their projects based on MMSelfSup 0.x to 1.x smoothly.
|
||||
|
||||
MMSelfSup 1.x depends on some new packages, you should create a new environment, with these required packages installed
|
||||
according to the [install tutorial](./get_started.md). Three important packages are listed below,
|
||||
Three important packages are listed below,
|
||||
|
||||
1. [MMEngine](https://github.com/open-mmlab/mmengine): MMEngine is the base of all OpenMMLab 2.0 repos.
|
||||
Some modules, which are not specific to Computer Vision, are migrated from MMCV to this repo.
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ html_theme_options = {
|
|||
},
|
||||
{
|
||||
'name': 'MMSelfSup 1.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/1.x/',
|
||||
'description': '1.x 分支文档'
|
||||
},
|
||||
],
|
||||
|
|
|
|||
|
|
@ -11,9 +11,13 @@
|
|||
|
||||
## 迁移自 MMSelfSup 0.x 版本
|
||||
|
||||
```{warning}
|
||||
MMSelfSup 1.x 版本依赖于一些新的代码包，您应该根据 [安装教程](./get_started.md) 来创建新的环境，尽管你可能已经拥有了一个可以正常运行 MMSelfSup 0.x 的环境。请参考[安装文档](./get_started.md) 对依赖库进行对应的安装。
|
||||
```
|
||||
|
||||
我们将介绍一些 MMSelfSup 1.x 版本的变换，帮助用户更顺利的将项目从 MMSelfSup 0.x 版本迁移到 1.x 版本。
|
||||
|
||||
MMSelfSup 1.x 版本依赖于一些新的代码包，您应该根据 [安装教程](./get_started.md) 来创建新的环境，并安装依赖项。三个重要的依赖库已列出：
|
||||
三个重要的依赖库已列出：
|
||||
|
||||
1. [MMEngine](https://github.com/open-mmlab/mmengine): MMEngine 是所有 OpenMMLab 2.0 项目的基础库，一部分非计算机视觉强相关的模块从 MMCV 迁移到了 MMEngine。
|
||||
2. [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库。这不是新的依赖项，但是您需要将其升级到至少 `2.0.0rc1` 版本。
|
||||
|
|
|
|||
Loading…
Reference in New Issue