oclip readthe docs

open-mmlab · Nov 3, 2022 · 2adab61 · 2adab61
1 parent c528c70
commit 2adab61
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 50 deletions.
diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -111,7 +111,7 @@ pip3 install -e .
 支持的算法：
 
 <details open>
-<summary>BackBone</summary>
+<summary>骨干网络</summary>
 
 - [x] [oCLIP](configs/backbone/oclip/README.md) (ECCV'2022)
 

diff --git a/configs/backbone/oclip/README.md b/configs/backbone/oclip/README.md
@@ -1,6 +1,6 @@
 # oCLIP
 
-> [Language Matters: A Weakly Supervised Vision-Language Pre-training Approach for Scene Text Detection and Spotting](https://arxiv.org/abs/2203.03911)
+> [Language Matters: A Weakly Supervised Vision-Language Pre-training Approach for Scene Text Detection and Spotting](https://www.ecva.net/papers/eccv_2022/papers_ECCV/papers/136880282.pdf)
 
 <!-- [ALGORITHM] -->
 
@@ -12,12 +12,22 @@ Recently, Vision-Language Pre-training (VLP) techniques have greatly benefited v
 <img src="https://user-images.githubusercontent.com/24622904/199475057-aa688422-518d-4d7a-86fc-1be0cc1b5dc6.png"/>
 </div>
 
-## Support Model
+## Models
 
-|           | DBNet | DBNet++ | FCENet | TextSnake | PSENet | DRRG | Mask R-CNN |
-| :-------: | :---: | :-----: | :----: | :-------: | :----: | :--: | :--------: |
-| ICDAR2015 |   ✓   |    ✓    |   ✓    |           |   ✓    |      |     ✓      |
-|  CTW1500  |       |         |        |     ✓     |   ✓    |  ✓   |     ✓      |
+| Backbone  | Pre-train Data | Model |
+| :-------: | :------------: | :---: |
+| ResNet-50 |   SynthText    |       |
+
+```{note}
+The model is converted from the official [oCLIP](ghttps://github.com/bytedance/oclip.it).
+```
+
+## Support Text Detection Models
+
+|           | [DBNet](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#dbnet) | [DBNet++](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#dbnetpp) | [FCENet](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#fcenet) | [TextSnake](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#fcenet) | [PSENet](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#psenet) | [DRRG](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#drrg) | [Mask R-CNN](https://mmocr.readthedocs.io/en/dev-1.x/textdet_models.html#mask-r-cnn) |
+| :-------: | :------------------------------------------------------------------------: | :----------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | :-----------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------: |
+| ICDAR2015 |                                     ✓                                      |                                       ✓                                        |                                      ✓                                       |                                                                                 |                                      ✓                                       |                                                                          |                                          ✓                                           |
+|  CTW1500  |                                                                            |                                                                                |                                                                              |                                        ✓                                        |                                      ✓                                       |                                    ✓                                     |                                          ✓                                           |
 
 ## Citation
 

diff --git a/configs/textdet/dbnet/README.md b/configs/textdet/dbnet/README.md
@@ -16,11 +16,11 @@ Recently, segmentation-based methods are quite popular in scene text detection,
 
 ### ICDAR2015
 
-|                  Method                  |                  Pretrained Model                   |  Training set   |    Test set    | #epochs | Test size | Precision | Recall | Hmean  |                  Download                   |
-| :--------------------------------------: | :-------------------------------------------------: | :-------------: | :------------: | :-----: | :-------: | :-------: | :----: | :----: | :-----------------------------------------: |
-| [DBNet_r18](/configs/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015.py) |                      ImageNet                       | ICDAR2015 Train | ICDAR2015 Test |  1200   |    736    |  0.8853   | 0.7583 | 0.8169 | [model](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015/dbnet_resnet18_fpnc_1200e_icdar2015_20220825_221614-7c0e94f2.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015/20220825_221614.log) |
-| [DBNet_r50dcn](/configs/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015.py) | [Synthtext](https://download.openmmlab.com/mmocr/textdet/dbnet/tmp_1.0_pretrain/dbnet_r50dcnv2_fpnc_sbn_2e_synthtext_20210325-ed322016.pth) | ICDAR2015 Train | ICDAR2015 Test |  1200   |   1024    |  0.8784   | 0.8315 | 0.8543 | [model](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015_20220828_124917-452c443c.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015/20220828_124917.log) |
-| [DBNet_oclip-r50](/configs/textdet/dbnet/dbnet_oclip-resnet50_fpnc_1200e_icdar2015.py) | [Synthtext](https://download.openmmlab.com/mmocr/textdet/dbnet/tmp_1.0_pretrain/dbnet_r50dcnv2_fpnc_sbn_2e_synthtext_20210325-ed322016.pth) | ICDAR2015 Train | ICDAR2015 Test |  1200   |           |           |        |        |          [model](<>) \| [log](<>)           |
+|               Method               |       Backbone       |               Pretrained Model               |  Training set   |    Test set    | #epochs | Test size | Precision | Recall | Hmean  |               Download               |
+| :--------------------------------: | :------------------: | :------------------------------------------: | :-------------: | :------------: | :-----: | :-------: | :-------: | :----: | :----: | :----------------------------------: |
+| [DBNet_r18](/configs/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015.py) |       ResNet18       |                      -                       | ICDAR2015 Train | ICDAR2015 Test |  1200   |    736    |  0.8853   | 0.7583 | 0.8169 | [model](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015/dbnet_resnet18_fpnc_1200e_icdar2015_20220825_221614-7c0e94f2.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015/20220825_221614.log) |
+| [DBNet_r50dcn](/configs/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015.py) |       ResNet50       | [Synthtext](https://download.openmmlab.com/mmocr/textdet/dbnet/tmp_1.0_pretrain/dbnet_r50dcnv2_fpnc_sbn_2e_synthtext_20210325-ed322016.pth) | ICDAR2015 Train | ICDAR2015 Test |  1200   |   1024    |  0.8784   | 0.8315 | 0.8543 | [model](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015_20220828_124917-452c443c.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnet/dbnet_resnet50-dcnv2_fpnc_1200e_icdar2015/20220828_124917.log) |
+| [DBNet_oclip-r50](/configs/textdet/dbnet/dbnet_oclip-resnet50_fpnc_1200e_icdar2015.py) | [oCLIP-ResNet50](<>) |                      -                       | ICDAR2015 Train | ICDAR2015 Test |  1200   |           |           |        |        |       [model](<>) \| [log](<>)       |
 
 ## Citation
 

diff --git a/configs/textdet/dbnetpp/README.md b/configs/textdet/dbnetpp/README.md
@@ -16,10 +16,10 @@ Recently, segmentation-based scene text detection methods have drawn extensive a
 
 ### ICDAR2015
 
-|                  Method                  |                  Pretrained Model                   |  Training set   |    Test set    | #epochs | Test size | Precision | Recall | Hmean  |                  Download                   |
-| :--------------------------------------: | :-------------------------------------------------: | :-------------: | :------------: | :-----: | :-------: | :-------: | :----: | :----: | :-----------------------------------------: |
-| [DBNetpp_r50dcn](/configs/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015.py) | [Synthtext](/configs/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_100k_synthtext.py) ([model](https://download.openmmlab.com/mmocr/textdet/dbnetpp/tmp_1.0_pretrain/dbnetpp_r50dcnv2_fpnc_100k_iter_synthtext-20220502-352fec8a.pth)) | ICDAR2015 Train | ICDAR2015 Test |  1200   |   1024    |  0.9116   | 0.8291 | 0.8684 | [model](https://download.openmmlab.com/mmocr/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015_20220829_230108-f289bd20.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015/20220829_230108.log) |
-| [DBNetpp_oclip-r50](/configs/textdet/dbnetpp/dbnetpp_oclip-resnet50_fpnc_1200e_icdar2015.py) |                          -                          | ICDAR2015 Train | ICDAR2015 Test |  1200   |           |           |        |        |          [model](<>) \| [log](<>)           |
+|               Method               |       BackBone       |               Pretrained Model               |  Training set   |    Test set    | #epochs | Test size | Precision | Recall | Hmean  |               Download               |
+| :--------------------------------: | :------------------: | :------------------------------------------: | :-------------: | :------------: | :-----: | :-------: | :-------: | :----: | :----: | :----------------------------------: |
+| [DBNetpp_r50dcn](/configs/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015.py) |       ResNet50       | [Synthtext](/configs/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_100k_synthtext.py) ([model](https://download.openmmlab.com/mmocr/textdet/dbnetpp/tmp_1.0_pretrain/dbnetpp_r50dcnv2_fpnc_100k_iter_synthtext-20220502-352fec8a.pth)) | ICDAR2015 Train | ICDAR2015 Test |  1200   |   1024    |  0.9116   | 0.8291 | 0.8684 | [model](https://download.openmmlab.com/mmocr/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015_20220829_230108-f289bd20.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/dbnetpp/dbnetpp_resnet50-dcnv2_fpnc_1200e_icdar2015/20220829_230108.log) |
+| [DBNetpp_oclip-r50](/configs/textdet/dbnetpp/dbnetpp_oclip-resnet50_fpnc_1200e_icdar2015.py) | [oCLIP-ResNet50](<>) |                      -                       | ICDAR2015 Train | ICDAR2015 Test |  1200   |           |           |        |        |       [model](<>) \| [log](<>)       |
 
 ## Citation
 

diff --git a/configs/textdet/drrg/README.md b/configs/textdet/drrg/README.md
@@ -16,10 +16,10 @@ Arbitrary shape text detection is a challenging task due to the high variety and
 
 ### CTW1500
 
-|                            Method                            | Pretrained Model | Training set  |   Test set   | #epochs | Test size | Precision | Recall | Hmean  |                            Download                            |
-| :----------------------------------------------------------: | :--------------: | :-----------: | :----------: | :-----: | :-------: | :-------: | :----: | :----: | :------------------------------------------------------------: |
-| [DRRG](/configs/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500.py) |     ImageNet     | CTW1500 Train | CTW1500 Test |  1200   |    640    |  0.8775   | 0.8179 | 0.8467 | [model](https://download.openmmlab.com/mmocr/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500/drrg_resnet50_fpn-unet_1200e_ctw1500_20220827_105233-d5c702dd.pth) \\ [log](https://download.openmmlab.com/mmocr/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500/20220827_105233.log) |
-| [DRRG_oclip-r50](/configs/textdet/drrg/drrg_oclip-resnet50_fpn-unet_1200e_ctw1500.py) |        -         | CTW1500 Train | CTW1500 Test |  1200   |           |           |        |        |                    [model](<>) \\ [log](<>)                    |
+|                       Method                       |       BackBone       | Pretrained Model | Training set  |   Test set   | #epochs | Test size | Precision | Recall | Hmean  |                       Download                       |
+| :------------------------------------------------: | :------------------: | :--------------: | :-----------: | :----------: | :-----: | :-------: | :-------: | :----: | :----: | :--------------------------------------------------: |
+| [DRRG](/configs/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500.py) |       ResNet50       |        -         | CTW1500 Train | CTW1500 Test |  1200   |    640    |  0.8775   | 0.8179 | 0.8467 | [model](https://download.openmmlab.com/mmocr/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500/drrg_resnet50_fpn-unet_1200e_ctw1500_20220827_105233-d5c702dd.pth) \\ [log](https://download.openmmlab.com/mmocr/textdet/drrg/drrg_resnet50_fpn-unet_1200e_ctw1500/20220827_105233.log) |
+| [DRRG_oclip-r50](/configs/textdet/drrg/drrg_oclip-resnet50_fpn-unet_1200e_ctw1500.py) | [oCLIP-ResNet50](<>) |        -         | CTW1500 Train | CTW1500 Test |  1200   |           |           |        |        |               [model](<>) \\ [log](<>)               |
 
 ## Citation
 

diff --git a/configs/textdet/fcenet/README.md b/configs/textdet/fcenet/README.md
@@ -16,17 +16,17 @@ One of the main challenges for arbitrary-shaped text detection is to design a go
 
 ### CTW1500
 
-|                       Method                        |     Backbone     | Pretrained Model | Training set  |   Test set   | #epochs |  Test size  | Precision | Recall | Hmean  |                       Download                        |
-| :-------------------------------------------------: | :--------------: | :--------------: | :-----------: | :----------: | :-----: | :---------: | :-------: | :----: | :----: | :---------------------------------------------------: |
-| [FCENet](/configs/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500.py) | ResNet50 + DCNv2 |     ImageNet     | CTW1500 Train | CTW1500 Test |  1500   | (736, 1080) |  0.8689   | 0.8296 | 0.8488 | [model](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500_20220825_221510-4d705392.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500/20220825_221510.log) |
-| [FCENet_oclip-r50](/configs/textdet/fcenet/fcenet_oclip-resnet50-dcnv2_fpn_1500e_ctw1500.py) |  CLIP-ResNet50   |        -         | CTW1500 Train | CTW1500 Test |  1500   |             |           |        |        |               [model](<>) \| [log](<>)                |
+|                      Method                       |       Backbone       | Pretrained Model | Training set  |   Test set   | #epochs |  Test size  | Precision | Recall | Hmean  |                      Download                       |
+| :-----------------------------------------------: | :------------------: | :--------------: | :-----------: | :----------: | :-----: | :---------: | :-------: | :----: | :----: | :-------------------------------------------------: |
+| [FCENet](/configs/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500.py) |   ResNet50 + DCNv2   |        -         | CTW1500 Train | CTW1500 Test |  1500   | (736, 1080) |  0.8689   | 0.8296 | 0.8488 | [model](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500_20220825_221510-4d705392.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50-dcnv2_fpn_1500e_ctw1500/20220825_221510.log) |
+| [FCENet_oclip-r50](/configs/textdet/fcenet/fcenet_oclip-resnet50-dcnv2_fpn_1500e_ctw1500.py) | [oCLIP-ResNet50](<>) |        -         | CTW1500 Train | CTW1500 Test |  1500   |             |           |        |        |              [model](<>) \| [log](<>)               |
 
 ### ICDAR2015
 
-|                          Method                          | Backbone | Pretrained Model | Training set | Test set  | #epochs |  Test size   | Precision | Recall | Hmean  |                          Download                           |
-| :------------------------------------------------------: | :------: | :--------------: | :----------: | :-------: | :-----: | :----------: | :-------: | :----: | :----: | :---------------------------------------------------------: |
-| [FCENet](/configs/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015.py) | ResNet50 |     ImageNet     |  IC15 Train  | IC15 Test |  1500   | (2260, 2260) |  0.8243   | 0.8834 | 0.8528 | [model](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015/fcenet_resnet50_fpn_1500e_icdar2015_20220826_140941-167d9042.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015/20220826_140941.log) |
-| [FCENet_oclip-r50](/configs/textdet/fcenet/fcenet_oclip-resnet50_fpn_1500e_icdar2015.py) | ResNet50 |        -         |  IC15 Train  | IC15 Test |  1500   | (2260, 2260) |     -     |   -    |   -    |                  [model](<>) \| [log](<>)                   |
+|                        Method                         |    Backbone    | Pretrained Model | Training set | Test set  | #epochs |  Test size   | Precision | Recall | Hmean  |                         Download                         |
+| :---------------------------------------------------: | :------------: | :--------------: | :----------: | :-------: | :-----: | :----------: | :-------: | :----: | :----: | :------------------------------------------------------: |
+| [FCENet](/configs/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015.py) |    ResNet50    |        -         |  IC15 Train  | IC15 Test |  1500   | (2260, 2260) |  0.8243   | 0.8834 | 0.8528 | [model](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015/fcenet_resnet50_fpn_1500e_icdar2015_20220826_140941-167d9042.pth) \| [log](https://download.openmmlab.com/mmocr/textdet/fcenet/fcenet_resnet50_fpn_1500e_icdar2015/20220826_140941.log) |
+| [FCENet_oclip-r50](/configs/textdet/fcenet/fcenet_oclip-resnet50_fpn_1500e_icdar2015.py) | oCLIP-ResNet50 |        -         |  IC15 Train  | IC15 Test |  1500   | (2260, 2260) |     -     |   -    |   -    |                 [model](<>) \| [log](<>)                 |
 
 ## Citation