Update README.md

README.md

@@ -1,3 +1,30 @@
----
-license: mit
----
+---
+license: mit
+base_model:
+- Ultralytics/YOLOv8
+pipeline_tag: image-segmentation
+datasets:
+- afshin-dini/Egg-Instance-Segmentation
+tags:
+- object-segmentation
+- YOLO
+- Egg-Instance-Segmentation
+library_name: pytorch
+---
+
+# Description
+This model is a YOLO-based model which is trained on [Egg Instance Segmentation](https://huggingface.co/datasets/afshin-dini/Egg-Instance-Segmentation).
+
+## Code
+The complete code can be found [here](https://github.com/afshindini/Deep-Egg-Segmentation-and-Sizing).
+
+## How to use
+One can use the model within his/her code with the following commands:
+```shell
+from huggingface_hub import hf_hub_download
+from ultralytics import YOLO
+
+model_path = hf_hub_download(repo_id="afshin-dini/Egg-Instance-Segmentation", filename="model/egg_segmentor.pt")
+model = YOLO(model_path)
+result = model("path/to/image") 
+```