Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

Commit

Permalink
update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentqb committed Oct 28, 2020
1 parent a767ec6 commit f07245a
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Among others, it implements the augmentations that we found to be most useful fo
Internally, WavAugment uses [libsox](http://sox.sourceforge.net/libsox.html) and allows interleaving of libsox- and pytorch-based effects.

### Requirements
* Linux (WavAugment is not tested under MacOS and might not work properly);
* [pytorch](pytorch.org) (however, there is also an option of using WavAugment directly from C++ w/o torch, see below);
* `libsox`: if you have [torchaudio](https://github.com/pytorch/audio) installed, most likely you already have `libsox`. Otherwise, you need to install it, e.g. by running `sudo apt-get install sox libsox-dev libsox-fmt-all`
* Linux and MacOS
* [pytorch](pytorch.org) >= 1.7
* [torchaudio](pytorch.org/audio) >= 0.7

### Installation
To install WavAugment, run the following command:
Expand Down Expand Up @@ -113,15 +113,6 @@ WavAugment remains explicit and doesn't add effects under the hood.
If you want to emulate a Sox command that decomposes into several effects, we advise to consult `sox -V` and apply the effects manually.
Try it out on some files before running a heavy machine-learning job.

## But I want to use it from C++
### Installation
It is possible to use directly WavAugment's C++ interface to libsox.
You will need to install `libsox`, e.g. by running
```bash
sudo apt-get install sox libsox-dev libsox-fmt-all
```
The C++ interface is provided as a single-header library, so you only need to include [this file](./augment/speech_augment.h).

## Citation
If you find WavAugment useful in your research, please consider citing:
```
Expand Down

0 comments on commit f07245a

Please sign in to comment.