add ultralytics model card

README.md

@@ -1,3 +1,4 @@
+ 
 ---
 tags:
 - ultralyticsplus
@@ -7,171 +8,64 @@ tags:
 - vision
 - object-detection
 - pytorch
-- awesome-yolov8-models
-- table classification
-- structured table detection
-- unstructured table detection
-- table detection
-- table
-- Document
-- table extraction
-- unstructured table extraction
+
 library_name: ultralytics
 library_version: 8.0.43
-inference: False
+inference: false
+
 model-index:
 - name: foduucom/table-detection-and-extraction
   results:
   - task:
       type: object-detection
-    metrics:
-    - type: precision
-      value: 0.962
-      name: [email protected](box)
-language:
-- en
-metrics:
-- accuracy
----
-Below is the Model Card for the YOLOv8s Table Detection and Extraction model:
 
+    metrics:
+      - type: precision  # since [email protected] is not available on hf.co/metrics
+        value: 0.96196  # min: 0.0 - max: 1.0
+        name: [email protected](box)
 ---
 
-<p align="center">
-<!-- Smaller size image -->
-<img src="https://example.com/table-detection-model-thumbnail.jpg" alt="Image" style="width:500px; height:300px;">
-</p>
-
-# Model Card for YOLOv8s Table Detection
+<div align="center">
+  <img width="640" alt="foduucom/table-detection-and-extraction" src="https://huggingface.co/foduucom/table-detection-and-extraction/resolve/main/thumbnail.jpg">
+</div>
 
-## Model Summary
-
-The YOLOv8s Table Detection model is an object detection model based on the YOLO (You Only Look Once) framework. It is designed to detect tables, whether they are bordered or borderless, in images. The model has been fine-tuned on a vast dataset and achieved high accuracy in detecting tables and distinguishing between bordered and borderless ones.
-
-## Model Details
-
-### Model Description
-
-The YOLOv8s Table Detection model is built upon the YOLOv8 architecture, known for its real-time object detection capabilities. This specific model has been tailored and trained to recognize tables of various types, including those with borders and those without borders. It can accurately detect tables in images and classify them into the appropriate categories.
+### Supported Labels
 
 ```
-['Bordered','Borderless']
+['bordered', 'borderless']
 ```
-- **Developed by:** FODUU AI
-- **Model type:** Object Detection
-- **Task:** Table Detection (Bordered and Borderless)
-
-Furthermore, the YOLOv8s Table Detection model encourages user collaboration by providing the capability for users to contribute their own table images. Users can submit images of different table designs and types, helping to enhance the model's ability to detect a wider variety of tables accurately. User contributions can be shared through our community platform or by contacting us at [email protected]. Your input will significantly contribute to improving the model's recognition and classification of diverse table types.
-
-## Uses
-
-### Direct Use
-The YOLOv8s Table Detection model serves as a versatile solution for precisely identifying tables within images, whether they exhibit a bordered or borderless design. Notably, this model's capabilities extend beyond mere detection – it plays a crucial role in addressing the complexities of unstructured documents. By employing advanced techniques such as bounding box delineation, the model enables users to isolate tables of interest within the visual content.
-
-What sets this model apart is its synergy with Optical Character Recognition (OCR) technology. This seamless integration empowers the model to not only locate tables but also to extract pertinent data contained within. The bounding box information guides the cropping of tables, which is then coupled with OCR to meticulously extract textual data, streamlining the process of information retrieval from unstructured documents.
-
-We invite you to explore the potential of this model and its data extraction capabilities. For those interested in harnessing its power or seeking further collaboration, we encourage you to reach out to us at [email protected]. Whether you require assistance, customization, or have innovative ideas, our collaborative approach is geared towards addressing your unique challenges. Additionally, you can actively engage with our vibrant community section for valuable insights and collective problem-solving. Your input drives our continuous improvement, as we collectively pave the way towards enhanced data extraction and document analysis.
-
-### Downstream Use
-
-The model can also be fine-tuned for specific table detection tasks or integrated into larger applications for furniture recognition, interior design, image-based data extraction, and other related fields.
-
-### Out-of-Scope Use
-
-The model is not designed for unrelated object detection tasks or scenarios outside the scope of table detection.
-
-## Bias, Risks, and Limitations
-
-The YOLOv8s Table Detection model may have some limitations and biases:
-
-- Performance may vary based on the quality, diversity, and representativeness of the training data.
-- The model may face challenges in detecting tables with intricate designs or complex arrangements.
-- Accuracy may be affected by variations in lighting conditions, image quality, and resolution.
-- Detection of very small or distant tables might be less accurate.
-- The model's ability to classify bordered and borderless tables may be influenced by variations in design.
 
