[Doc] Add Chinese doc for get_started #615

MengzhangLI · 2021-06-22T10:17:42Z

Add Chinese doc for get_started

codecov · 2021-06-22T11:01:13Z

Codecov Report

Merging #615 (7f609cf) into doc_zh (194c1c9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           doc_zh     #615   +/-   ##
=======================================
  Coverage   86.26%   86.26%           
=======================================
  Files         101      101           
  Lines        5278     5278           
  Branches      854      854           
=======================================
  Hits         4553     4553           
  Misses        561      561           
  Partials      164      164

Flag	Coverage Δ
unittests	`86.26% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 194c1c9...7f609cf. Read the comment docs.

Junjun2016 · 2021-06-23T08:33:43Z

docs_zh-CN/get_started.md

@@ -1 +1,208 @@
 ## 依赖
+
+- Linux or macOS (Windows下支持需要mmcv-full，但运行时可能会有一些问题。)


Suggested change

- Linux or macOS (Windows下支持需要mmcv-full，但运行时可能会有一些问题。)

- Linux or macOS (Windows 下支持需要 mmcv-full，但运行时可能会有一些问题。)

Junjun2016 · 2021-06-23T08:35:30Z

docs_zh-CN/get_started.md

+C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\VC\Tools\MSVC\14.26.28801\bin\Hostx86\x64
+```
+
+或者您需要从网上下载cl编译工具并安装至路径。


Suggested change

或者您需要从网上下载cl编译工具并安装至路径。

或者您需要从网上下载 cl 编译工具并安装至路径。

Junjun2016 · 2021-06-23T08:42:33Z

docs_zh-CN/get_started.md

+model = init_segmentor(config_file, checkpoint_file, device='cuda:0')
+
+# 测试一张样例图片并得到结果
+img = 'test.jpg'  # or img = mmcv.imread(img), which will only load it once


Junjun2016 · 2021-06-23T08:43:54Z

docs_zh-CN/get_started.md

+# 您可以改变 segmentation map 的不透明度(opacity)，在(0, 1]之间。
+model.show_result(img, result, out_file='result.jpg', opacity=0.5)
+
+# 测试一个视频并得到结果


Suggested change

# 测试一个视频并得到结果

# 测试一个视频并得到分割结果

xvjiarui · 2021-06-27T18:00:48Z

docs_zh-CN/get_started.md

+4. 如果您想使用 `opencv-python-headless` 替换 `opencv-python`，您可以在安装 MMCV 前安装它。
+5. 一些依赖项是可选的。简单的运行 `pip install -e .` 将仅安装最必要的一些依赖。为了使用可选的依赖项如`cityscapessripts`，要么手动使用 `pip install -r requirements/optional.txt` 安装，要么专门从pip下安装(即 `pip install -e .[optional]`， 其中选项可设置为 `all`, `tests`, `build`, 和 `optional`).
+
+### 即刻安装脚本


Suggested change

### 即刻安装脚本

### 完成的安装脚本

xvjiarui · 2021-06-27T18:02:22Z

docs_zh-CN/get_started.md

+
+当您完成 MMSegmentation 的安装时，上述代码应该可以成功运行。
+
+我们还提供一个 demo 脚本去测试单张图片：


Suggested change

我们还提供一个 demo 脚本去测试单张图片：

我们还提供一个 demo 脚本去可视化单张图片：

