Fix docs links #477

ShahJahanIshaq · 2023-07-04T08:44:01Z

Thank you for your contribution to the MindOCR repo.
Before submitting this PR, please make sure:

You have read the Contributing Guidelines on pull requests
Your code builds clean without any errors or warnings
You are using approved terminology
You have added unit tests

Motivation

(Write your motivation for proposed changes here.)

Test Plan

(How should this PR be tested? Do you require special setup to run the test or repro the fixed bug?)

Related Issues and PRs

(Is this PR part of a group of changes? Link the other relevant PRs and Issues here. Use https://help.github.com/en/articles/closing-issues-using-keywords for help on GitHub syntax)

SamitHuang

LGTM

hadipash

Good job!

HaoyangLee · 2023-07-05T06:45:22Z

docs/cn/tutorials/distribute_train.md

@@ -29,7 +29,7 @@

 ### 1.1 通过OpenMPI运行脚本进行训练

-在 Ascend 硬件平台上，用户可以使用 `OpenMPI` 的 `mpirun` 命令来运行 `n` 个设备的分布式训练。例如，在 [DBNet Readme](../../../configs/det/dbnet/README.md#34-training) 中，使用以下命令在设备 `0` 和设备 `1` 上训练模型：
+在 Ascend 硬件平台上，用户可以使用 `OpenMPI` 的 `mpirun` 命令来运行 `n` 个设备的分布式训练。例如，在 [DBNet Readme](../../mkdocs/dbnet_readme.md) 中，使用以下命令在设备 `0` 和设备 `1` 上训练模型：


We need to keep the doc available on both github repo and mkdocs online doc. So I prefer to change this link to absolute path (although jump out of mkdocs) instead of mkdocs path (invalid in github repo page).

HaoyangLee · 2023-07-05T06:45:54Z

docs/cn/tutorials/yaml_configuration.md

@@ -42,7 +42,7 @@

 ## 3. 模型定义参数 (model)

-在MindOCR中，模型的网络架构划分为 Transform, Backbone, Neck和Head四个模块。详细请参阅[文档](../../../mindocr/models/README.md)，以下是各部分的配置说明与例子。
+在MindOCR中，模型的网络架构划分为 Transform, Backbone, Neck和Head四个模块。详细请参阅[文档](../../mkdocs/customize_model)，以下是各部分的配置说明与例子。


We need to keep the doc available on both github repo and mkdocs online doc. So I prefer to change this link to absolute path (although jump out of mkdocs) instead of mkdocs path (invalid in github repo page).

HaoyangLee · 2023-07-05T06:46:28Z

docs/en/tutorials/distribute_train.md

@@ -29,7 +29,7 @@ On Ascend platform, some common restrictions on using the distributed service ar

 ### 1.1 Run scripts with OpenMPI

-On Ascend hardware platform, users can use OpenMPI's `mpirun` to run distributed training with `n` devices. For example, in [DBNet Readme](../../../configs/det/dbnet/README.md#34-training), the following command is used to train the model on devices `0` and `1`:
+On Ascend hardware platform, users can use OpenMPI's `mpirun` to run distributed training with `n` devices. For example, in [DBNet Readme](../../mkdocs/dbnet_readme.md), the following command is used to train the model on devices `0` and `1`:


We need to keep the doc available on both github repo and mkdocs online doc. So I prefer to change this link to absolute path (although jump out of mkdocs) instead of mkdocs path (invalid in github repo page).

HaoyangLee · 2023-07-05T06:46:56Z

docs/en/tutorials/yaml_configuration.md

@@ -39,7 +39,7 @@ Because the same parameter may need to be reused in different configuration sect

 ## 3. Model architecture (model)

-In MindOCR, the network architecture of the model is divided into four modules: Transform, Backbone, Neck and Head. For details, please refer to [documentation](../../../mindocr/models/README.md), the following are the configuration instructions and examples of each module.
+In MindOCR, the network architecture of the model is divided into four modules: Transform, Backbone, Neck and Head. For details, please refer to [documentation](../../mkdocs/customize_model), the following are the configuration instructions and examples of each module.


We need to keep the doc available on both github repo and mkdocs online doc. So I prefer to change this link to absolute path (although jump out of mkdocs) instead of mkdocs path (invalid in github repo page).

HaoyangLee · 2023-07-05T06:47:55Z

docs/cn/mkdocs/dbnet_readme.md

@@ -0,0 +1 @@
+{% include-markdown "../../../configs/det/dbnet/README_CN.md#34-training" %}


If use absolute path, then delete this file.

HaoyangLee · 2023-07-05T06:48:03Z

docs/en/mkdocs/dbnet_readme.md

@@ -0,0 +1 @@
+{% include-markdown "../../../configs/det/dbnet/README.md#34-training" %}


If use absolute path, then delete this file.

HaoyangLee · 2023-07-05T06:56:07Z

docs/en/datasets/borndigital.md

@@ -5,7 +5,7 @@
 Note: You need to register an account to download this dataset.

 <details open markdown>
-    <summary>How to Download Born-Digital Images and Annotations</summary>
+<summary>How to Download Born-Digital Images and Annotations</summary>


The <details open markdown> <summary> ... </summary> looks redundant, can remove this in all datasets .md. It;s clear enough to leave the download link and some words to explain it.
The same for Chinese datasets .md.

HaoyangLee · 2023-07-05T06:58:20Z

docs/en/datasets/totaltext.md

@@ -7,7 +7,7 @@ Total-Text [paper](https://arxiv.org/abs/1710.10400)
 Download Total-Text Images from [source](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset)  (size = 441Mb).


Suggested change

Download Total-Text Images from [source](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset) (size = 441Mb).

[Dataset github repo](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset)

docs/cn/datasets/totaltext.md

docs/cn/datasets/cocotext.md

Co-authored-by: HaoyangLI <417493727@qq.com>

…into fix-docs

docs/en/tutorials/training_detection_custom_dataset.md

ShahJahanIshaq added 6 commits July 4, 2023 16:04

fix docs doc-to-doc links

11b9cfc

fix docs docs-to-yaml links

77b15f6

fix typo in doc

dce2ed3

fix mkdocs links

98d47e7

small fix

eda1892

fix repo links

7b17e7e

SamitHuang requested review from hadipash, SamitHuang and HaoyangLee July 4, 2023 10:20

SamitHuang approved these changes Jul 4, 2023

View reviewed changes

hadipash approved these changes Jul 5, 2023

View reviewed changes

HaoyangLee reviewed Jul 5, 2023

View reviewed changes

ShahJahanIshaq and others added 6 commits July 5, 2023 17:13

change mkdocs links to abs path

96a131b

remove details tags

ccda60c

Update docs/cn/datasets/totaltext.md

bd7daeb

Co-authored-by: HaoyangLI <417493727@qq.com>

Update docs/cn/datasets/cocotext.md

681fed3

Co-authored-by: HaoyangLI <417493727@qq.com>

remove mkdocs dbnet_readme.md

0c3b9f6

Merge branch 'fix-docs' of https://github.com/ShahJahanIshaq/mindocr …

8865eea

…into fix-docs

hadipash requested a review from HaoyangLee July 6, 2023 02:20

HaoyangLee added 7 commits July 6, 2023 15:29

Update totaltext.md

122db10

Update totaltext.md

35b330a

tidy up datasets markdown files

cfa8fda

small fix

bf52916

small fix

b4260d6

small fix

0594006

fix link

1475c10

HaoyangLee reviewed Jul 6, 2023

View reviewed changes

docs/en/tutorials/training_detection_custom_dataset.md Outdated Show resolved Hide resolved

HaoyangLee approved these changes Jul 6, 2023

View reviewed changes

HaoyangLee merged commit 05018ed into mindspore-lab:main Jul 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix docs links #477

Fix docs links #477

Uh oh!

ShahJahanIshaq commented Jul 4, 2023

Uh oh!

SamitHuang left a comment

Uh oh!

hadipash left a comment

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

HaoyangLee Jul 5, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1 @@
		{% include-markdown "../../../configs/det/dbnet/README_CN.md#34-training" %}

		@@ -7,7 +7,7 @@ Total-Text [paper](https://arxiv.org/abs/1710.10400)
		Download Total-Text Images from [source](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset) (size = 441Mb).

	Download Total-Text Images from [source](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset) (size = 441Mb).
	[Dataset github repo](https://github.com/cs-chan/Total-Text-Dataset/tree/master/Dataset)

Fix docs links #477

Fix docs links #477

Uh oh!

Conversation

ShahJahanIshaq commented Jul 4, 2023

Motivation

Test Plan

Related Issues and PRs

Uh oh!

SamitHuang left a comment

Choose a reason for hiding this comment

Uh oh!

hadipash left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!