Draft: v3.0

TODO

• [70%] Tensorflow layers for spectrogram computation and augmentations: Remaining TODO's:

  • Implement band-mask augmentation (SpecAugment): https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/25
  • Implement pink-noise generator: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/26
  • Implement waveform convolution augmentation: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/27
  • Create a tutorial

• [80%] Overhaul of the audio module: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/12 -- Remaining TODO's:

  • Remove old audio module: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/28
  • Add CQT: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/21
  • Add Mel: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/22
  • Add Griffin-Lim: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/23
  • Add Median filters: https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/24
  • Expand test suite using/adapting tests from old audio module:

• [?] Overhaul of the database_interface module: I believe this one is near completion too, right @Bruno ? https://git-dev.cs.dal.ca/meridian/ketos/-/merge_requests/16

• [?] Overhaul of the neural_networks module: This one is a huge one and one we haven't really started yet. It includes the update of the ketos model format to ensure compatibility with more recent tensorflow versions. @frazao , have you made any progress on this one yet?

• [0%] A lighter cleanup/refactoring of the batch-generator classes in the data_feeding module.

• [0%] Update ketos_commands to accommodate changes to audio and neural_networks modules. Could be a job for you @padovese ? Shouldn't be too much work I would hope.

• [0%] Tidy up the rest of the code base, remove unsused functions, etc.

• [0%] Review HTML docs

• [0%] Resolve dependencies. Find out which versions of Python, Numpy, Tensorflow etc. are we compatible with.

• [0%] Move the ketos and ketos-tutorials repositories to GitHub. This one I see as fairly straightforward, but could still prove time consuming as we need to configure CI pipelines, get the generation and publishing of HTML docs working etc.

• [0%] Update the existing tutorials to work with ketos v3. Add new ones if we have time.

• [0?] PAMGuard compatibility?

• [0%] And probably more things I haven't thought of...