update documentation

README.md

@@ -59,3 +59,31 @@ On the test set:
 * ```F2 Score:  0.7841299670635844```
 * ```mAP50  0.8192513111358107```
 * ```mAP50-95  0.37744414058421033```
+
+## Dataset overview
+
+[![Hugging Face Dataset](https://img.shields.io/badge/huggingface-dataset-blue?logo=huggingface)](https://huggingface.co/datasets/eloise54/cots_yolo_dataset)
+
+This dataset is a **modified version** of the [CSIRO COTS and COTS Scars Dataset](https://data.csiro.au/collection/csiro:64235), originally released under the [Creative Commons Attribution 4.0 License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
+
+The original dataset contains images and annotations for **Crown-of-Thorns Starfish (COTS)** and **COTS scars**, collected to support coral reef monitoring and control efforts on the Great Barrier Reef (GBR). 
+
+These starfish are coral predators, and their outbreaks can severely damage reef ecosystems.
+
+>**Please cite the original dataset authors if you use this dataset in your work.**
+
+
+# 🙏 Citation
+
+```bibtex
+@dataset{csiro_cots_2024,
+  author = {Armin, Ali and Bainbridge, Scott and Page, Geoff and Tychsen-Smith, Lachlan and Coleman, Greg and Oorloff, Jeremy and Harvey, De'vereux and Do, Brendan and Marsh, Benjamin and Lawrence, Emma and Kusy, Brano and Hayder, Zeeshan and Bonin, Mary},
+  title = {COTS and COTS scar dataset},
+  year = {2024},
+  publisher = {CSIRO},
+  version = {v1},
+  doi = {10.25919/03a7-hn83},
+  url = {https://data.csiro.au/collection/csiro:64235}
+}
+```
+

app.py

@@ -152,6 +152,34 @@ def prev_sample(index: int, dataset_choice: str):
 # ---------------------------------
 # 5. UI elements
 # ---------------------------------
+
+dataset_information= """
+## Dataset overview
+
+[![Hugging Face Dataset](https://img.shields.io/badge/huggingface-dataset-blue?logo=huggingface)](https://huggingface.co/datasets/eloise54/cots_yolo_dataset)
+
+This dataset is a **modified version** of the [CSIRO COTS and COTS Scars Dataset](https://data.csiro.au/collection/csiro:64235), originally released under the [Creative Commons Attribution 4.0 License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
+
+The original dataset contains images and annotations for **Crown-of-Thorns Starfish (COTS)** and **COTS scars**, collected to support coral reef monitoring and control efforts on the Great Barrier Reef (GBR). 
+
+These starfish are coral predators, and their outbreaks can severely damage reef ecosystems.
+
+**PCSIRO COTS and COTS Scars Dataset reference:**
+
+
+```bibtex
+@dataset{csiro_cots_2024,
+  author = {Armin, Ali and Bainbridge, Scott and Page, Geoff and Tychsen-Smith, Lachlan and Coleman, Greg and Oorloff, Jeremy and Harvey, De'vereux and Do, Brendan and Marsh, Benjamin and Lawrence, Emma and Kusy, Brano and Hayder, Zeeshan and Bonin, Mary},
+  title = {COTS and COTS scar dataset},
+  year = {2024},
+  publisher = {CSIRO},
+  version = {v1},
+  doi = {10.25919/03a7-hn83},
+  url = {https://data.csiro.au/collection/csiro:64235}
+}
+```
+
+"""
 with gr.Blocks() as demo:
     gr.Markdown("## 🪸 Crown of thorns starfish detection - protect the great barrier reef")
     gr.Markdown("Use **Next** or **Previous** to browse samples and see model predictions vs ground truth.")
@@ -173,6 +201,8 @@ with gr.Blocks() as demo:
     with gr.Row():
         prev_btn = gr.Button("⬅️ Prev image")
         next_btn = gr.Button("Next image➡️")
+    with gr.Row():
+        gr.Markdown(dataset_information)
 
     # Connect navigation
     prev_btn.click(fn=prev_sample, inputs=[state, dropdown], outputs=[image_output, state, index, dataset_choice])