Add the MFD Model for detecting mathematic formula regions (#59)

* Add the MFD models in the model catalog

* Update new models in the documentation

* Add the mfd model config in test

Author: lolipopshock

docs/notes/modelzoo.md

@@ -28,6 +28,8 @@ model.detect(image)
 | [NewspaperNavigator](https://news-navigator.labs.loc.gov/)            | [faster_rcnn_R_50_FPN_3x](https://www.dropbox.com/s/wnido8pk4oubyzr/config.yml?dl=1)       | lp://NewspaperNavigator/faster_rcnn_R_50_FPN_3x/config |                                                                           |
 | [TableBank](https://doc-analysis.github.io/tablebank-page/index.html) | [faster_rcnn_R_50_FPN_3x](https://www.dropbox.com/s/7cqle02do7ah7k4/config.yaml?dl=1)      | lp://TableBank/faster_rcnn_R_50_FPN_3x/config          | 89.78 [eval.csv](https://www.dropbox.com/s/1uwnz58hxf96iw2/eval.csv?dl=0) |
 | [TableBank](https://doc-analysis.github.io/tablebank-page/index.html) | [faster_rcnn_R_101_FPN_3x](https://www.dropbox.com/s/h63n6nv51kfl923/config.yaml?dl=1)     | lp://TableBank/faster_rcnn_R_101_FPN_3x/config         | 91.26 [eval.csv](https://www.dropbox.com/s/e1kq8thkj2id1li/eval.csv?dl=0) |
+| [Math Formula Detection(MFD)](http://transcriptorium.eu/~htrcontest/MathsICDAR2021/) | [faster_rcnn_R_50_FPN_3x](https://www.dropbox.com/s/ld9izb95f19369w/config.yaml?dl=1)     | lp://MFD/faster_rcnn_R_50_FPN_3x/config         | 79.68 [eval.csv](https://www.dropbox.com/s/1yvrs29jjybrlpw/eval.csv?dl=0) |
+
 
 * For PubLayNet models, we suggest using `mask_rcnn_X_101_32x8d_FPN_3x` model as it's trained on the whole training set, while others are only trained on the validation set (the size is only around 1/50). You could expect a 15% AP improvement using the `mask_rcnn_X_101_32x8d_FPN_3x` model.
 
@@ -39,4 +41,5 @@ model.detect(image)
 | [PubLayNet](https://github.com/ibm-aur-nlp/PubLayNet)        | `{0: "Text", 1: "Title", 2: "List", 3:"Table", 4:"Figure"}`     |
 | [PrimaLayout](https://www.primaresearch.org/dataset/)        | `{1:"TextRegion", 2:"ImageRegion", 3:"TableRegion", 4:"MathsRegion", 5:"SeparatorRegion", 6:"OtherRegion"}` |
 | [NewspaperNavigator](https://news-navigator.labs.loc.gov/)        | `{0: "Photograph", 1: "Illustration", 2: "Map", 3: "Comics/Cartoon", 4: "Editorial Cartoon", 5: "Headline", 6: "Advertisement"}` |
-| [TableBank](https://doc-analysis.github.io/tablebank-page/index.html)         | `{0: "Table"}` |
+| [TableBank](https://doc-analysis.github.io/tablebank-page/index.html)         | `{0: "Table"}` |
+| [MFD](http://transcriptorium.eu/~htrcontest/MathsICDAR2021/)         | `{1: "Equation"}` |

src/layoutparser/models/detectron2/catalog.py

@@ -23,6 +23,9 @@
         "faster_rcnn_R_50_FPN_3x": "https://www.dropbox.com/s/8v4uqmz1at9v72a/model_final.pth?dl=1",
         "faster_rcnn_R_101_FPN_3x": "https://www.dropbox.com/s/6vzfk8lk9xvyitg/model_final.pth?dl=1",
     },
+    "MFD": {
+        "faster_rcnn_R_50_FPN_3x": "https://www.dropbox.com/s/7xel0i3iqpm2p8y/model_final.pth?dl=1",
+    },
 }
 
 CONFIG_CATALOG = {
@@ -46,6 +49,9 @@
         "faster_rcnn_R_50_FPN_3x": "https://www.dropbox.com/s/7cqle02do7ah7k4/config.yaml?dl=1",
         "faster_rcnn_R_101_FPN_3x": "https://www.dropbox.com/s/h63n6nv51kfl923/config.yaml?dl=1",
     },
+    "MFD": {
+        "faster_rcnn_R_50_FPN_3x": "https://www.dropbox.com/s/ld9izb95f19369w/config.yaml?dl=1",
+    },
 }
 
 # fmt: off
@@ -85,6 +91,9 @@
     "TableBank": {
         0: "Table"
     },
+    "MFD": {
+        1: "Equation"
+    },
 }
 # fmt: on
 

tests/test_model.py

@@ -2,7 +2,7 @@
 from layoutparser.models import *
 import cv2
 
-ALL_CONFIGS = [
+ALL_DETECTRON2_MODEL_CONFIGS = [
     "lp://PrimaLayout/mask_rcnn_R_50_FPN_3x/config",
     "lp://HJDataset/faster_rcnn_R_50_FPN_3x/config",
     "lp://HJDataset/mask_rcnn_R_50_FPN_3x/config",
@@ -13,9 +13,10 @@
     "lp://NewspaperNavigator/faster_rcnn_R_50_FPN_3x/config",
     "lp://TableBank/faster_rcnn_R_50_FPN_3x/config",
     "lp://TableBank/faster_rcnn_R_101_FPN_3x/config",
+    "lp://MFD/faster_rcnn_R_50_FPN_3x/config",
 ]
 
-ALL_PADDLE_CONFIGS = [
+ALL_PADDLEDETECTION_MODEL_CONFIGS = [
     "lp://PubLayNet/ppyolov2_r50vd_dcn_365e_publaynet/config",
     "lp://TableBank/ppyolov2_r50vd_dcn_365e_tableBank_word/config",
     "lp://TableBank/ppyolov2_r50vd_dcn_365e_tableBank_latex/config",
@@ -25,7 +26,7 @@ def test_Detectron2Model(is_large_scale=False):
 
     if is_large_scale:
 
-        for config in ALL_CONFIGS:
+        for config in ALL_DETECTRON2_MODEL_CONFIGS:
             model = Detectron2LayoutModel(config)
 
             image = cv2.imread("tests/fixtures/model/test_model_image.jpg")
@@ -58,7 +59,7 @@ def test_PaddleDetectionModel(is_large_scale=False):
     """ test PaddleDetection model """
     if is_large_scale:
 
-        for config in ALL_PADDLE_CONFIGS:
+        for config in ALL_PADDLEDETECTION_MODEL_CONFIGS:
             model = PaddleDetectionLayoutModel(config)
 
             image = cv2.imread("tests/fixtures/model/test_model_image.jpg")