Update README.md

README.md

@@ -10,32 +10,30 @@ tags:
 - vision
 - object-detection
 - pytorch
-
 library_name: ultralytics
 library_version: 8.0.75
 inference: false
-
 datasets:
 - rgautron/croppie_coffee
-
 model-index:
 - name: rgautron/croppie_coffee
   results:
   - task:
       type: object-detection
-
     dataset:
       type: rgautron/croppie_coffee
       name: croppie_coffee
       split: val
-
     metrics:
-      - type: precision  # substitute for mAP@0.5
-        value: 0.691
-        name: mAP@0.5(box)
+    - type: precision
+      value: 0.691
+      name: mAP@0.5(box)
+license: gpl-3.0
 ---
-### General description
-Ultralytics' Yolo V8 medium model fined tuned for coffee cherry detection using the [Croppie coffee dataset](https://huggingface.co/datasets/rgautroncgiar/croppie_coffee_split).
+[Croppie](https://croppie.org/) © 2024 by [Producers Direct](https://producersdirect.org/) and [Alliance Bioversity & CIAT](https://alliancebioversityciat.org/) is licensed under [GNU-GPLv3](https://www.gnu.org/licenses/quick-guide-gplv3.html)
+
+## General description
+Ultralytics' Yolo V8 medium model fined tuned for coffee cherry detection using the [Croppie coffee dataset](https://huggingface.co/datasets/rgautroncgiar/croppie_coffee_ug).
 
 ![](images/annotated_1688033955437_.jpg)
 
@@ -46,7 +44,7 @@ The predicted numerical classes correspond to the following cherry types:
 {0: "dark_brown_cherry", 1: "green_cherry", 2: "red_cherry", 3: "yellow_cherry"}
 ```
 
-### Repository structure
+## Repository structure
 
 ```
 .
@@ -55,13 +53,25 @@ The predicted numerical classes correspond to the following cherry types:
 │   └── annotated_1688033955437_.jpg
 ├── model_v3_202402021.pt  # fine tuning of Yolo v8
 ├── README.md
+├── LICENSE.txt # detailed term of the software license
 └── scripts
     ├── render_results.py  # helper function to annotate predictions
     ├── requirements.txt  # pip requirements
     └── test_script.py  # test script
 ```
 
-### Demonstration
+## Demonstration
 Assuming you are in the ```scripts``` folder, you can run ```python3 test_script.py```. This script saves the annotated image in ```../images/annotated_1688033955437.jpg```.
 
-Make sure that the Python packages found in ```requirements.txt``` are installed. In case they are not, simply run ```pip3 install -r requirements.txt```.
+Make sure that the Python packages found in ```requirements.txt``` are installed. In case they are not, simply run ```pip3 install -r requirements.txt```.
+
+## License
+[Croppie](https://croppie.org/) © 2024 by [Producers Direct](https://producersdirect.org/) and [Alliance Bioversity & CIAT](https://alliancebioversityciat.org/) is licensed under [GNU-GPLv3](https://www.gnu.org/licenses/quick-guide-gplv3.html)
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+The detailed terms of the license are available in the ```LICENSE.txt``` file in the repository.