Contributing

Contributions to this repo will probably fall into one of three categories:

1. A new feature, added to wave.py
2. A new model/configuration for our existing model, added to model.py
3. Structural edits or helper functions, added anywhere.

Before you start contributing, head over to the installation page and run through those instructions.

Making a contribution

As is standard, you can fork our repo and make a pull request.

If it's a feature/model addition:

• Include documentation for your changes (in the numpy/scipy format)
• In the pull request, run the system code with your new feature/model addition and show the new and improved F1 score
• If you added a feature, make sure the new hardcoded_features.csv has no Nan's. If it does, document the record label and add it to the comments of the PR.

If it's a structural change:

• Make sure it simplifies our codebase. We want to be doing more with less.
• In your PR, justify the changes