Update README.md

README.md

@@ -1,36 +1,35 @@
-
 ---
 language:
-    - en
+- en
 tags:
-    - yolo
-    - object-recognition
+- yolo
+- object-detection
 library_name: burial_mounds
+license: cc-by-nc-4.0
 ---
 
 # kardosdrur/burial-mounds-yolov8m-xview
 
-This repository contains a YOLO model that has been finetuned by the `burial_mounds` Python package on the `best` dataset.
+This repository contains a YOLO model that has been finetuned by the `burial_mounds` Python package on the `Mounds` dataset.
+
+> The model is for academic use only, commercial use is prohibited due to restrictions imposed by the training datasets.
 
 ## Usage
 ```python
 # pip install burial_mounds
 
-from burial_mounds.hub import load_from_hub
+from burial_mounds.model import MoundDetector
 
-model = load_from_hub("kardosdrur/burial-mounds-yolov8m-xview")
+model = MoundDetector.load_from_hub("kardosdrur/burial-mounds-yolov8m-xview")
 
-mounds = model(["data/mounds/images/east_30.png"])
+# Find bounding polygons
+bounding_polygons = model.detect_mounds("some_satellite_image.png")
+for polygon in bounding_polygons:
+    print(polygon)
 
-# Process results list
-for result in results:
-    boxes = result.boxes  # Boxes object for bounding box outputs
-    masks = result.masks  # Masks object for segmentation masks outputs
-    keypoints = result.keypoints  # Keypoints object for pose outputs
-    probs = result.probs  # Probs object for classification outputs
-    obb = result.obb  # Oriented boxes object for OBB outputs
-    result.show()  # display to screen
-    result.save(filename="result.jpg")  # save to disk
+# Annotate satellite images
+annotated_image = model.annotate_image("some_satellite_image.png")
+annotated_image.show()
 ```
 
-For a more detailed guide consult the [YOLOv8 documentation](https://docs.ultralytics.com/modes/predict/#key-features-of-predict-mode).
+For a more detailed guide consult the [YOLOv8 documentation](https://docs.ultralytics.com/modes/predict/#key-features-of-predict-mode) or [our documentation](https://github.com/x-tabdeveloping/burial-mounds-object-recognition).