Git Product home page Git Product logo

assteroid's Introduction

Asteroid : Audio Source Separation on steroids

Asteroid is a Pytorch-based source separation and speech enhancement API that enables fast experimentation on common datasets. It comes with a source code written to support a large range of architectures and a set of recipes to reproduce some papers.
Asteroid is intended to be a community-based project so hop on and help us !

Guiding principles

  • User friendliness. Asteroid's API offers simple solutions for most common use cases.
  • Modularity. Building blocks are thought and designed to be seamlessly plugged together. Filterbanks, encoders, maskers, decoders and losses are all common building blocks that can be combined in a flexible way to create new systems.
  • Extensibility. Extending Asteroid with new features is simple. Add a new filterbank, separator, architecture, dataset or even recipe very easily.
  • Reproducibility. Recipes provide an easy way to reproduce results with data preparation, training and evaluation in a same script.

๐Ÿšง โš ๏ธ Under development โš ๏ธ ๐Ÿšง

Installation

In order to install Asteroid, clone the repo and install it using pip or python :

git clone https://github.com/mpariente/AsSteroid
cd AsSteroid
# Install with pip (in editable mode)
pip install -e .
# Install with python
python setup.py install

Running a recipe

cd egs/wham/ConvTasNet
./run.sh

More information in egs/README.md.

Recipes

Writing your own recipe

Contributing

See our contributing guidelines.

Codebase structure

โ”œโ”€โ”€ asteroid                 # Python package / Source code
โ”‚ย ย  โ”œโ”€โ”€ data                 # Data classes, DalatLoaders maker.
โ”‚ย ย  โ”œโ”€โ”€ engine               # Training classes : losses, optimizers and trainer.
โ”‚ย ย  โ”œโ”€โ”€ filterbanks          # Common filterbanks and related classes.
โ”‚ย ย  โ”œโ”€โ”€ masknn               # Separation building blocks and architectures.
โ”‚ย ย  โ””โ”€โ”€ utils.py
โ”œโ”€โ”€ examples                 # Simple asteroid examples 
โ””โ”€โ”€ egs                      # Recipes for all datasets and systems.
โ”‚ย ย  โ”œโ”€โ”€ wham                 # Recipes for one dataset (WHAM) 
โ”‚ย ย  โ”‚   โ”œโ”€โ”€ ConvTasNet       # ConvTasnet systme on the WHAM dataset.
โ”‚ย ย  โ”‚   โ”‚   โ””โ”€โ”€ ...          # Recipe's structure. See egs/README.md for more info
โ”‚ย ย  โ”‚   โ”œโ”€โ”€ Your recipe      # More recipes on the same dataset (Including yours)
โ”‚ย ย  โ”‚   โ”œโ”€โ”€ ...
โ”‚ย ย  โ”‚   โ””โ”€โ”€ DualPathRNN
โ”‚ย ย  โ””โ”€โ”€ Your dataset         # More datasets (Including yours)

Why Asteroid ?

Audio source separation and speech enhancement are fast evolving fields with a growing number of papers submitted to conferences each year. While datasets such as wsj0-{2, 3}mix, WHAM or MS-SNSD are being shared, there has been little effort to create common codebases for development and evaluation of source separation and speech enhancement algorithms. Here is one !

assteroid's People

Contributors

mpariente avatar mhu-coder avatar popcornell avatar sunits avatar jensheit avatar

Watchers

paper2code - bot avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.