* Add chinese doc base (#593) * [Doc] Add Chinese doc for useful_tools_md (#642) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * dataset_prepare * useful_tools * refine * Update useful_tools.md * Update useful_tools.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for get_started (#615) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * get_started_md * refine_get_started_md * [Doc] Add Chinese doc for tutorial03_tutorial_datapipeline_md (#629) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * refine * Update data_pipeline.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials04_customized_models_md (#630) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * refine * refine * Update customize_models.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for dataset_prepare_md (#640) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * dataset_prepare * Update dataset_prepare.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials05_training_tricks_md (#631) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * traning tricks md * traning tricks md * refine * refine * refine * Update training_tricks.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials06_customized_runtime_md (#637) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * Update customize_runtime.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials01_config_md (#628) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * new_config_md * new_config_md1 * new_config_md1 * refine * refine * Update config.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese for modelzoo (#597) * [Doc] Add Chinese for modelzoo * add missing * [Doc] Add Chinese doc for tutorial02_customized_dataset_md (#620) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * tutorial_customized_dataset * refine * Update customize_datasets.md * fixconflict Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for train.md (#616) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * train_md * refine * refine_last * refine_last * refine_last * refine_last * refine_last * temp * refine_last * qwe Co-authored-by: yuanzhang <yuanzhang@yuanzhangdeMacBook-Pro.local> * [Doc] Add Chinese doc for inference.md (#617) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * inference_zh_md * Update docs_zh-CN/inference.md Directly delete this sentence? Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * qwe * temp * qw * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update inference.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * fixed some dir * fixed typo Co-authored-by: MengzhangLI <mcmong@pku.edu.cn> Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> Co-authored-by: yuanzhang <yuanzhang@yuanzhangdeMacBook-Pro.local>

* Add chinese doc base (open-mmlab#593) * [Doc] Add Chinese doc for useful_tools_md (open-mmlab#642) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * dataset_prepare * useful_tools * refine * Update useful_tools.md * Update useful_tools.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for get_started (open-mmlab#615) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * get_started_md * refine_get_started_md * [Doc] Add Chinese doc for tutorial03_tutorial_datapipeline_md (open-mmlab#629) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * refine * Update data_pipeline.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials04_customized_models_md (open-mmlab#630) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * refine * refine * Update customize_models.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for dataset_prepare_md (open-mmlab#640) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * dataset_prepare * Update dataset_prepare.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials05_training_tricks_md (open-mmlab#631) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * traning tricks md * traning tricks md * refine * refine * refine * Update training_tricks.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials06_customized_runtime_md (open-mmlab#637) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * pipeline * cus_model * cus_model * cus_model * runtime_md * Update customize_runtime.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for tutorials01_config_md (open-mmlab#628) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * new_config_md * new_config_md1 * new_config_md1 * refine * refine * Update config.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese for modelzoo (open-mmlab#597) * [Doc] Add Chinese for modelzoo * add missing * [Doc] Add Chinese doc for tutorial02_customized_dataset_md (open-mmlab#620) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * tutorial_customized_dataset * refine * Update customize_datasets.md * fixconflict Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * [Doc] Add Chinese doc for train.md (open-mmlab#616) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * train_md * refine * refine_last * refine_last * refine_last * refine_last * refine_last * temp * refine_last * qwe Co-authored-by: yuanzhang <yuanzhang@yuanzhangdeMacBook-Pro.local> * [Doc] Add Chinese doc for inference.md (open-mmlab#617) * get_started_docs_zh * inference_zh.md * train_zh.md * get_started_zh.md * train_zh.md * get_started_zh * fix nospace between ZH and ENG * change README_zh-CN link * checkout space again * checkout space again * checkout space again * inference_zh_md * Update docs_zh-CN/inference.md Directly delete this sentence? Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * qwe * temp * qw * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update docs_zh-CN/inference.md * Update inference.md Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> * fixed some dir * fixed typo Co-authored-by: MengzhangLI <mcmong@pku.edu.cn> Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn> Co-authored-by: yuanzhang <yuanzhang@yuanzhangdeMacBook-Pro.local>

MengzhangLI added 12 commits June 12, 2021 23:31

get_started_docs_zh

8a9deea

inference_zh.md

5369c21

train_zh.md

04d2e67

get_started_zh.md

178194e

train_zh.md

5d9055a

get_started_zh

60cbc6e

fix nospace between ZH and ENG

da616df

change README_zh-CN link

6adb79e

checkout space again

12afb80

checkout space again

6ddb19d

checkout space again

42908c5

get_started_md

b942fbb

Junjun2016 reviewed Jun 23, 2021

View reviewed changes

xvjiarui reviewed Jun 27, 2021

View reviewed changes

refine_get_started_md

7f609cf

Junjun2016 merged commit b2dd7c9 into open-mmlab:doc_zh Jul 2, 2021

MengzhangLI deleted the get_started_md branch February 1, 2022 03:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Add Chinese doc for get_started #615

[Doc] Add Chinese doc for get_started #615

MengzhangLI commented Jun 22, 2021

codecov bot commented Jun 22, 2021 •

edited

Loading

Junjun2016 Jun 23, 2021

Junjun2016 Jun 23, 2021

Junjun2016 Jun 23, 2021

Junjun2016 Jun 23, 2021

xvjiarui Jun 27, 2021

xvjiarui Jun 27, 2021

		@@ -1 +1,208 @@
		## 依赖

		- Linux or macOS (Windows下支持需要mmcv-full，但运行时可能会有一些问题。)

	- Linux or macOS (Windows下支持需要mmcv-full，但运行时可能会有一些问题。)
	- Linux or macOS (Windows 下支持需要 mmcv-full，但运行时可能会有一些问题。)

	或者您需要从网上下载cl编译工具并安装至路径。
	或者您需要从网上下载 cl 编译工具并安装至路径。

	# 测试一个视频并得到结果
	# 测试一个视频并得到分割结果


		当您完成 MMSegmentation 的安装时，上述代码应该可以成功运行。

		我们还提供一个 demo 脚本去测试单张图片：

	我们还提供一个 demo 脚本去测试单张图片：
	我们还提供一个 demo 脚本去可视化单张图片：

[Doc] Add Chinese doc for get_started #615

[Doc] Add Chinese doc for get_started #615

Conversation

MengzhangLI commented Jun 22, 2021

codecov bot commented Jun 22, 2021 • edited Loading

Codecov Report

Junjun2016 Jun 23, 2021

Choose a reason for hiding this comment

Junjun2016 Jun 23, 2021

Choose a reason for hiding this comment

Junjun2016 Jun 23, 2021

Choose a reason for hiding this comment

Junjun2016 Jun 23, 2021

Choose a reason for hiding this comment

xvjiarui Jun 27, 2021

Choose a reason for hiding this comment

xvjiarui Jun 27, 2021

Choose a reason for hiding this comment

codecov bot commented Jun 22, 2021 •

edited

Loading