-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] Add Chinese translation of install.md and 4 super-resolution datasets README.md #424
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments. Thank you very much for your help.
docs_zh-CN/install.md
Outdated
@@ -1,11 +1,96 @@ | |||
## 依赖 | |||
|
|||
- Linux (Windows is not officially supported) | |||
- Linux (目前Windows不是官方支持) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When switching between Chinese and English, please insert a space before and after. For example:
目前 Windows 不是官方支持
There are some more similar examples below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it, will fix them later.
docs_zh-CN/install.md
Outdated
conda create -n open-mmlab python=3.7 -y | ||
conda activate open-mmlab | ||
``` | ||
b. 安装[PyTorch官方文档](https://pytorch.org/)安装PyTorch和torchvision,如: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to above
安装[PyTorch 官方文档](https://pytorch.org/)安装 PyTorch 和 torchvision,如:
docs_zh-CN/install.md
Outdated
conda create -n open-mmlab python=3.7 -y | ||
conda activate open-mmlab | ||
``` | ||
b. 按照 [PyTorch官方文档](https://pytorch.org/) 安装 PyTorch 和 torchvision,如: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PyTorch官方文档 -> PyTorch 官方文档
docs_zh-CN/install.md
Outdated
```shell script | ||
conda install pytorch torchvision -c pytorch | ||
``` | ||
注意:确保你的 CUDA 编译版本和 CUDA 运行版本相匹配。 用户可以参照 [PyTorch官网](https://pytorch.org/) 对预编译包所支持的 CUDA 版本进行核对。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PyTorch官网 -> PyTorch 官网
docs_zh-CN/install.md
Outdated
|
||
3. 如果用户想使用 `opencv-python-headless` 而不是 `opencv-python`,可在安装 `MMCV` 前安装 `opencv-python-headless`。 | ||
|
||
4. 有些模型(例如图像修复任务中的 `EDVR`)依赖于`mmcv-full`中的一些 CUDA 算子,具体的依赖可在`requirements.txt`中找到。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
依赖于mmcv-full
中 -> 依赖于 mmcv-full
中
在requirements.txt
中 -> 在 requirements.txt
中
docs_zh-CN/install.md
Outdated
3. 如果用户想使用 `opencv-python-headless` 而不是 `opencv-python`,可在安装 `MMCV` 前安装 `opencv-python-headless`。 | ||
|
||
4. 有些模型(例如图像修复任务中的 `EDVR`)依赖于`mmcv-full`中的一些 CUDA 算子,具体的依赖可在`requirements.txt`中找到。 | ||
如需要,请通过 `pip install -r requirements.txt`命令来安装`mmcv-full`,安装过程中会在本地编译 CUDA 算子,这个过程大概需要10分钟。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
请通过 pip install -r requirements.txt
命令 -> 请通过 pip install -r requirements.txt
命令
docs_zh-CN/install.md
Outdated
|
||
4. 有些模型(例如图像修复任务中的 `EDVR`)依赖于`mmcv-full`中的一些 CUDA 算子,具体的依赖可在`requirements.txt`中找到。 | ||
如需要,请通过 `pip install -r requirements.txt`命令来安装`mmcv-full`,安装过程中会在本地编译 CUDA 算子,这个过程大概需要10分钟。 | ||
另一种方案是安装预编译版本的`mmcv-full`,请参考 [MMCV主页](https://github.com/open-mmlab/mmcv#install-with-pip) 获取具体的安装指令。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
版本的mmcv-full
-> 版本的 mmcv-full
MMCV主页 -> MMCV 主页
docs_zh-CN/install.md
Outdated
4. 有些模型(例如图像修复任务中的 `EDVR`)依赖于`mmcv-full`中的一些 CUDA 算子,具体的依赖可在`requirements.txt`中找到。 | ||
如需要,请通过 `pip install -r requirements.txt`命令来安装`mmcv-full`,安装过程中会在本地编译 CUDA 算子,这个过程大概需要10分钟。 | ||
另一种方案是安装预编译版本的`mmcv-full`,请参考 [MMCV主页](https://github.com/open-mmlab/mmcv#install-with-pip) 获取具体的安装指令。 | ||
此外,如果你要使用的模型不依赖于 CUDA 算子,那么也可以使用`pip install mmcv`来安装轻量版本的 mmcv,其中 CUDA 算子被移除了。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
使用pip install mmcv
来 -> 使用 pip install mmcv
来
@@ -1 +1,9 @@ | |||
# 数据集 - 复原 | |||
# 超分辨数据集 | |||
建议将数据集的根目录链接到`$MMEDITING/data`下,如果你的文件目录结构不一致,那么你可能需要在配置文件中修改对应的文件路径。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
到$MMEDITING/data
下 -> 到 $MMEDITING/data
下
- 训练集: [REDS 数据集](https://seungjunnah.github.io/Datasets/reds.html). | ||
- 验证集: [REDS 数据集](https://seungjunnah.github.io/Datasets/reds.html) 和 Vid4. | ||
|
||
请注意,我们合并了 REDS 的训练集和验证集,以便在 REDS4 划分(在`EDVR`中会使用到)和官方验证集划分之间切换。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
在EDVR
中 -> 在 EDVR
中
|
||
请注意,我们合并了 REDS 的训练集和验证集,以便在 REDS4 划分(在`EDVR`中会使用到)和官方验证集划分之间切换。 | ||
|
||
原始验证集的名称被修改了(clip 000 到 029),以避免与训练集发生冲突(总共 240 个clip)。具体而言,验证集中的 clips 被改名为 240、241、... 269。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
总共 240 个clip -> 总共240个 clip
@@ -14,3 +14,36 @@ | |||
publisher={Springer} | |||
} | |||
``` | |||
训练集和测试集可以从 [此处](http://toflow.csail.mit.edu/) 下载。 | |||
|
|||
Vimeo90K 数据集包含了如下所示的`clip/sequence/img`目录结构: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
所示的clip/sequence/img
目录 -> 所示的 clip/sequence/img
目录
Codecov Report
@@ Coverage Diff @@
## master #424 +/- ##
=======================================
Coverage 80.66% 80.66%
=======================================
Files 188 188
Lines 10107 10107
Branches 1485 1485
=======================================
Hits 8153 8153
Misses 1740 1740
Partials 214 214
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
@LiUzHiAn Please install pre-commit. This helps you check the format of the modified files. After installing pre-commit, you can |
After executing
Any idea to fix that? Thanks for your time |
Usually, I commit the changes as usual. If |
I seem to find the reason. It's because some lines of code in Indeed, commit the changes as usual will also lead to the |
It worked now, thanks! |
…tasets README.md (open-mmlab#424) * [Doc] Add Chinese translation of install.md * [Doc] Add Chinese translation of super-resolution datasets description files * [Doc] insert a space bwtween Chinese and English * [Doc] Add missing space between Chinese and English * [Doc] Add mising EOF line * fix typo * Format Signed-off-by: lizz <lizz@sensetime.com> * More formats Signed-off-by: lizz <lizz@sensetime.com> Co-authored-by: lizz <lizz@sensetime.com>
Hi @LiUzHiAn !First of all, we want to express our gratitude for your significant PR in this project. Your contribution is highly appreciated, and we are grateful for your efforts in helping improve this open-source project during your personal time. We believe that many developers will benefit from your PR. We would also like to invite you to join our Special Interest Group (SIG) private channel on Discord, where you can share your experiences, ideas, and build connections with like-minded peers. To join the SIG channel, simply message moderator— OpenMMLab on Discord or briefly share your open-source contributions in the #introductions channel and we will assist you. Look forward to seeing you there! Join us :https://discord.gg/UjgXkPWNqA If you have WeChat account,welcome to join our community on WeChat. You can add our assistant :openmmlabwx. Please add "mmsig + Github ID" as a remark when adding friends:) |
This PR adds a Chinese version of the installation instructions (
install.md
) and the 4 super-resolution datasets description files (intools/data/super-resolution/*/README.md
).