Jesse Lopez commited on
Commit
e8fe9e1
·
1 Parent(s): ab1fb43

Update README.md

Browse files

Add brief description of the training data.

Files changed (1) hide show
  1. README.md +55 -15
README.md CHANGED
@@ -3,19 +3,9 @@ tags:
3
  - fastai
4
  ---
5
 
6
- # Amazing!
7
-
8
- 🥳 Congratulations on hosting your fastai model on the Hugging Face Hub!
9
-
10
- # Some next steps
11
- 1. Fill out this model card with more information (see the template below and the [documentation here](https://huggingface.co/docs/hub/model-repos))!
12
-
13
- 2. Create a demo in Gradio or Streamlit using 🤗 Spaces ([documentation here](https://huggingface.co/docs/hub/spaces)).
14
-
15
- 3. Join the fastai community on the [Fastai Discord](https://discord.com/invite/YKrxeNn)!
16
-
17
- Greetings fellow fastlearner 🤝! Don't forget to delete this content from your model card.
18
 
 
19
 
20
  ---
21
 
@@ -23,10 +13,60 @@ Greetings fellow fastlearner 🤝! Don't forget to delete this content from your
23
  # Model card
24
 
25
  ## Model description
26
- More information needed
 
 
 
27
 
28
  ## Intended uses & limitations
29
- More information needed
 
 
30
 
31
  ## Training and evaluation data
32
- More information needed
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  - fastai
4
  ---
5
 
6
+ This model was trained to as part of collaboration between [Mote Marine Laboratory & Aquarium](https://mote.org), [Southeast Coastal Ocean Observing Regional Association](https://secoora.org), and [Axiom Data Science](https://axiomdatascience.com) to develop a model capable of detecting and classifying fish vocalizations from audio files collected from hydrophones.
 
 
 
 
 
 
 
 
 
 
 
7
 
8
+ More information available at [the project archive repo](https://github.com/axiom-data-science/project-classify-fish-sounds).
9
 
10
  ---
11
 
 
13
  # Model card
14
 
15
  ## Model description
16
+
17
+ This model was trained on spectrograms
18
+
19
+ A [reproducible Jupyter notebook](https://github.com/axiom-data-science/project-classify-fish-sounds/blob/main/notebooks/train-resnet101-fastai.ipynb) describing the training of the model is available in the archive repo.
20
 
21
  ## Intended uses & limitations
22
+
23
+ The model was intended to be a proof on concept to aid researchers identify fish vocalizations through vast amounts of audio data collected from hydrophones.
24
+ Although the training data was collected using multiple devices in multiple locations, the model may not be generally applicable to other uses.
25
 
26
  ## Training and evaluation data
27
+
28
+ A training set of spectrograms of fish calls was created based on annotations of fish sounds in passive acoustic recordings by a hydrophone were provided by Jim Locascio, Max Fullmer, and volunteers from the [Mote Marine Laboratory & Aquarium](https://mote.org).
29
+
30
+ Due to severe imbalances in the number of samples per class, the training involved both under-sampling classes with many samples and over-sampling classes with few classes so that the model was trained on 50 samples per class. This number was derived in a completely ad-hoc fashion based on the distribution of class samples.
31
+
32
+ ### Class label description
33
+
34
+ | Call Index | Description |
35
+ |------------|-------------|
36
+ | 0 | Background noise (no fish vocalizations) |
37
+ | 1 | Black grouper 1 |
38
+ | 2 | Black grouper 2 |
39
+ | 3 | Black grouper grunt |
40
+ | 4 | Black grouper spawning rush |
41
+ | 5 | Black grouper chorus < 50% of file |
42
+ | 6 | Black grouper chrous > 50% of file |
43
+ | 8 | Unidentified sound type |
44
+ | 9 | Red grouper 1 |
45
+ | 10 | Red grouper 2 |
46
+ | 17 | Red hind 1 |
47
+ | 18 | Red hind 2 |
48
+ | 19 | Red hind 3 |
49
+ | 25 | Goliath grouper 1 |
50
+ | 27 | Multi-phase goliath grouper |
51
+ | 28 | Sea trout chorus |
52
+ | 29 | Silver perch call |
53
+
54
+ ### Class indices in trained model
55
+
56
+ Some classes did not meet the training criteria, high signal-to-noise ratio and minimum call overlap, and were therefore excluded from the model training.
57
+ As such, the number of classes represented in the trained model is few than the amount of labeled classes in the training set.
58
+
59
+ | Call Index | Description |
60
+ ----------------------------
61
+ |0 | No call |
62
+ |1 | Black grouper call |
63
+ |2 | Black grouper call 2 |
64
+ |3 | Black grouper grunt |
65
+ |4 | Unidentified sound |
66
+ |5 | Red grouper 1 |
67
+ |6 | Red grouper 2 |
68
+ |7 | Red hind 1 |
69
+ |8 | Red hind 2 |
70
+ |9 | Red hind 3 |
71
+ |10 | Goliath grouper |
72
+ |11 | Goliath grouper multi-phase |