Skip to content

Commit

Permalink
v0.2.3, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lupin1998 committed Jun 14, 2022
1 parent ae77802 commit 2a03d93
Show file tree
Hide file tree
Showing 81 changed files with 2,135 additions and 102 deletions.
1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
We appreciate all contributions to improve OpenMixup. We follow the developing standard of MMLab. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md) in MMCV for more details about the contributing guideline.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/----.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 寻求帮助
about: 遇到问题并寻求帮助
title: ''
labels: help wanted
assignees: ''
---

推荐使用英语模板 General question,以便你的问题帮助更多人。

### 首先确认以下内容

- 我已经查询了相关的 issue,但没有找到需要的帮助。
- 我已经阅读了相关文档,但仍不知道如何解决。

### 描述你遇到的问题

\[填写这里\]

### 相关信息

1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
\[填写这里\]
2. 如果你修改了,或者使用了新的配置文件,请在这里写明

```python
[填写这里]
```

3. 如果你是在训练过程中遇到的问题,请填写完整的训练日志和报错信息
\[填写这里\]
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改,请在这里写明
\[填写这里\]
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/---.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: 新功能
about: 为项目提一个建议
title: '[Feature]'
labels: enhancement
assignees: ''
---

推荐使用英语模板 Feature request,以便你的问题帮助更多人。

### 描述这个功能

\[填写这里\]

### 动机

请简要说明以下为什么需要添加这个新功能
例 1. 现在进行 xxx 的时候不方便
例 2. 最近的论文中提出了有一个很有帮助的 xx

\[填写这里\]

### 相关资源

是否有相关的官方实现或者第三方实现?这些会很有参考意义。

\[填写这里\]

### 其他相关信息

其他和这个功能相关的信息或者截图,请放在这里。
另外如果你愿意参与实现这个功能并提交 PR,请在这里说明,我们将非常欢迎。

\[填写这里\]
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/---bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: 报告 Bug
about: 报告问题以帮助我们提升
title: '[Bug]'
labels: bug
assignees: ''
---

推荐使用英语模板 Bug report,以便你的问题帮助更多人。

### 描述 bug

简单地描述一下遇到了什么 bug

\[填写这里\]

### 复现流程

在命令行中执行的详细操作

```shell
[填写这里]
```

### 相关信息

1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
\[填写这里\]
2. 如果你修改了,或者使用了新的配置文件,请在这里写明

```python
[填写这里]
```

3. 如果你是在训练过程中遇到的问题,请填写完整的训练日志和报错信息
\[填写这里\]
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改,请在这里写明
\[填写这里\]

### 附加内容

任何其他有关该 bug 的信息、截图等

\[填写这里\]
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug report
about: Create a report to help us improve
title: '[Bug]'
labels: bug
assignees: ''
---

### Describe the bug

A clear and concise description of what the bug is.

\[here\]

### To Reproduce

The command you executed.

```shell
[here]
```

### Post related information

1. The output of `pip list | grep "mmcv\|mmcls\|^torch"`
\[here\]
2. Your config file if you modified it or created a new one.

```python
[here]
```

3. Your train log file if you meet the problem during training.
\[here\]
4. Other code you modified in the `mmcls` folder.
\[here\]

### Additional context

Add any other context about the problem here.

\[here\]
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

contact_links:
- name: MMClassification Documentation
url: https://mmclassification.readthedocs.io/en/latest/
about: Check if your question is answered in docs
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[Feature]'
labels: enhancement
assignees: ''
---

### Describe the feature

\[here\]

### 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 \[....\].

\[here\]

### Related resources

If there is an official code release or third-party implementation, please also provide the information here, which would be very helpful.

\[here\]

### 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.

\[here\]
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/general-questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: General questions
about: 'Ask general questions to get help '
title: ''
labels: help wanted
assignees: ''
---

### Checklist

- I have searched related issues but cannot get the expected help.
- I have read related documents and don't know what to do.

### Describe the question you meet

\[here\]

### Post related information

1. The output of `pip list | grep "mmcv\|mmcls\|^torch"`
\[here\]
2. Your config file if you modified it or created a new one.

```python
[here]
```

3. Your train log file if you meet the problem during training.
\[here\]
4. Other code you modified in the `mmcls` folder.
\[here\]
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Thanks for your contribution to OpenMixup and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. We follow the standard in MMLab, e.g., [MMClassification](https://github.com/open-mmlab/mmclassification). If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

## Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

## Modification

Please briefly describe what modification is made in this PR.

## BC-breaking (Optional)

Does the modification introduce changes that break the backward compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

## Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here and update the documentation.

## Checklist

**Before PR**:

- [ ] Pre-commit or other linting tools are used to fix the potential lint issues.
- [ ] Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
- [ ] The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
- [ ] The documentation has been modified accordingly, like docstring or example tutorials.

**After PR**:

- [ ] If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg.
- [ ] CLA has been signed and all committers have signed the CLA in this PR.
Loading

0 comments on commit 2a03d93

Please sign in to comment.