Update README.md

README.md

@@ -1,23 +1,70 @@
 ---
 license: apache-2.0
+language: en
+datasets:
+- Jzuluaga/uwb_atcc
 tags:
+- text
+- token-classification
+- en-atc
+- en
 - generated_from_trainer
+- bert
+- bertraffic
 metrics:
-- precision
-- recall
-- f1
-- accuracy
+- Precision
+- Recall
+- Accuracy
+- F1
+- Jaccard Error Rate
+widget:
+- text: "lining up runway three one csa five bravo easy five three kilo romeo contact ruzyne ground one two one decimal nine good bye"
+- text: "swiss four six one foxtrot line up runway three one and wait one two one nine csa four yankee alfa"
+- text: "tower klm five five tango ils three one wizz air four papa uniform tower roger"
 model-index:
-- name: uwb_atcc
-  results: []
+- name: bert-base-token-classification-for-atc-en-uwb-atcc
+  results:
+  - task:
+        type: token-classification
+        name: chunking
+    dataset:
+        type: Jzuluaga/uwb_atcc
+        name: UWB-ATCC corpus (Air Traffic Control Communications)
+        config: test
+        split: test
+    metrics:
+    - type: F1
+      value: 0.87
+      name: TEST F1 (macro)
+      verified: False
+    - type: Accuracy
+      value: 0.91
+      name: TEST Accuracy
+      verified: False
+    - type: Precision
+      value: 0.86
+      name: TEST Precision (macro)
+      verified: False
+    - type: Recall
+      value: 0.88
+      name: TEST Recall (macro)
+      verified: False   
+    - type: Jaccard Error Rate
+      value: 0.169
+      name: TEST Jaccard Error Rate
+      verified: False   
+      
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# bert-base-token-classification-for-atc-en-uwb-atcc
 
-# uwb_atcc
 
