From c9211cbf47c50938a71a7972dfe4b6c91a2cce13 Mon Sep 17 00:00:00 2001
From: Taha Douaji <taha.d@alpha-apps.ae>
Date: Sat, 12 Mar 2022 12:04:43 +0000
Subject: [PATCH] Create README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a44dab5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+## Model description
+detr-doc-table-detection is a model trained to detect both Bordered and Borderless tables in documents based on [facebook/detr-resnet-50](https://huggingface.co/facebook/detr-resnet-50)
+
+## Training data
+The model was trained on ICDAR2019 Table Dataset
+
+### How to use
+
+```python
+from transformers import DetrFeatureExtractor, DetrForObjectDetection
+from PIL import Image
+import requests
+image = Image.open("Image path")
+feature_extractor = DetrFeatureExtractor.from_pretrained('TahaDouaji/detr-doc-table-detection')
+model = DetrForObjectDetection.from_pretrained('TahaDouaji/detr-doc-table-detection')
+inputs = feature_extractor(images=image, return_tensors="pt")
+outputs = model(**inputs)
+# model predicts bounding boxes and corresponding COCO classes
+logits = outputs.logits
+bboxes = outputs.pred_boxes
+```
\ No newline at end of file