Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

[Docs] Data_preparation CN docs. #736

Merged
merged 11 commits into from
Mar 24, 2021
Merged

[Docs] Data_preparation CN docs. #736

merged 11 commits into from
Mar 24, 2021

Conversation

congee524
Copy link
Contributor

No description provided.

@congee524
Copy link
Contributor Author

The second half was left to @kennymckormick

@kennymckormick
Copy link
Member

The second half was left to @kennymckormick

OK, I will continue in this PR.

@kennymckormick kennymckormick changed the title [Docs] The First Half of data_preparation CN docs. [Docs] Data_preparation CN docs. Mar 18, 2021
@kennymckormick kennymckormick added the WIP work in progress label Mar 18, 2021
@kennymckormick kennymckormick removed the WIP work in progress label Mar 18, 2021
kennymckormick
kennymckormick reviewed Mar 18, 2021
View reviewed changes
@congee524 congee524 force-pushed the cn_data_preparation branch from 6e651cf to 05f1834 Compare March 18, 2021 09:43
@codecov
Copy link

codecov bot commented Mar 18, 2021 •
edited
Loading

Codecov Report

Merging #736 (6a050f4) into master (ced53ac) will not change coverage.
The diff coverage is n/a.

❗ Current head 6a050f4 differs from pull request most recent head 85b407c. Consider uploading reports for the commit 85b407c to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #736   +/-   ##
=======================================
  Coverage   84.59%   84.59%           
=======================================
  Files         130      130           
  Lines        9357     9357           
  Branches     1578     1578           
=======================================
  Hits         7916     7916           
  Misses       1042     1042           
  Partials      399      399
Flag Coverage Δ
unittests 84.58% <ø> (ø)

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 ced53ac...85b407c. Read the comment docs.

irvingzhang0512
irvingzhang0512 reviewed Mar 18, 2021
View reviewed changes
docs_zh_CN/data_preparation.md Outdated

## 获取数据

下面的指南能为用户在自定义数据集上实验，提供一些帮助。
Copy link
Contributor

@irvingzhang0512 irvingzhang0512 Mar 18, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

本节介绍如何构建自定义数据集

@irvingzhang0512
Copy link
Contributor

提个与本PR无关，但与中文文档相关的建议……

在文档首页有一句描述 You can switch between Chinese and English documents in the lower-left corner of the layout.
不如在这句话之前加一句话，并附上 中文文档的超链接（而不是让用户自己移动到左下方去找……）。

中文文档同理，加上英文文档的超链接……

@congee524
Copy link
Contributor Author

提个与本PR无关，但与中文文档相关的建议……

在文档首页有一句描述 You can switch between Chinese and English documents in the lower-left corner of the layout.
不如在这句话之前加一句话，并附上 中文文档的超链接（而不是让用户自己移动到左下方去找……）。

中文文档同理，加上英文文档的超链接……

这个主要是考虑到提醒用户，可以在同一文档下进行切换。
如果正在读 get_starting，他可以直接切换到中文版的同一页面 简易教程
我们在目录导航区最下面也单独放了两个显眼的链接，那个应该容易看到。

@irvingzhang0512
Copy link
Contributor

这个主要是考虑到提醒用户，可以在同一文档下进行切换。
如果正在读 get_starting，他可以直接切换到中文版的同一页面 简易教程

这个实现了吗？我进入 Getting Started 英文版，好像没看到相关功能？
image

我们在目录导航区最下面也单独放了两个显眼的链接，那个应该容易看到。

个人感觉， 导航栏 最下面 就意味着 不容易看到。如果不知道那里有中英文转换功能，一般也不会拉到导航栏最下面。

我想说的是，类似目前 README 中英文切换的形式可能更清楚一些。

image

@congee524
Copy link
Contributor Author

@irvingzhang0512 最正统的切换方式在这里

image

实际上，用户并不总是从 index 页面进入中文教程，所以最好在导航页放一个，在下面主要考虑不影响阅读体验。

@congee524
Copy link
Contributor Author

但这个区域因为平时是被折叠起来，所以确实需要明显的提示，暂时没想到很好的方法

@innerlee innerlee merged commit 2b6f0d0 into open-mmlab:master Mar 24, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@irvingzhang0512 irvingzhang0512 irvingzhang0512 left review comments

@kennymckormick kennymckormick kennymckormick left review comments

@innerlee innerlee innerlee approved these changes

@dreamerlin dreamerlin Awaiting requested review from dreamerlin

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@congee524 @kennymckormick @irvingzhang0512 @innerlee