Spaces:
Runtime error
Runtime error
Commit
·
f386273
1
Parent(s):
08ad878
Delete Readme.md
Browse files
README.md
DELETED
@@ -1,86 +0,0 @@
|
|
1 |
-
# AudioCraft
|
2 |
-
|
3 |
-

|
4 |
-

|
5 |
-

|
6 |
-
|
7 |
-
AudioCraft is a PyTorch library for deep learning research on audio generation. AudioCraft contains inference and trainingcon code
|
8 |
-
for two state-of-the-art AI generative models producing high-quality audio: AudioGen and MusicGen.
|
9 |
-
|
10 |
-
## Installation
|
11 |
-
|
12 |
-
AudioCraft requires Python 3.9, PyTorch 2.0.0. To install AudioCraft, you can run the following:
|
13 |
-
|
14 |
-
```shell
|
15 |
-
# Best to make sure you have torch installed first, in particular before installing xformers.
|
16 |
-
# Don't run this if you already have PyTorch installed.
|
17 |
-
pip install 'torch>=2.0'
|
18 |
-
# Then proceed to one of the following
|
19 |
-
pip install -U audiocraft # stable release
|
20 |
-
pip install -U git+https://[email protected]/facebookresearch/audiocraft#egg=audiocraft # bleeding edge
|
21 |
-
pip install -e . # or if you cloned the repo locally (mandatory if you want to train).
|
22 |
-
|
23 |
-
```
|
24 |
-
|
25 |
-
We also recommend having `ffmpeg` installed, either through your system or Anaconda:
|
26 |
-
|
27 |
-
```bash
|
28 |
-
sudo apt-get install ffmpeg
|
29 |
-
# Or if you are using Anaconda or Miniconda
|
30 |
-
conda install 'ffmpeg<5' -c conda-forge
|
31 |
-
|
32 |
-
```
|
33 |
-
|
34 |
-
## Models
|
35 |
-
|
36 |
-
At the moment, AudioCraft contains the training code and inference code for:
|
37 |
-
|
38 |
-
* [MusicGen](./docs/MUSICGEN.md): A state-of-the-art controllable text-to-music model.
|
39 |
-
* [AudioGen](./docs/AUDIOGEN.md): A state-of-the-art text-to-sound model.
|
40 |
-
* [EnCodec](./docs/ENCODEC.md): A state-of-the-art high fidelity neural audio codec.
|
41 |
-
* [Multi Band Diffusion](./docs/MBD.md): An EnCodec compatible decoder using diffusion.
|
42 |
-
|
43 |
-
## Training code
|
44 |
-
|
45 |
-
AudioCraft contains PyTorch components for deep learning research in audio and training pipelines for the developed models.
|
46 |
-
For a general introduction of AudioCraft design principles and instructions to develop your own training pipeline, refer to
|
47 |
-
the [AudioCraft training documentation](./docs/TRAINING.md).
|
48 |
-
|
49 |
-
For reproducing existing work and using the developed training pipelines, refer to the instructions for each specific model
|
50 |
-
that provides pointers to configuration, example grids and model/task-specific information and FAQ.
|
51 |
-
|
52 |
-
## API documentation
|
53 |
-
|
54 |
-
We provide some [API documentation](https://facebookresearch.github.io/audiocraft/api_docs/audiocraft/index.html) for AudioCraft.
|
55 |
-
|
56 |
-
## FAQ
|
57 |
-
|
58 |
-
#### Is the training code available?
|
59 |
-
|
60 |
-
Yes! We provide the training code for [EnCodec](./docs/ENCODEC.md), [MusicGen](./docs/MUSICGEN.md) and [Multi Band Diffusion](./docs/MBD.md).
|
61 |
-
|
62 |
-
#### Where are the models stored?
|
63 |
-
|
64 |
-
Hugging Face stored the model in a specific location, which can be overriden by setting the `AUDIOCRAFT_CACHE_DIR` environment variable.
|
65 |
-
|
66 |
-
## License
|
67 |
-
|
68 |
-
* The code in this repository is released under the MIT license as found in the [LICENSE file](LICENSE).
|
69 |
-
* The models weights in this repository are released under the CC-BY-NC 4.0 license as found in the [LICENSE_weights file](LICENSE_weights).
|
70 |
-
|
71 |
-
## Citation
|
72 |
-
|
73 |
-
For the general framework of AudioCraft, please cite the following.
|
74 |
-
|
75 |
-
```json
|
76 |
-
@article{copet2023simple,
|
77 |
-
title={Simple and Controllable Music Generation},
|
78 |
-
author={Jade Copet and Felix Kreuk and Itai Gat and Tal Remez and David Kant and Gabriel Synnaeve and Yossi Adi and Alexandre Défossez},
|
79 |
-
year={2023},
|
80 |
-
journal={arXiv preprint arXiv:2306.05284},
|
81 |
-
}
|
82 |
-
|
83 |
-
```
|
84 |
-
|
85 |
-
When referring to a specific model, please cite as mentioned in the model specific README, e.g
|
86 |
-
[./docs/MUSICGEN.md](./docs/MUSICGEN.md), [./docs/AUDIOGEN.md](./docs/AUDIOGEN.md), etc.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|