Fastai2 Audio

An audio module for v2 of fastai. We want to help you build audio machine learning applications while minimizing the need for audio domain expertise. Currently under development.

IMPORTANT

This version of the library is no longer being supported. All of the future development can be found here:

https://github.com/fastaudio/fastaudio

Quick Start

Google Colab Notebook

Zachary Mueller's class

Install

In the future we will offer conda and pip installs, but as the code is rapidly changing, we recommend that only those interested in contributing and experimenting install for now. Everyone else should use Fastai audio v1

To install:

pip install packaging
pip install git+https://github.com/rbracco/fastai2_audio.git

If you plan on contributing to the library instead, you will need to do a editable install:

pip install packaging nbdev --upgrade
git clone https://github.com/rbracco/fastai2_audio
cd fastai2_audio
nbdev_install_git_hooks
pip install -e .

Contributing to the library

We are looking for contributors of all skill levels. If you don't have time to contribute, please at least reach out and give us some feedback on the library by posting in the v2 audio thread or contact us via PM @baz or @madeupmasters

How to contribute

Create issues, write documentation, suggest/add features, submit PRs. We are open to anything. A good first step would be posting in the v2 audio thread introducing yourself.

How to submit a PR

The first step to create a new PR is to install jupyter notebook or jupyterlab. This library is build using nbdev, meaning that all of the code, documentation and test is written into notebooks, and the .py python files, online docs and CI tests are created by nbdev based on those notebooks.

All of the files that you will change are present into the nbs/ folder. Your general workflow while developing will be:

Open the notebooks using jupyter
Change what is present
Save the file
Run make and nbdev will update the library files, documentation and run the tests all at once
Check if any errors occured while running the last step, then fix it and run make again
Commit the changes

Advanced PR tips

The command nbdev_diff_nbs can let you know if there is a difference between the local library and the notebooks.
If you made a change to the notebooks in one of the exported cells, you can update the library with nbdev_build_lib or make fastai2. Note that this command will only update the library code, so before any commit, you'll need to run make as usual to update the docs and run the tests.
If you made a change to the library, you can export it back to the notebooks with nbdev_update_lib.

fastaudio / fastai2_audio

readme