From 3b9306ca7964ba3f297f01802985b862fc3ef191 Mon Sep 17 00:00:00 2001 From: Hongbin Sun Date: Wed, 12 May 2021 09:57:53 +0800 Subject: [PATCH] Hbsun/demo doc (#168) * move demo.md to demo/docs * update link in md --- .gitignore | 1 + demo/README.md | 12 ++++++------ {docs => demo/docs}/ocr_demo.md | 7 ++++++- {docs => demo/docs}/text_det_demo.md | 9 +++++++-- {docs => demo/docs}/text_recog_demo.md | 9 +++++++-- docs/index.rst | 6 ++++++ docs/merge_docs.sh | 1 + 7 files changed, 34 insertions(+), 11 deletions(-) rename {docs => demo/docs}/ocr_demo.md (74%) rename {docs => demo/docs}/text_det_demo.md (84%) rename {docs => demo/docs}/text_recog_demo.md (82%) diff --git a/.gitignore b/.gitignore index 52720295..656e5957 100644 --- a/.gitignore +++ b/.gitignore @@ -136,3 +136,4 @@ htmlcov log.txt workspace.code-workspace results +mmocr/core/font.TTF diff --git a/demo/README.md b/demo/README.md index 267dcbae..6ad00bdd 100644 --- a/demo/README.md +++ b/demo/README.md @@ -2,28 +2,28 @@ This page provides tutorials about running demos. Please click the link below for more information. -Please refer to [Text Detection](../docs/text_det_demo.md) for the tutorial of Text Detection demo. +Please refer to [Text Detection](docs/text_det_demo.md) for the tutorial of Text Detection demo.
-
+


-Please refer to [Text Recognition](../docs/text_recog_demo.md) for the tutorial of Text Recognition demo. +Please refer to [Text Recognition](docs/text_recog_demo.md) for the tutorial of Text Recognition demo.
-
+


-Please refer to [End2End Demo](../docs/ocr_demo.md) for the tutorial of Text Detection and Recognition end-to-end demo. +Please refer to [End2End Demo](docs/ocr_demo.md) for the tutorial of Text Detection and Recognition end-to-end demo.
-
+
diff --git a/docs/ocr_demo.md b/demo/docs/ocr_demo.md similarity index 74% rename from docs/ocr_demo.md rename to demo/docs/ocr_demo.md index 5d85456f..98b33c36 100644 --- a/docs/ocr_demo.md +++ b/demo/docs/ocr_demo.md @@ -1,5 +1,10 @@ ## OCR End2End Demo +
+
+ +
+ ### End-to-End Test Image Demo To end-to-end test a single image with text detection and recognition simutaneously: @@ -8,7 +13,7 @@ To end-to-end test a single image with text detection and recognition simutaneou python demo/ocr_image_demo.py demo/demo_text_det.jpg demo/output.jpg ``` -- The default config for text detection and recognition are [PSENet_ICDAR2015](../configs/textdet/psenet/psenet_r50_fpnf_600e_icdar2015.py) and [SAR](../configs/textrecog/sar/sar_r31_parallel_decoder_academic.py), respectively. +- The default config for text detection and recognition are [PSENet_ICDAR2015](/configs/textdet/psenet/psenet_r50_fpnf_600e_icdar2015.py) and [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py), respectively. - The predicted result will be saved as `demo/output.jpg`. - To use other algorithms of text detection and recognition, please set arguments: `--det-config`, `--det-ckpt`, `--recog-config`, `--recog-ckpt`. diff --git a/docs/text_det_demo.md b/demo/docs/text_det_demo.md similarity index 84% rename from docs/text_det_demo.md rename to demo/docs/text_det_demo.md index 732ae90a..7b53ac67 100644 --- a/docs/text_det_demo.md +++ b/demo/docs/text_det_demo.md @@ -1,13 +1,18 @@ ## Text Detection Demo +
+
+ +
+ ### Text Detection Image Demo -We provide a demo script to test a [single image](../demo/demo_text_det.jpg) for text detection with a single GPU. +We provide a demo script to test a [single image](/demo/demo_text_det.jpg) for text detection with a single GPU. *Text Detection Model Preparation:* The pre-trained text detection model can be downloaded from [model zoo](https://mmocr.readthedocs.io/en/latest/modelzoo.html). -Take [PANet](../configs/textdet/panet/panet_r18_fpem_ffm_600e_icdar2015.py) as an example: +Take [PANet](/configs/textdet/panet/panet_r18_fpem_ffm_600e_icdar2015.py) as an example: ```shell python demo/image_demo.py ${TEST_IMG} ${CONFIG_FILE} ${CHECKPOINT_FILE} ${SAVE_PATH} [--imshow] [--device ${GPU_ID}] diff --git a/docs/text_recog_demo.md b/demo/docs/text_recog_demo.md similarity index 82% rename from docs/text_recog_demo.md rename to demo/docs/text_recog_demo.md index 74c3f9fb..67051fbd 100644 --- a/docs/text_recog_demo.md +++ b/demo/docs/text_recog_demo.md @@ -1,13 +1,18 @@ ## Text Recognition Demo +
+
+ +
+ ### Text Recognition Image Demo -We provide a demo script to test a [single demo image](../demo/demo_text_recog.jpg) for text recognition with a single GPU. +We provide a demo script to test a [single demo image](/demo/demo_text_recog.jpg) for text recognition with a single GPU. *Text Recognition Model Preparation:* The pre-trained text recognition model can be downloaded from [model zoo](https://mmocr.readthedocs.io/en/latest/modelzoo.html). -Take [SAR](../configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) as an example: +Take [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) as an example: ```shell python demo/image_demo.py ${TEST_IMG} ${CONFIG_FILE} ${CHECKPOINT_FILE} ${SAVE_PATH} [--imshow] [--device ${GPU_ID}] diff --git a/docs/index.rst b/docs/index.rst index cba595a1..ddf7a193 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,12 @@ Welcome to MMOCR's documentation! ======================================= +.. toctree:: + :maxdepth: 2 + :caption: Demo + + demo.md + .. toctree:: :maxdepth: 2 :caption: Get Started diff --git a/docs/merge_docs.sh b/docs/merge_docs.sh index b50e12c2..23f113d6 100755 --- a/docs/merge_docs.sh +++ b/docs/merge_docs.sh @@ -8,3 +8,4 @@ sed -i '$a\\n' ../configs/textrecog/*/*.md cat ../configs/kie/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Key Information Extraction Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >kie_models.md cat ../configs/textdet/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Text Detection Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >textdet_models.md cat ../configs/textrecog/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Text Recognition Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >textrecog_models.md +cat ../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# Demo' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >demo.md