-This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on an unknown dataset.
+This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on the [UWB-ATCC corpus](https://huggingface.co/datasets/Jzuluaga/uwb_atcc). 
+
+<a href="https://github.com/idiap/bert-text-diarization-atc">
+    <img alt="GitHub" src="https://img.shields.io/badge/GitHub-Open%20source-green\">
+</a>
+
 It achieves the following results on the evaluation set:
 - Loss: 0.0098
 - Precision: 0.9760
@@ -25,17 +72,101 @@ It achieves the following results on the evaluation set:
 - F1: 0.9750
 - Accuracy: 0.9965
 
-## Model description
 
-More information needed
+Paper: [BERTraffic: BERT-based Joint Speaker Role and Speaker Change Detection for Air Traffic Control Communications](https://arxiv.org/abs/2110.05781).
+
+Authors: Juan Zuluaga-Gomez, Seyyed Saeed Sarfjoo, Amrutha Prasad, Iuliia Nigmatulina, Petr Motlicek, Karel Ondrej, Oliver Ohneiser, Hartmut Helmke
+
+Abstract: Automatic speech recognition (ASR) allows transcribing the communications between air traffic controllers (ATCOs) and aircraft pilots. The transcriptions are used later to extract ATC named entities, e.g., aircraft callsigns. One common challenge is speech activity detection (SAD) and speaker diarization (SD). In the failure condition, two or more segments remain in the same recording, jeopardizing the overall performance. We propose a system that combines SAD and a BERT model to perform speaker change detection and speaker role detection (SRD) by chunking ASR transcripts, i.e., SD with a defined number of speakers together with SRD. The proposed model is evaluated on real-life public ATC databases. Our BERT SD model baseline reaches up to 10% and 20% token-based Jaccard error rate (JER) in public and private ATC databases. We also achieved relative improvements of 32% and 7.7% in JERs and SD error rate (DER), respectively, compared to VBx, a well-known SD system. 
+
+Code — GitHub repository: https://github.com/idiap/bert-text-diarization-atc
+
 
 ## Intended uses & limitations
 
-More information needed
+This model was fine-tuned on air traffic control data. We don't expect that it keeps the same performance on some others datasets where BERT was pre-trained or fine-tuned.
 
 ## Training and evaluation data
 
-More information needed
+See Table 3 (page 5) in our paper:[BERTraffic: BERT-based Joint Speaker Role and Speaker Change Detection for Air Traffic Control Communications](https://arxiv.org/abs/2110.05781).. We described there the data used to fine-tune or model for speaker role and speaker change detection. 
+
+- We use the UWB-ATCC corpus to fine-tune this model. You can download the raw data here: https://lindat.mff.cuni.cz/repository/xmlui/handle/11858/00-097C-0000-0001-CCA1-0
+- However, do not worry, we have prepared a script in our repository for preparing this databases:
+  - Dataset preparation folder: https://github.com/idiap/bert-text-diarization-atc/tree/main/data/databases/uwb_atcc
+  - Prepare the data: https://github.com/idiap/bert-text-diarization-atc/blob/main/data/databases/uwb_atcc/data_prepare_uwb_atcc_corpus.sh
+  - Get the data in the format required by HuggingFace: https://github.com/idiap/bert-text-diarization-atc/blob/main/data/databases/uwb_atcc/exp_prepare_uwb_atcc_corpus.sh
+
+
+## Writing your own inference script
+
+If you use language model, you need to install the KenLM bindings with:
+
+```bash
+conda activate your_environment
+pip install https://github.com/kpu/kenlm/archive/master.zip
+```
+
+The snippet of code:
+
+```python
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+
+tokenizer = AutoTokenizer.from_pretrained("Jzuluaga/bert-base-token-classification-for-atc-en-uwb-atcc")
+model = AutoModelForTokenClassification.from_pretrained("Jzuluaga/bert-base-token-classification-for-atc-en-uwb-atcc")
+
+
+##### Process text sample (from wikipedia)
+
+from transformers import pipeline
+
+nlp = pipeline('ner', model=model, tokenizer=tokenizer, aggregation_strategy="simple")
+nlp("lining up runway three one csa five bravo b easy five three kilo romeo contact ruzyne ground one two one decimal nine good bye)
+
+
+[{'entity_group': 'pilot',
+'score': 0.99991554,
+'word': 'lining up runway three one csa five bravo b', 'start': 0, 'end': 43
+},
+{'entity_group': 'atco',
+'score': 0.99994576,
+'word': 'easy five three kilo romeo contact ruzyne ground one two one decimal nine good bye', 'start': 44, 'end': 126
+}]
+
+```
+
+# Cite us
+
+If you use this code for your research, please cite our paper with:
+
+```
+@article{zuluaga2022bertraffic,
+  title={BERTraffic: BERT-based Joint Speaker Role and Speaker Change Detection for Air Traffic Control Communications},
+  author={Zuluaga-Gomez, Juan and Sarfjoo, Seyyed Saeed and Prasad, Amrutha and others},
+  journal={IEEE Spoken Language Technology Workshop (SLT), Doha, Qatar},
+  year={2022}
+  }
+```
+
+and,
+
+```
+@article{zuluaga2022how,
+    title={How Does Pre-trained Wav2Vec2. 0 Perform on Domain Shifted ASR? An Extensive Benchmark on Air Traffic Control Communications},
+    author={Zuluaga-Gomez, Juan and Prasad, Amrutha and Nigmatulina, Iuliia and Sarfjoo, Saeed and others},
+    journal={IEEE Spoken Language Technology Workshop (SLT), Doha, Qatar},
+    year={2022}
+  }
+```
+and, 
+
+```
+@article{zuluaga2022atco2,
+  title={ATCO2 corpus: A Large-Scale Dataset for Research on Automatic Speech Recognition and Natural Language Understanding of Air Traffic Control Communications},
+  author={Zuluaga-Gomez, Juan and Vesel{\`y}, Karel and Sz{\"o}ke, Igor and Motlicek, Petr and others},
+  journal={arXiv preprint arXiv:2211.04054},
+  year={2022}
+}
+```
 
 ## Training procedure