ylacombe HF staff commited on
Commit
18b727b
1 Parent(s): afc458d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +75 -172
README.md CHANGED
@@ -1,201 +1,104 @@
1
  ---
2
  library_name: transformers
3
- tags: []
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
 
 
10
 
 
 
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
 
 
 
 
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
 
 
 
 
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
 
 
 
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
 
35
 
36
- ## Uses
 
 
 
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
39
 
40
- ### Direct Use
 
 
 
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
43
 
44
- [More Information Needed]
45
 
46
- ### Downstream Use [optional]
 
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
49
 
50
- [More Information Needed]
 
51
 
52
- ### Out-of-Scope Use
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
55
 
56
- [More Information Needed]
 
57
 
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
200
 
 
 
201
 
 
 
 
 
1
  ---
2
  library_name: transformers
3
+ tags: [DAC, audio]
4
  ---
5
 
6
+ # Descript Audio Codec (.dac): High-Fidelity Audio Compression with Improved RVQGAN
7
 
8
+ This repository contains training and inference scripts for the Descript Audio Codec (.dac), a high fidelity general neural audio codec, introduced in the paper titled **High-Fidelity Audio Compression with Improved RVQGAN**.
9
 
10
+ [arXiv Paper: High-Fidelity Audio Compression with Improved RVQGAN
11
+ ](http://arxiv.org/abs/2306.06546) <br>
12
+ [Demo Site](https://descript.notion.site/Descript-Audio-Codec-11389fce0ce2419891d6591a68f814d5)<br>
13
 
14
+ 👉 With Descript Audio Codec, you can compress **44.1 KHz audio** into discrete codes at a **low 8 kbps bitrate**. <br>
15
+ 🤌 That's approximately **90x compression** while maintaining exceptional fidelity and minimizing artifacts. <br>
16
+ 💪 Descript universal model works on all domains (speech, environment, music, etc.), making it widely applicable to generative modeling of all audio. <br>
17
+ 👌 It can be used as a drop-in replacement for EnCodec for all audio language modeling applications (such as AudioLMs, MusicLMs, MusicGen, etc.) <br>
18
 
 
19
 
20
+ ## Original Usage
21
 
22
+ ### Installation
23
+ ```
24
+ pip install descript-audio-codec
25
+ ```
26
+ OR
27
 
28
+ ```
29
+ pip install git+https://github.com/descriptinc/descript-audio-codec
30
+ ```
31
 
32
+ ### Weights
33
+ Weights are released as part of this repo under MIT license.
34
+ We release weights for models that can natively support 16 kHz, 24kHz, and 44.1kHz sampling rates.
35
+ Weights are automatically downloaded when you first run `encode` or `decode` command. You can cache them using one of the following commands
36
+ ```bash
37
+ python3 -m dac download # downloads the default 44kHz variant
38
+ python3 -m dac download --model_type 44khz # downloads the 44kHz variant
39
+ python3 -m dac download --model_type 24khz # downloads the 24kHz variant
40
+ python3 -m dac download --model_type 16khz # downloads the 16kHz variant
41
+ ```
42
+ We provide a Dockerfile that installs all required dependencies for encoding and decoding. The build process caches the default model weights inside the image. This allows the image to be used without an internet connection. [Please refer to instructions below.](#docker-image)
43
 
 
44
 
45
+ ### Compress audio
46
+ ```
47
+ python3 -m dac encode /path/to/input --output /path/to/output/codes
48
+ ```
49
 
50
+ This command will create `.dac` files with the same name as the input files.
51
+ It will also preserve the directory structure relative to input root and
52
+ re-create it in the output directory. Please use `python -m dac encode --help`
53
+ for more options.
54
 
55
+ ### Reconstruct audio from compressed codes
56
+ ```
57
+ python3 -m dac decode /path/to/output/codes --output /path/to/reconstructed_input
58
+ ```
59
 
60
+ This command will create `.wav` files with the same name as the input files.
61
+ It will also preserve the directory structure relative to input root and
62
+ re-create it in the output directory. Please use `python -m dac decode --help`
63
+ for more options.
64
 
65
+ ### Programmatic Usage
66
+ ```py
67
+ import dac
68
+ from audiotools import AudioSignal
69
 
70
+ # Download a model
71
+ model_path = dac.utils.download(model_type="44khz")
72
+ model = dac.DAC.load(model_path)
73
 
74
+ model.to('cuda')
75
 
76
+ # Load audio signal file
77
+ signal = AudioSignal('input.wav')
78
 
79
+ # Encode audio signal as one long file
80
+ # (may run out of GPU memory on long files)
81
+ signal.to(model.device)
82
 
83
+ x = model.preprocess(signal.audio_data, signal.sample_rate)
84
+ z, codes, latents, _, _ = model.encode(x)
85
 
86
+ # Decode audio signal
87
+ y = model.decode(z)
88
 
89
+ # Alternatively, use the `compress` and `decompress` functions
90
+ # to compress long files.
91
 
92
+ signal = signal.cpu()
93
+ x = model.compress(signal)
94
 
95
+ # Save and load to and from disk
96
+ x.save("compressed.dac")
97
+ x = dac.DACFile.load("compressed.dac")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
98
 
99
+ # Decompress it back to an AudioSignal
100
+ y = model.decompress(x)
101
 
102
+ # Write to file
103
+ y.write('output.wav')
104
+ ```