Devi-Ayyagari commited on
Commit
9ffa9df
·
verified ·
1 Parent(s): b69ef78

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -7
README.md CHANGED
@@ -49,11 +49,28 @@ This repo hosts baseline **YOLOv7** models trained on the **N-MARINE** dataset (
49
  > Supplementary + scripts: https://github.com/Pentaerythrittetranitrat/N-MARINE_dataset_supplementary
50
 
51
  ## Model list
52
-
53
- - `yolov7-nmarine-no-class-weights.pt` — best overall (recommended)
54
- - `yolov7-nmarine-class-weights.pt` — improves some rare classes but slightly reduces overall mAP
55
-
56
- Each model outputs **9 classes** (species IDs in `metadata/classes.csv` within the dataset/supplementary repo).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
 
58
  ## Intended use
59
 
@@ -88,7 +105,7 @@ pip install -r requirements.txt
88
 
89
  # 2) Run inference
90
  python detect.py \
91
- --weights /path/to/yolov7-nmarine-no-class-weights.pt \
92
  --source /path/to/images_or_video \
93
  --img-size 640 \
94
  --conf-thres 0.25 \
@@ -97,7 +114,7 @@ python detect.py \
97
  ```
98
  ### Citation
99
 
100
- If you use these models or the dataset, please cite both:
101
 
102
  Dataset citation (plain text):
103
  Morris, C. J., Ayyagari, K. D., Porter, D., Nguyen, Q. K., Hanlon, J., & Whidden, C. (2025).
@@ -105,5 +122,7 @@ Newfoundland Marine Refuge Fish Classification Dataset (N-Marine).
105
  Government of Canada Open Data Portal.
106
  https://open.canada.ca/data/en/dataset/2ae46860-f82a-4127-bb1f-b02e36ef6a70
107
 
 
 
108
  Model citation (plain text):
109
  TODO: Add
 
49
  > Supplementary + scripts: https://github.com/Pentaerythrittetranitrat/N-MARINE_dataset_supplementary
50
 
51
  ## Model list
52
+ The released models follow this directory structure, where each `datasetX` (X = 1–5) corresponds to one of the five cross-validation splits:
53
+
54
+ Each `datasetX` directory contains two trained models:
55
+ - `classweights/best.pt` — trained with inverse-frequency class weights.
56
+ - `no_classweights/best.pt` — trained without class weights (baseline, recommended).
57
+
58
+ The **dataset splits** used for training can be found in the supplementary repository:
59
+ [https://github.com/Pentaerythrittetranitrat/N-MARINE_dataset_supplementary](https://github.com/Pentaerythrittetranitrat/N-MARINE_dataset_supplementary)
60
+ > **Note:** The models under `dataset5` correspond to the most balanced split across classes.
61
+
62
+ Each model outputs **9 classes**. The **class order (index → class)** for all models is:
63
+ | Index | Class name |
64
+ |-------|----------------------|
65
+ | 0 | Atlantic Cod |
66
+ | 1 | Roughhead Grenadier |
67
+ | 2 | Atlantic Halibut |
68
+ | 3 | Redfish Mentella |
69
+ | 4 | Thorny Skate |
70
+ | 5 | Striped Wolffish |
71
+ | 6 | Spinytail Skate |
72
+ | 7 | Whelk |
73
+ | 8 | Northern Wolffish |
74
 
75
  ## Intended use
76
 
 
105
 
106
  # 2) Run inference
107
  python detect.py \
108
+ --weights /path/to/N-MARINE_baseline_classifiers/n-marine_weights/dataset5/no_classweights/best.pt \
109
  --source /path/to/images_or_video \
110
  --img-size 640 \
111
  --conf-thres 0.25 \
 
114
  ```
115
  ### Citation
116
 
117
+ If you use the dataset, please cite:
118
 
119
  Dataset citation (plain text):
120
  Morris, C. J., Ayyagari, K. D., Porter, D., Nguyen, Q. K., Hanlon, J., & Whidden, C. (2025).
 
122
  Government of Canada Open Data Portal.
123
  https://open.canada.ca/data/en/dataset/2ae46860-f82a-4127-bb1f-b02e36ef6a70
124
 
125
+ If you use the models, please cite:
126
+
127
  Model citation (plain text):
128
  TODO: Add