nielsr HF Staff commited on
Commit
058b162
·
verified ·
1 Parent(s): 01f5d9b

Add library name to metadata and available models table

Browse files

This PR adds the `library_name` to the model card metadata. The `sq_codec` library is used for this model. Additionally, the table containing the available models and their configurations has been added to the model card for better user understanding.

Files changed (1) hide show
  1. README.md +15 -2
README.md CHANGED
@@ -1,7 +1,9 @@
1
  ---
2
  license: mit
3
  pipeline_tag: audio-to-audio
 
4
  ---
 
5
  # SQCodec
6
 
7
  This repository contains the implementation of SQCodec, a lightweight audio codec based on a single quantizer, introduced in the paper titled "One Quantizer is Enough: Toward a Lightweight Audio Codec".
@@ -10,7 +12,6 @@ This repository contains the implementation of SQCodec, a lightweight audio code
10
 
11
  [Code](https://github.com/zhai-lw/SQCodec)
12
 
13
-
14
  ## install
15
 
16
  ```
@@ -59,4 +60,16 @@ with torch.inference_mode():
59
 
60
  mse = ((sample_audio - generated_audio) ** 2).mean().item()
61
  print(f"codec({MODEL_USED}) mse: {mse}")
62
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
  pipeline_tag: audio-to-audio
4
+ library_name: sq_codec
5
  ---
6
+
7
  # SQCodec
8
 
9
  This repository contains the implementation of SQCodec, a lightweight audio codec based on a single quantizer, introduced in the paper titled "One Quantizer is Enough: Toward a Lightweight Audio Codec".
 
12
 
13
  [Code](https://github.com/zhai-lw/SQCodec)
14
 
 
15
  ## install
16
 
17
  ```
 
60
 
61
  mse = ((sample_audio - generated_audio) ** 2).mean().item()
62
  print(f"codec({MODEL_USED}) mse: {mse}")
63
+ ```
64
+
65
+ ### available models
66
+
67
+ | config_name | Sample rate(Hz) | tokens/s | Codebook size | Bitrate(bps) |
68
+ |--------------|-----------------|----------|---------------|--------------|
69
+ | 0k75bps | 16,000 | 44.44 | 117,649 | 748.6 |
70
+ | 1k5bps | 16,000 | 88.89 | 117,649 | 1497.3 |
71
+ | 3kbps | 16,000 | 177.78 | 117,649 | 2994.5 |
72
+ | 6kbps | 16,000 | 355.56 | 117,649 | 5989.0 |
73
+ | 12kbps | 16,000 | 666.67 | 250,047 | 11954.6 |
74
+ | 12kbps_24khz | 24,000 | 666.67 | 250,047 | 11954.6 |
75
+ | 24kbps_24khz | 24,000 | 1333.33 | 250,047 | 23909.1 |