Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,41 @@
 ---
-{}
+language:
+- en
+license: apache-2.0
+pretty_name: Basic Shapes Object Detection Model
+tags:
+- object-detection
+- simple
+- example
+- basic-geometric-shapes
+task_categories:
+- object-detection
 ---
+
+# Basic Shapes Object Detection Model
+
+## Description
+
+This is a model based on facebook/detr-resnet-50 which is fine-tuned to detect very basic shapes like circles, squares and triangles.
+
+It's trained on the dataset at https://huggingface.co/datasets/driesverachtert/basic_shapes_object_detection . The code which was used to create that dataset can be found at https://github.com/DriesVerachtert/basic_shapes_object_detection_dataset 
+
+This model itself can be downloaded from the HuggingFace Hub at https://huggingface.co/driesverachtert/basic_shapes_object_detection . The code which was used to train the model can be found at https://github.com/DriesVerachtert/basic_shapes_object_detection_model
+
+## License
+
+This model is released under Apache 2.0.
+
+
+## Useful links
+
+* https://github.com/facebookresearch/detr
+* https://huggingface.co/facebook/detr-resnet-50
+* https://huggingface.co/docs/transformers/main/en/tasks/object_detection
+* https://huggingface.co/docs/transformers/main/en/model_doc/detr
+* https://github.com/Rishit-dagli/CPPE-Dataset
+
+## Contact
+
+Dries Verachtert - [email protected]
+https://www.linkedin.com/in/dries/