Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sammlapp authored Nov 17, 2023
1 parent 4cc8fb9 commit 945abdd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The repository contains six notebooks and one script which each demonstrate one

## Notebooks and scripts included in this repository:

Each Jupyter Notebook can be run and modified (see instructions below), but we also provide static HTML renderings of each notebook (.html files) which can be opened in a web browser. These pages include code, figures, and interactive audio widgets allowing the user to view spectrograms and listen to sounds.

- `01_explore_annotated_data.ipynb` Explore annotated dataset of _Rana sierrae_ call types

- `02_prep_training_data.ipynb` Prepare annotated files for training a CNN machine learning model
Expand All @@ -27,7 +29,7 @@ The repository contains six notebooks and one script which each demonstrate one

- `06_aggregate_scores.py` Aggregate scores from CNN prediction across dates and times of day. Note that this script is only provided as a demonstration of aggregating scores from a large dataset. Since we do not include the full audio dataset (thousands of hours of audio) or full set of CNN prediction across the entire audio dataset, the outputs of this script cannot be reproduced with the provided data. Instead, we include the outputs of this script (summaries of call activity detected by the CNN) as data tables in this repository. If you are running these notebooks sequentially, simply skip this script and proceed from `05_cnn_validation.ipynb` to `07_explore_results.ipynb`.

- `07_explore_results.ipynb` Analyze temporal patterns of vocal activity using the CNN detections
- `07_explore_results.ipynb` Analyze temporal patterns of vocal activity using the CNN detections. This notebook reproduces the results figures in the manuscript.

## Running the code in this repository

Expand Down Expand Up @@ -79,4 +81,4 @@ Two figures (`precision_and_recall_vs_threshold.pdf` and `precision_recall_curve
The remaining figures summarize the detections of the CNN on the full field dataset collected for the study:
- `dvar_by_card.pdf`: Detected Vocal Activity Rate (defined above) for each device, by date across the full recording period
- `seasonal_activity_normalized_thresholds.pdf` plots the same seasonal trend as `dvar_by_card` for each detetion threshold, with each curve normalized by the area under the curve (total detections at that threshold). This demonstrates that though different thresholds result in different numbers of detections, the temporal patterns are consistent regardless of threshold choice.
- `time_with_3hr_rolling_avg_thresholds.pdf`: Plots the detected vocal activity rate (defined above) calculated on a 15 minute basis with a 3 hour moving average applied, across the day, for all recording dates.
- `time_with_3hr_rolling_avg_thresholds.pdf`: Plots the detected vocal activity rate (defined above) calculated on a 15 minute basis with a 3 hour moving average applied, across the day, for all recording dates.

0 comments on commit 945abdd

Please sign in to comment.