Path updates to CoRal-project and citation info added

README.md

@@ -1,6 +1,6 @@
 ---
 datasets:
-- CoRal-dataset/coral-v2
+- CoRal-project/coral-v2
 language:
 - da
 base_model:
@@ -33,7 +33,7 @@ model-index:
 # Pre-release of Roest-wav2vec2-315m-v2
 This is a pre-release of a Danish state-of-the-art speech recognition model, trained as part of the CoRal project by [Alvenir](https://www.alvenir.ai/).
 
-This repository contains a Wav2Vec2 model trained on the [CoRal-v2 dataset](https://huggingface.co/datasets/CoRal-dataset/coral-v2/tree/main). The CoRal-v2 dataset includes a rich variety of Danish conversational and read-aloud data, distributed across diverse age groups, genders, and dialects. The model is designed for automatic speech recognition (ASR).
+This repository contains a Wav2Vec2 model trained on the [CoRal-v2 dataset](https://huggingface.co/datasets/CoRal-project/coral-v2/tree/main). The CoRal-v2 dataset includes a rich variety of Danish conversational and read-aloud data, distributed across diverse age groups, genders, and dialects. The model is designed for automatic speech recognition (ASR).
 
 ## Quick Start
 
@@ -48,7 +48,7 @@ Next you can use the model using the `transformers` Python package as follows:
 ```python
 >>> from transformers import pipeline
 >>> audio = get_audio()  # 16kHz raw audio array
->>> transcriber = pipeline(model="CoRal-dataset/roest-wav2vec2-315m-v2")
+>>> transcriber = pipeline(model="CoRal-project/roest-wav2vec2-315m-v2")
 >>> transcriber(audio)
 {'text': 'your transcription'}
 ```
@@ -64,7 +64,7 @@ Explore the following audio samples along with their transcriptions and accuracy
 
 **Audio Sample:**  
 <audio controls>
-  <source src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example1.wav" type="audio/wav">
+  <source src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example1.wav" type="audio/wav">
   Your browser does not support the audio tag.
 </audio>
 
@@ -83,7 +83,7 @@ Explore the following audio samples along with their transcriptions and accuracy
 
 **Audio Sample:**  
 <audio controls>
-  <source src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example2.wav" type="audio/wav">
+  <source src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example2.wav" type="audio/wav">
   Your browser does not support the audio tag.
 </audio>
 
@@ -102,7 +102,7 @@ Explore the following audio samples along with their transcriptions and accuracy
 
 **Audio Sample:**  
 <audio controls>
-  <source src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example3.wav" type="audio/wav">
+  <source src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example3.wav" type="audio/wav">
   Your browser does not support the audio tag.
 </audio>
 
@@ -121,7 +121,7 @@ Explore the following audio samples along with their transcriptions and accuracy
 
 **Audio Sample:**  
 <audio controls>
-  <source src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example4.wav" type="audio/wav">
+  <source src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/audio_samples/example4.wav" type="audio/wav">
   Your browser does not support the audio tag.
 </audio>
 
@@ -138,9 +138,9 @@ Explore the following audio samples along with their transcriptions and accuracy
 
 ## Model Details
 
-Wav2Vec2 is a state-of-the-art model architecture for speech recognition, leveraging self-supervised learning from raw audio data. The pre-trained [Wav2Vec2-XLS-R-300M](facebook/wav2vec2-xls-r-300m) has been fine-tuned for automatic speech recognition with the [CoRal-v2 dataset](https://huggingface.co/datasets/CoRal-dataset/coral-v2/tree/main) dataset to enhance its performance in recognizing Danish speech with consideration to different dialects. The model was trained for 30K steps using the training setup in the [CoRaL repository](https://github.com/alexandrainst/coral/tree) by running:
+Wav2Vec2 is a state-of-the-art model architecture for speech recognition, leveraging self-supervised learning from raw audio data. The pre-trained [Wav2Vec2-XLS-R-300M](facebook/wav2vec2-xls-r-300m) has been fine-tuned for automatic speech recognition with the [CoRal-v2 dataset](https://huggingface.co/datasets/CoRal-project/coral-v2/tree/main) dataset to enhance its performance in recognizing Danish speech with consideration to different dialects. The model was trained for 30K steps using the training setup in the [CoRaL repository](https://github.com/alexandrainst/coral/tree) by running:
 ```
-python src/scripts/finetune_asr_model.py model=wav2vec2-small max_steps=30000 datasets.coral_conversation_internal.id=CoRal-dataset/coral-v2 datasets.coral_readaloud_internal.id=CoRal-dataset/coral-v2
+python src/scripts/finetune_asr_model.py model=wav2vec2-small max_steps=30000 datasets.coral_conversation_internal.id=CoRal-project/coral-v2 datasets.coral_readaloud_internal.id=CoRal-project/coral-v2
 ```
 The model is evaluated using a Language Model (LM) as post-processing. The utilized LM is the one trained and used by [alexandrainst/roest-wav2vec2-315m-v1](https://huggingface.co/alexandrainst/roest-315m).
 
@@ -148,7 +148,7 @@ The model is evaluated using a Language Model (LM) as post-processing. The utili
 
 ## Dataset
 
-### [CoRal-v2](https://huggingface.co/datasets/CoRal-dataset/coral-v2/tree/main)
+### [CoRal-v2](https://huggingface.co/datasets/CoRal-project/coral-v2/tree/main)
 - **Subsets**: 
 	- Conversation
 	- Read-aloud
@@ -170,7 +170,7 @@ The model was evaluated using the following metrics:
 
 | Model                                                                                            | Number of parameters |   Finetuned on data of type | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) CER | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) WER |
 | :----------------------------------------------------------------------------------------------- | -------------------: | --------------------------: | --------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------: |
-| [CoRal-dataset/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-dataset/roest-whisper-large) |                 315M | Read-aloud and conversation |                                                                             6.5% ± 0.2% |                                                                            16.3% ± 0.4% |
+| [CoRal-project/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-project/roest-whisper-large) |                 315M | Read-aloud and conversation |                                                                             6.5% ± 0.2% |                                                                            16.3% ± 0.4% |
 | [Alvenir/roest-whisper-large-v1](https://huggingface.co/Alvenir/coral-1-whisper-large)            |                1540M |                  Read-aloud |                                                                         **4.3% ± 0.2%** |                                                                        **10.4% ± 0.3%** |
 | [alexandrainst/roest-wav2vec2-315M-v1](https://huggingface.co/alexandrainst/roest-315m)                      |                 315M |                  Read-aloud |                                                                             6.6% ± 0.2% |                                                                            17.0% ± 0.4% |
 | [mhenrichsen/hviske-v2](https://huggingface.co/syvai/hviske-v2)                                  |                1540M |                  Read-aloud |                                                                             4.7% ± 0.2% |                                                                            11.8% ± 0.3% |
@@ -179,9 +179,9 @@ The model was evaluated using the following metrics:
 **OBS!** Benchmark for hviske-v2 has been reevaluted and the confidence interval is larger than  reported in the model card.
 
 ### Detailed evaluation across demographics on the CoRal test data
-<img src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/images/wer.png">
+<img src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/images/wer.png">
 
-<img src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/images/cer.png">
+<img src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/images/cer.png">
 
 ### Table WER scores in % of evaluation across demographics on the CoRal test data
 | Category | roest-whisper-large-v1 | roest-wav2vec2-315m-v1 | roest-wav2vec2-315m-v2 |
@@ -230,8 +230,8 @@ The inclusion of a post-processing language model can affect the performance sig
 
 | Model                                                                                         | Number of parameters |   Finetuned on data of type | Postprocessed with Language Model | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) CER | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) WER |
 | :-------------------------------------------------------------------------------------------- | -------------------: | --------------------------: | --------------------------------: | --------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------: |
-| [CoRal-dataset/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2) |                 315M | Read-aloud and conversation |                               Yes |                                                                         **6.5% ± 0.2%** |                                                                        **16.3% ± 0.4%** |
-| [CoRal-dataset/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2) |                 315M | Read-aloud and conversation |                                No |                                                                             8.2% ± 0.2% |                                                                            25.1% ± 0.4% |
+| [CoRal-project/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2) |                 315M | Read-aloud and conversation |                               Yes |                                                                         **6.5% ± 0.2%** |                                                                        **16.3% ± 0.4%** |
+| [CoRal-project/roest-wav2vec2-315M-v2](https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2) |                 315M | Read-aloud and conversation |                                No |                                                                             8.2% ± 0.2% |                                                                            25.1% ± 0.4% |
 | [alexandrainst/roest-wav2vec2-315m-v1](https://huggingface.co/alexandrainst/roest-315m)                   |                 315M |                  Read-aloud |                               Yes |                                                                             6.6% ± 0.2% |                                                                            17.0% ± 0.4% |
 | [alexandrainst/roest-wav2vec2-315m-v1](https://huggingface.co/alexandrainst/roest-315m)                   |                 315M |                  Read-aloud |                                No |                                                                             8.6% ± 0.2% |                                                                            26.3% ± 0.5% |
 
@@ -273,7 +273,7 @@ The model was also tested against other datasets to evaluate generalizability:
 ---
 
 ## Training curves
-<img src="https://huggingface.co/CoRal-dataset/roest-wav2vec2-315m-v2/resolve/main/images/training_plots.png">
+<img src="https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2/resolve/main/images/training_plots.png">
 
 --- 
 
@@ -288,4 +288,15 @@ The CoRal project is funded by the [Danish Innovation Fund](https://innovationsf
 - [Alvenir](https://www.alvenir.ai/)
 - [Corti](https://www.corti.ai/)
 
-We would like specifically thank Dan Saattrup Nielsen, Alexandra Institute for (among other things) the repository work and Simon Leminen Madsen, Alexandra Institute for modelling work.
+We would like specifically to thank Dan Saattrup Nielsen, Alexandra Institute for (among other things) the repository work and Simon Leminen Madsen, Alexandra Institute for modelling work.
+
+## Citation
+
+We will submit a research paper soon, but until then, if you use this model in your research or development, please cite it as follows:
+
+@misc{roest-wav2vec2-315m-v2,
+  author    = {Marie Juhl Jørgensen, Søren Vejlgaard Holm, Martin Carsten Nielsen, Dan Saattrup Nielsen, Sif Bernstorff Lehmann, Simon Leminen Madsen, Anders Jess Pedersen, Anna Katrine van Zee, Anders Søgaard and Torben Blach},
+  title     = {Roest-wav2vec-315m-v2: A Danish state-of-the-art speech recognition model trained on varied demographics and dialects},
+  year      = {2025},
+  url       = {https://huggingface.co/CoRal-project/roest-wav2vec2-315m-v2},
+}