Improve model card: Add pipeline tag, update license, and expand content (#4)

- Improve model card: Add pipeline tag, update license, and expand content (7136a3f75e8b1d4d6fde197592ff385d9c3fc623)


Co-authored-by: Niels Rogge <[email protected]>

README.md

@@ -1,36 +1,82 @@
 ---
-library_name: transformers
-license: apache-2.0
 base_model: microsoft/conditional-detr-resnet-50
-tags:
-- generated_from_trainer
 datasets:
 - Voxel51/fisheye8k
+library_name: transformers
+license: mit
+tags:
+- generated_from_trainer
+pipeline_tag: object-detection
 model-index:
 - name: fisheye8k_microsoft_conditional-detr-resnet-50
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
 # fisheye8k_microsoft_conditional-detr-resnet-50
 
-This model is a fine-tuned version of [microsoft/conditional-detr-resnet-50](https://huggingface.co/microsoft/conditional-detr-resnet-50) on the generator dataset.
+This model is a fine-tuned version of [microsoft/conditional-detr-resnet-50](https://huggingface.co/microsoft/conditional-detr-resnet-50) on the [Voxel51/fisheye8k](https://huggingface.co/datasets/Voxel51/fisheye8k) dataset. It is a key artifact of the **Mcity Data Engine** project.
+
+*   **Paper**: [Mcity Data Engine: Iterative Model Improvement Through Open-Vocabulary Data Selection](https://huggingface.co/papers/2504.21614)
+*   **Project Page**: [Mcity Data Engine Docs](https://mcity.github.io/mcity_data_engine/)
+*   **Code**: [GitHub Repository for Mcity Data Engine](https://github.com/mcity/mcity_data_engine)
+
 It achieves the following results on the evaluation set:
 - Loss: 1.4466
 
 ## Model description
 
-More information needed
+This model is an object detection model fine-tuned on the `microsoft/conditional-detr-resnet-50` architecture using the Fisheye8K dataset. It is developed as part of the **Mcity Data Engine**, an open-source framework designed to facilitate iterative model improvement through open-vocabulary data selection. The Mcity Data Engine addresses the challenge of selecting and labeling appropriate samples for machine learning models, particularly for detecting long-tail and rare classes of interest in large amounts of unlabeled data within Intelligent Transportation Systems (ITS). This fine-tuned model demonstrates the practical application of the Data Engine's capabilities in enhancing roadside perception systems for autonomous driving and smart city applications.
+
+The model is trained to detect specific categories, as defined in its configuration: `Bus`, `Bike`, `Car`, `Pedestrian`, and `Truck`.
 
 ## Intended uses & limitations
 
-More information needed
+This model is intended for object detection tasks within Intelligent Transportation Systems, specifically for identifying vehicles and vulnerable road users in visual data, such as that collected from fisheye cameras. Its primary use case is within the Mcity Data Engine framework for research and development related to improving perception models with rare and novel data.
+
+**Limitations**:
+*   The model's performance may vary on data significantly different from the Fisheye8K dataset (e.g., different camera types, environments, or lighting conditions).
+*   Like all deep learning models, it may exhibit biases present in the training data and may not generalize perfectly to all real-world scenarios.
+*   Further evaluation on diverse real-world ITS data is recommended for specific deployment scenarios.
+
+## Usage
+
+You can use this model directly with the Hugging Face `transformers` library for object detection tasks.
+
+```python
+from transformers import AutoImageProcessor, AutoModelForObjectDetection
+import torch
+from PIL import Image
+import requests
+
+# Load image processor and model
+model_name = "mcity-data-engine/fisheye8k_microsoft_conditional-detr-resnet-50"
+processor = AutoImageProcessor.from_pretrained(model_name)
+model = AutoModelForObjectDetection.from_pretrained(model_name)
+
+# Example image (replace with your own image URL or local path)
+url = "http://images.cocodataset.org/val2017/000000039769.jpg" # A standard COCO image
+image = Image.open(requests.get(url, stream=True).raw).convert("RGB") # Ensure RGB format
+
+# Perform inference
+inputs = processor(images=image, return_tensors="pt")
+outputs = model(**inputs)
+
+# Post-process and print results
+target_sizes = torch.tensor([image.size[::-1]]) # (height, width)
+results = processor.post_process_object_detection(outputs, target_sizes=target_sizes, threshold=0.9)[0] # Apply a confidence threshold
+
+print("Detected objects:")
+for score, label, box in zip(results["scores"], results["labels"], results["boxes"]):
+    box = [round(i, 2) for i in box.tolist()]
+    print(
+        f"  - {model.config.id2label[label.item()]} with confidence "
+        f"{round(score.item(), 3)} at location {box}"
+    )
+```
 
 ## Training and evaluation data
 
-More information needed
+This model was fine-tuned on the [Voxel51/fisheye8k](https://huggingface.co/datasets/Voxel51/fisheye8k) dataset. The Fisheye8K dataset contains images captured from fisheye cameras, primarily focusing on intelligent transportation system scenarios.
 
 ## Training procedure
 
@@ -68,7 +114,6 @@ The following hyperparameters were used during training:
 | 0.552         | 16.0  | 84608 | 1.4832          |
 | 0.5233        | 17.0  | 89896 | 1.4466          |
 
-
 ### Framework versions
 
 - Transformers 4.48.3
@@ -76,4 +121,19 @@ The following hyperparameters were used during training:
 - Datasets 3.2.0
 - Tokenizers 0.21.0
 
-Mcity Data Engine: https://arxiv.org/abs/2504.21614
+## Acknowledgements
+
+Mcity would like to thank Amazon Web Services (AWS) for their pivotal role in providing the cloud infrastructure on which the Data Engine depends. We couldn’t have done it without their tremendous support!
+
+## Citation
+
+If you use the Mcity Data Engine in your research, feel free to cite the project:
+
+```bibtex
+@article{bogdoll2025mcitydataengine,
+  title={Mcity Data Engine},
+  author={Bogdoll, Daniel and Anata, Rajanikant Patnaik and Stevens, Gregory},
+  journal={GitHub. Note: https://github.com/mcity/mcity_data_engine},
+  year={2025}
+}
+```