Update README.md
Browse files
README.md
CHANGED
|
@@ -1,200 +1,117 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
tags:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
pipeline_tag: automatic-speech-recognition
|
| 5 |
license: apache-2.0
|
|
|
|
|
|
|
|
|
|
| 6 |
---
|
| 7 |
|
| 8 |
-
#
|
| 9 |
|
| 10 |
-
This repository contains the model
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
|
| 15 |
|
| 16 |
-
## Model
|
| 17 |
-
|
| 18 |
-
### Model Description
|
| 19 |
-
|
| 20 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 21 |
-
|
| 22 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 23 |
-
|
| 24 |
-
- **Developed by:** [More Information Needed]
|
| 25 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 26 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 27 |
-
- **Model type:** [More Information Needed]
|
| 28 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 29 |
-
- **License:** apache-2.0
|
| 30 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 31 |
-
|
| 32 |
-
### Model Sources [optional]
|
| 33 |
-
|
| 34 |
-
<!-- Provide the basic links for the model. -->
|
| 35 |
-
|
| 36 |
-
- **Repository:** [More Information Needed]
|
| 37 |
-
- **Paper [optional]:** [More Information Needed]
|
| 38 |
-
- **Demo [optional]:** [More Information Needed]
|
| 39 |
-
|
| 40 |
-
## Uses
|
| 41 |
-
|
| 42 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 43 |
-
|
| 44 |
-
### Direct Use
|
| 45 |
-
|
| 46 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 47 |
-
|
| 48 |
-
[More Information Needed]
|
| 49 |
-
|
| 50 |
-
### Downstream Use [optional]
|
| 51 |
-
|
| 52 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 53 |
-
|
| 54 |
-
[More Information Needed]
|
| 55 |
-
|
| 56 |
-
### Out-of-Scope Use
|
| 57 |
-
|
| 58 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 59 |
-
|
| 60 |
-
[More Information Needed]
|
| 61 |
-
|
| 62 |
-
## Bias, Risks, and Limitations
|
| 63 |
-
|
| 64 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 65 |
-
|
| 66 |
-
[More Information Needed]
|
| 67 |
-
|
| 68 |
-
### Recommendations
|
| 69 |
-
|
| 70 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 71 |
-
|
| 72 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 73 |
-
|
| 74 |
-
## How to Get Started with the Model
|
| 75 |
-
|
| 76 |
-
Use the code below to get started with the model.
|
| 77 |
-
|
| 78 |
-
[More Information Needed]
|
| 79 |
-
|
| 80 |
-
## Training Details
|
| 81 |
-
|
| 82 |
-
### Training Data
|
| 83 |
-
|
| 84 |
-
<!-- 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. -->
|
| 85 |
-
|
| 86 |
-
[More Information Needed]
|
| 87 |
-
|
| 88 |
-
### Training Procedure
|
| 89 |
-
|
| 90 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 91 |
-
|
| 92 |
-
#### Preprocessing [optional]
|
| 93 |
-
|
| 94 |
-
[More Information Needed]
|
| 95 |
-
|
| 96 |
-
#### Training Hyperparameters
|
| 97 |
-
|
| 98 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 99 |
-
|
| 100 |
-
#### Speeds, Sizes, Times [optional]
|
| 101 |
-
|
| 102 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 103 |
-
|
| 104 |
-
[More Information Needed]
|
| 105 |
|
| 106 |
-
|
| 107 |
|
| 108 |
-
|
|
|
|
|
|
|
| 109 |
|
| 110 |
-
|
| 111 |
|
| 112 |
-
#### Testing Data
|
| 113 |
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
[More Information Needed]
|
| 117 |
-
|
| 118 |
-
#### Factors
|
| 119 |
-
|
| 120 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 121 |
-
|
| 122 |
-
[More Information Needed]
|
| 123 |
-
|
| 124 |
-
#### Metrics
|
| 125 |
-
|
| 126 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 127 |
-
|
| 128 |
-
[More Information Needed]
|
| 129 |
-
|
| 130 |
-
### Results
|
| 131 |
-
|
| 132 |
-
[More Information Needed]
|
| 133 |
-
|
| 134 |
-
#### Summary
|
| 135 |
-
|
| 136 |
-
## Model Examination [optional]
|
| 137 |
-
|
| 138 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 139 |
-
|
| 140 |
-
[More Information Needed]
|
| 141 |
-
|
| 142 |
-
## Environmental Impact
|
| 143 |
-
|
| 144 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 145 |
-
|
| 146 |
-
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).
|
| 147 |
-
|
| 148 |
-
- **Hardware Type:** [More Information Needed]
|
| 149 |
-
- **Hours used:** [More Information Needed]
|
| 150 |
-
- **Cloud Provider:** [More Information Needed]
|
| 151 |
-
- **Compute Region:** [More Information Needed]
|
| 152 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 153 |
-
|
| 154 |
-
## Technical Specifications [optional]
|
| 155 |
-
|
| 156 |
-
### Model Architecture and Objective
|
| 157 |
-
|
| 158 |
-
[More Information Needed]
|
| 159 |
-
|
| 160 |
-
### Compute Infrastructure
|
| 161 |
-
|
| 162 |
-
[More Information Needed]
|
| 163 |
-
|
| 164 |
-
#### Hardware
|
| 165 |
-
|
| 166 |
-
[More Information Needed]
|
| 167 |
-
|
| 168 |
-
#### Software
|
| 169 |
-
|
| 170 |
-
[More Information Needed]
|
| 171 |
-
|
| 172 |
-
## Citation [optional]
|
| 173 |
-
|
| 174 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 175 |
-
|
| 176 |
-
**BibTeX:**
|
| 177 |
-
|
| 178 |
-
[More Information Needed]
|
| 179 |
-
|
| 180 |
-
**APA:**
|
| 181 |
-
|
| 182 |
-
[More Information Needed]
|
| 183 |
-
|
| 184 |
-
## Glossary [optional]
|
| 185 |
-
|
| 186 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 187 |
-
|
| 188 |
-
[More Information Needed]
|
| 189 |
-
|
| 190 |
-
## More Information [optional]
|
| 191 |
-
|
| 192 |
-
[More Information Needed]
|
| 193 |
-
|
| 194 |
-
## Model Card Authors [optional]
|
| 195 |
-
|
| 196 |
-
[More Information Needed]
|
| 197 |
-
|
| 198 |
-
## Model Card Contact
|
| 199 |
|
| 200 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
+
tags:
|
| 4 |
+
- speech
|
| 5 |
+
- automatic-speech-recognition
|
| 6 |
+
- whisper
|
| 7 |
+
- multilingual
|
| 8 |
+
- fine-tuned
|
| 9 |
+
- mlc-slm
|
| 10 |
+
- speaker-diarization
|
| 11 |
+
- meeting-transcription
|
| 12 |
+
- DiCoW
|
| 13 |
+
- BUT-FIT
|
| 14 |
pipeline_tag: automatic-speech-recognition
|
| 15 |
license: apache-2.0
|
| 16 |
+
datasets:
|
| 17 |
+
- microsoft/NOTSOFAR
|
| 18 |
+
- edinburghcstr/ami
|
| 19 |
---
|
| 20 |
|
| 21 |
+
# DiCoW\_v3\_MLC — BUT-FIT Model for MLC-SLM Challenge
|
| 22 |
|
| 23 |
+
This repository contains the **DiCoW\_v3\_MLC** model developed by [BUT Speech@FIT](https://github.com/BUTSpeechFIT) for the [MLC-SLM Challenge](https://www.nexdata.ai/competition/mlc-slm).
|
| 24 |
+
Diarization-Conditioned Whisper (DiCoW) is a novel approach to target-speaker ASR that leverages speaker diarization outputs as conditioning information.
|
| 25 |
|
| 26 |
+
The model is described in detail in the following papers:
|
| 27 |
|
| 28 |
+
* 📰 **Journal paper (main DiCoW paper):** [DiCoW: Diarization-Conditioned Whisper for Target Speaker Automatic Speech Recognition](https://authors.elsevier.com/a/1lI9m_K8BYumVY)
|
| 29 |
+
* 📰 **ICASSP paper (initial DiCoW experiments):** [Target Speaker ASR with Whisper](https://ieeexplore.ieee.org/document/10887683)
|
| 30 |
+
* 📰 **MLC-SLM Challenge submission paper:** [BUT System for the MLC-SLM Challenge](https://www.arxiv.org/abs/2506.13414)
|
| 31 |
|
| 32 |
+
## Model Summary
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
+
The model is based on **Whisper large-v3-turbo**, initially trained on:
|
| 35 |
|
| 36 |
+
* **NOTSOFAR-1**
|
| 37 |
+
* **AMI** Meeting Corpus
|
| 38 |
+
* **Libri2Mix** dataset
|
| 39 |
|
| 40 |
+
It is then fine-tuned on the **MLC-SLM dataset** as part of the MLC-SLM Challenge.
|
| 41 |
|
|
|
|
| 42 |
|
| 43 |
+
## Model Details
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
+
* **Developed by:** BUT Speech\@FIT, Brno University of Technology
|
| 46 |
+
* **Model type:** Whisper large-v3-turbo + DiCoW composition
|
| 47 |
+
* **Language(s):** Multilingual (primarily English, but supports multiple languages)
|
| 48 |
+
* **License:** apache-2.0
|
| 49 |
+
* **Fine-tuned from:** openai/whisper-large-v3-turbo
|
| 50 |
+
* **Challenge:** MLC-SLM (Multilingual Conversational Speech Language Model)
|
| 51 |
+
|
| 52 |
+
## Model Sources
|
| 53 |
+
|
| 54 |
+
* **Training Code:** [TS-ASR-Whisper GitHub](https://github.com/BUTSpeechFIT/TS-ASR-Whisper)
|
| 55 |
+
* **Inference Code & DiCoW framework:** [DiCoW GitHub](https://github.com/BUTSpeechFIT/DiCoW)
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
## Getting Started
|
| 59 |
+
|
| 60 |
+
```python
|
| 61 |
+
from transformers import AutoModelForSpeechSeq2Seq
|
| 62 |
+
|
| 63 |
+
MODEL_NAME = "BUT-FIT/DiCoW_v3_MLC"
|
| 64 |
+
dicow = AutoModelForSpeechSeq2Seq.from_pretrained(MODEL_NAME, trust_remote_code=True)
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
For detailed inference and full pipelines, refer to:
|
| 68 |
+
👉 [DiCoW GitHub inference repo](https://github.com/BUTSpeechFIT/DiCoW)
|
| 69 |
+
|
| 70 |
+
|
| 71 |
+
|
| 72 |
+
## Citation
|
| 73 |
+
|
| 74 |
+
If you use this model, please cite:
|
| 75 |
+
|
| 76 |
+
```bibtex
|
| 77 |
+
@article{POLOK2026101841,
|
| 78 |
+
title = {DiCoW: Diarization-conditioned Whisper for target speaker automatic speech recognition},
|
| 79 |
+
journal = {Computer Speech & Language},
|
| 80 |
+
volume = {95},
|
| 81 |
+
pages = {101841},
|
| 82 |
+
year = {2026},
|
| 83 |
+
issn = {0885-2308},
|
| 84 |
+
doi = {https://doi.org/10.1016/j.csl.2025.101841},
|
| 85 |
+
url = {https://www.sciencedirect.com/science/article/pii/S088523082500066X},
|
| 86 |
+
author = {Alexander Polok and Dominik Klement and Martin Kocour and Jiangyu Han and Federico Landini and Bolaji Yusuf and Matthew Wiesner and Sanjeev Khudanpur and Jan Černocký and Lukáš Burget},
|
| 87 |
+
keywords = {Diarization-conditioned Whisper, Target-speaker ASR, Speaker diarization, Long-form ASR, Whisper adaptation},
|
| 88 |
+
}
|
| 89 |
+
|
| 90 |
+
@INPROCEEDINGS{10887683,
|
| 91 |
+
author={Polok, Alexander and Klement, Dominik and Wiesner, Matthew and Khudanpur, Sanjeev and Černocký, Jan and Burget, Lukáš},
|
| 92 |
+
booktitle={ICASSP 2025 - 2025 IEEE International Conference on Acoustics, Speech and Signal Processing (ICASSP)},
|
| 93 |
+
title={Target Speaker ASR with Whisper},
|
| 94 |
+
year={2025},
|
| 95 |
+
volume={},
|
| 96 |
+
number={},
|
| 97 |
+
pages={1-5},
|
| 98 |
+
keywords={Transforms;Signal processing;Transformers;Acoustics;Speech processing;target-speaker ASR;diarization conditioning;multi-speaker ASR;Whisper},
|
| 99 |
+
doi={10.1109/ICASSP49660.2025.10887683}
|
| 100 |
+
}
|
| 101 |
+
|
| 102 |
+
@misc{polok2025mlcslmchallenge,
|
| 103 |
+
title={BUT System for the MLC-SLM Challenge},
|
| 104 |
+
author={Alexander Polok and Jiangyu Han and Dominik Klement and Samuele Cornell and Jan Černocký and Lukáš Burget},
|
| 105 |
+
year={2025},
|
| 106 |
+
eprint={2506.13414},
|
| 107 |
+
archivePrefix={arXiv},
|
| 108 |
+
primaryClass={eess.AS},
|
| 109 |
+
url={https://arxiv.org/abs/2506.13414},
|
| 110 |
+
}
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
## Contact
|
| 114 |
+
|
| 115 |
+
For questions or collaborations:
|
| 116 |
+
**BUT Speech\@FIT, Brno University of Technology**
|
| 117 |
+
GitHub: [BUTSpeechFIT](https://github.com/BUTSpeechFIT)
|