rgautroncgiar commited on
Commit
98b9eb6
β€’
1 Parent(s): 3d2e431

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -13
README.md CHANGED
@@ -10,32 +10,30 @@ tags:
10
  - vision
11
  - object-detection
12
  - pytorch
13
-
14
  library_name: ultralytics
15
  library_version: 8.0.75
16
  inference: false
17
-
18
  datasets:
19
  - rgautron/croppie_coffee
20
-
21
  model-index:
22
  - name: rgautron/croppie_coffee
23
  results:
24
  - task:
25
  type: object-detection
26
-
27
  dataset:
28
  type: rgautron/croppie_coffee
29
  name: croppie_coffee
30
  split: val
31
-
32
  metrics:
33
- - type: precision # substitute for [email protected]
34
- value: 0.691
35
- name: [email protected](box)
 
36
  ---
37
- ### General description
38
- Ultralytics' Yolo V8 medium model fined tuned for coffee cherry detection using the [Croppie coffee dataset](https://huggingface.co/datasets/rgautroncgiar/croppie_coffee_split).
 
 
39
 
40
  ![](images/annotated_1688033955437_.jpg)
41
 
@@ -46,7 +44,7 @@ The predicted numerical classes correspond to the following cherry types:
46
  {0: "dark_brown_cherry", 1: "green_cherry", 2: "red_cherry", 3: "yellow_cherry"}
47
  ```
48
 
49
- ### Repository structure
50
 
51
  ```
52
  .
@@ -55,13 +53,25 @@ The predicted numerical classes correspond to the following cherry types:
55
  β”‚Β Β  └── annotated_1688033955437_.jpg
56
  β”œβ”€β”€ model_v3_202402021.pt # fine tuning of Yolo v8
57
  β”œβ”€β”€ README.md
 
58
  └── scripts
59
  β”œβ”€β”€ render_results.py # helper function to annotate predictions
60
  β”œβ”€β”€ requirements.txt # pip requirements
61
  └── test_script.py # test script
62
  ```
63
 
64
- ### Demonstration
65
  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```.
66
 
67
- Make sure that the Python packages found in ```requirements.txt``` are installed. In case they are not, simply run ```pip3 install -r requirements.txt```.
 
 
 
 
 
 
 
 
 
 
 
 
10
  - vision
11
  - object-detection
12
  - pytorch
 
13
  library_name: ultralytics
14
  library_version: 8.0.75
15
  inference: false
 
16
  datasets:
17
  - rgautron/croppie_coffee
 
18
  model-index:
19
  - name: rgautron/croppie_coffee
20
  results:
21
  - task:
22
  type: object-detection
 
23
  dataset:
24
  type: rgautron/croppie_coffee
25
  name: croppie_coffee
26
  split: val
 
27
  metrics:
28
+ - type: precision
29
+ value: 0.691
30
+ name: [email protected](box)
31
+ license: gpl-3.0
32
  ---
33
+ [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)
34
+
35
+ ## General description
36
+ Ultralytics' Yolo V8 medium model fined tuned for coffee cherry detection using the [Croppie coffee dataset](https://huggingface.co/datasets/rgautroncgiar/croppie_coffee_ug).
37
 
38
  ![](images/annotated_1688033955437_.jpg)
39
 
 
44
  {0: "dark_brown_cherry", 1: "green_cherry", 2: "red_cherry", 3: "yellow_cherry"}
45
  ```
46
 
47
+ ## Repository structure
48
 
49
  ```
50
  .
 
53
  β”‚Β Β  └── annotated_1688033955437_.jpg
54
  β”œβ”€β”€ model_v3_202402021.pt # fine tuning of Yolo v8
55
  β”œβ”€β”€ README.md
56
+ β”œβ”€β”€ LICENSE.txt # detailed term of the software license
57
  └── scripts
58
  β”œβ”€β”€ render_results.py # helper function to annotate predictions
59
  β”œβ”€β”€ requirements.txt # pip requirements
60
  └── test_script.py # test script
61
  ```
62
 
63
+ ## Demonstration
64
  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```.
65
 
66
+ Make sure that the Python packages found in ```requirements.txt``` are installed. In case they are not, simply run ```pip3 install -r requirements.txt```.
67
+
68
+ ## License
69
+ [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)
70
+
71
+ 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.
72
+
73
+ 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.
74
+
75
+ You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
76
+
77
+ The detailed terms of the license are available in the ```LICENSE.txt``` file in the repository.