-### Recommendations
+### How to use
 
-Users should be informed about the model's limitations and potential biases. Further testing and validation are advised for specific use cases to evaluate its performance accurately.
-
-## How to Get Started with the Model
-
-To begin using the YOLOv8s Table Detection model, follow these steps:
-
-1. Install the required libraries, such as [ultralyticsplus](https://github.com/fcakyon/ultralyticsplus) and [ultralytics](https://github.com/ultralytics/ultralytics), using pip:
+- Install [ultralyticsplus](https://github.com/fcakyon/ultralyticsplus):
 
 ```bash
-pip install ultralyticsplus ultralytics
+pip install ultralyticsplus==0.0.28 ultralytics==8.0.43
 ```
 
-2. Load the model and perform predictions using the provided code snippet.
+- Load model and perform prediction:
 
 ```python
 from ultralyticsplus import YOLO, render_result
 
-# Load model
+# load model
 model = YOLO('foduucom/table-detection-and-extraction')
 
-# Set model parameters
+# set model parameters
 model.overrides['conf'] = 0.25  # NMS confidence threshold
-model.overrides['iou'] = 0.45   # NMS IoU threshold
+model.overrides['iou'] = 0.45  # NMS IoU threshold
 model.overrides['agnostic_nms'] = False  # NMS class-agnostic
-model.overrides['max_det'] = 1000  # Maximum number of detections per image
+model.overrides['max_det'] = 1000  # maximum number of detections per image
 
-# Set image
-image = 'path/to/your/image'
+# set image
+image = 'https://github.com/ultralytics/yolov5/raw/master/data/images/zidane.jpg'
 
-# Perform inference
+# perform inference
 results = model.predict(image)
 
-# Observe results
+# observe results
 print(results[0].boxes)
 render = render_result(model=model, image=image, result=results[0])
 render.show()
 ```
 
-## Training Details
-
-### Training Data
-
-The model is trained on a diverse dataset containing images of tables from various sources. The dataset includes examples of both bordered and borderless tables, capturing different designs and styles.
-
-### Training Procedure
-
-The training process involves extensive computation and is conducted over multiple epochs. The model's weights are adjusted to minimize detection loss and optimize performance.
-
-#### Metrics
-
-- [email protected] (box): 
-  - All: 0.962
-  - Bordered: 0.961
-  - Borderless: 0.963
-
-### Model Architecture and Objective
-
-The YOLOv8s architecture employs a modified CSPDarknet53 as its backbone, along with self-attention mechanisms and feature pyramid networks. These components contribute to the model's ability to detect and classify tables accurately, considering variations in size, design, and style.
-
-### Compute Infrastructure
-
-#### Hardware
-
-NVIDIA GeForce RTX 3060
-
-#### Software
-
-The model was trained and fine-tuned using a Jupyter Notebook environment.
-
-## Model Card Contact
-
-For inquiries and contributions, please contact us at [email protected].
-
-```bibtex
-@ModelCard{
-  author    = {Nehul Agrawal and
-               Pranjal singh Thakur},
-  title     = { Table Detection and Extraction},
-  year      = {2023}
-}
-```
----
-