Skip to content

Commit 23f7c46

Browse files
authored
Update README.md
1 parent dc66a63 commit 23f7c46

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ pip install -e .[dev]
2121

2222
## Inference
2323

24-
Load a model based on its [[#Pre-trained models| Pre-trained model ID]]:
24+
Load a model based on its [Pre-trained model ID](#hugging-face-model-ids):
2525

2626
```python
2727
import torch
@@ -106,14 +106,14 @@ Output:
106106

107107
## Available models
108108

109-
| Model | Input | Rate | Tagging | Difficulty | Pitch | Chord | Beat | Structure |
109+
| Model | Input | Rate | Tagging | Difficulty | Pitch | Chord | Beat | Structure |
110110
|--------------------------|--------|--------|---------|------------|---------|---------|--------|-----------|
111111
| | | Hz | _mAP_ | _MSE_ | _acc._ | _acc._ | _F1_ | _acc._ |
112-
| **base** | mel | 15.63 | .482 | **1.65** | .892 | .657 | .783 | **.647** |
113-
| **multicodebook** | mel | 15.63 | **.488** | 1.66 | .897 | .675 | .775 | .639 |
112+
| **base** | mel | 15.63 | .482 | **1.65** | .892 | .657 | .783 | **.647** |
113+
| **multicodebook** | mel | 15.63 | **.488** | 1.66 | .897 | .675 | .775 | .639 |
114114
| **multifeature** | audio | 18.75 | .467 | 1.76 | .938 | .734 | .833 | .623 |
115115
| **multifeature-25hz** | audio | 25 | .463 | 1.79 | .932 | .728 | .848 | .628 |
116-
| **multifeature-25hz-fsq**| audio | 25 | .463 | 1.71 | **.940**| **.749**| **.855** | .628 |
116+
| **multifeature-25hz-fsq**| audio | 25 | .463 | 1.71 | **.940**| **.749**| **.855** | .628 |
117117

118118
OMAR-RQ models are offered in different configurations, each with its own strengths and weaknesses.
119119
Models based on mel spectrogram (**base** and **multicodebook**) tend to perform better on semantic tasks such as auto-tagging, structure recognition, and difficulty estimation.
@@ -147,8 +147,8 @@ Check the default [config file](../cfg/rq_single_view/config.gin) to see the dif
147147

148148
At least the following parameters should be modified:
149149

150-
- `DiscotubeMultiViewAudioDataModule.data_dir` -> This should point to your base data folder.
151-
- `DiscotubeMultiViewAudioDataModule.filelist_train` -> This should point to a filelist of training audio paths relative to the `data_dir` (one audio file per line).
150+
- `DiscotubeMultiViewAudioDataModule.data_dir` -> Your base data folder.
151+
- `DiscotubeMultiViewAudioDataModule.filelist_train` -> Filelist of training audio paths relative to the `data_dir` (one file per line).
152152
- `DiscotubeMultiViewAudioDataModule.filelist_val` -> Same for the tracks on the validation split.
153153

154154
4. Run the experiment

0 commit comments

Comments
 (0)