Skip to content

Commit 294fb15

Browse files
authored
minor adjustments to readme and license (#16)
1 parent 4852b93 commit 294fb15

File tree

2 files changed

+13
-22
lines changed

2 files changed

+13
-22
lines changed

LICENSE

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -175,18 +175,7 @@
175175

176176
END OF TERMS AND CONDITIONS
177177

178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright [yyyy] [name of copyright owner]
178+
Copyright 2026 Gianfranco Dumoulin Bertucci
190179

191180
Licensed under the Apache License, Version 2.0 (the "License");
192181
you may not use this file except in compliance with the License.

readme.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
1-
# 🎛️ Wav2Aug: Toward Universal Time-Domain Speech Augmentation
1+
# 🎛️ Wav2Aug: Task-Agnostic Waveform Augmentation Beyond ASR
22

3-
A minimalistic PyTorch-based audio augmentation library for speech and audio augmentation. The goal of this library is to provide a general purpose speech augmentation policy that can be used on any task and perform well without having to tune augmentation hyperparameters. Just install, and start augmenting. Applies two random augmentations per call.
3+
A minimalistic PyTorch-based audio augmentation library for speech augmentation. The goal of this library is to provide a general purpose speech augmentation policy that can be used on any task and perform reasonably well without having to tune augmentation hyperparameters. Just install, and start augmenting. Applies two random augmentations per call. Just install and start augmenting!
44

5-
![Diagram](https://raw.githubusercontent.com/gfdb/wav2aug/main/wav2aug.png)
6-
7-
## ⚙️ Features
85

9-
* **9 core augmentations**: amplitude scaling/clipping, noise addition, frequency dropout, polarity inversion, chunk swapping, speed perturbation, time dropout, and babble noise.
10-
* **Simplicity**: just install and start augmenting!
11-
* **Randomness**: all stochastic ops use PyTorch RNGs. Set a single seed and be done, e.g. torch.manual_seed(0); torch.cuda.manual_seed_all(0)
6+
![Diagram](https://raw.githubusercontent.com/gfdb/wav2aug/main/wav2aug.png)
127

138
## 📦 Installation
149

@@ -38,6 +33,10 @@ wavs = torch.randn(3, 50000)
3833
lens = torch.ones((wavs.size(0)))
3934

4035
aug_wavs, aug_lens = augmenter(wavs, lens)
36+
37+
# or just
38+
39+
aug_wavs = augmenter(wavs)
4140
```
4241

4342
That's it!
@@ -53,6 +52,9 @@ That's it!
5352
* 🕳️ **Time Dropout**: Random silence insertion
5453
* 👥 **Babble Noise**: Multi-speaker background (auto-enabled with sufficient buffer)
5554

55+
**Randomness**: all stochastic ops use PyTorch RNGs. Set a single seed and be done, e.g. torch.manual_seed(0); torch.cuda.manual_seed_all(0)
56+
57+
5658
## 🛠️ Development Installation
5759

5860
### uv
@@ -109,8 +111,8 @@ pytest -q tests/
109111

110112
* Issues and PRs are welcome and encouraged!
111113

112-
* Bug reports: please open an issue with a minimal repro (env, torch/torchaudio/torchcodec versions, code snippet, expected vs. actual, traceback).
114+
* Bug reports: please open an issue with a minimal repro (env, dep versions, code snippet, expected vs. actual, traceback, etc.)
113115

114116
* Feature requests: please open an issue with use-case and proposed feature.
115117

116-
* PRs: keep them focused. Add tests when behavior changes. Don't forget to run formatters and tests before submitting!
118+
* PRs: Add tests for new stuff or when behavior changes. Also, don't forget to run formatters and tests before submitting!

0 commit comments

Comments
 (0)