Update README.md

README.md

@@ -1,57 +1,297 @@
----
-license: cc-by-sa-4.0
-dataset_info:
-  features:
-  - name: meeting_id
-    dtype: string
-  - name: speaker_id
-    dtype: string
-  - name: audio_id
-    dtype: string
-  - name: audio
-    dtype: audio
-  - name: segments
-    list:
-    - name: end
-      dtype: float64
-    - name: start
-      dtype: float64
-    - name: transcript
-      dtype: string
-    - name: words
-      list:
-      - name: end
-        dtype: float64
-      - name: start
-        dtype: float64
-      - name: word
-        dtype: string
-  - name: transcript
-    dtype: string
-  splits:
-  - name: example
-    num_bytes: 116022257.0
-    num_examples: 4
-  - name: dev
-    num_bytes: 14155765669.0
-    num_examples: 130
-  - name: train
-    num_bytes: 74754662936.0
-    num_examples: 684
-  - name: test
-    num_bytes: 13775584735.0
-    num_examples: 124
-  download_size: 120234623488
-  dataset_size: 102802035597.0
-configs:
-- config_name: default
-  data_files:
-  - split: example
-    path: data/example/example-*
-  - split: dev
-    path: data/dev/dev-*
-  - split: train
-    path: data/train/train-*
-  - split: test
-    path: data/test/test-*
----
+---
+license: cc-by-sa-4.0
+dataset_info:
+  features:
+  - name: meeting_id
+    dtype: string
+  - name: speaker_id
+    dtype: string
+  - name: audio_id
+    dtype: string
+  - name: audio
+    dtype: audio
+  - name: segments
+    list:
+    - name: end
+      dtype: float64
+    - name: start
+      dtype: float64
+    - name: transcript
+      dtype: string
+    - name: words
+      list:
+      - name: end
+        dtype: float64
+      - name: start
+        dtype: float64
+      - name: word
+        dtype: string
+  - name: transcript
+    dtype: string
+  splits:
+  - name: example
+    num_bytes: 116022257.0
+    num_examples: 4
+  - name: dev
+    num_bytes: 14155765669.0
+    num_examples: 130
+  - name: train
+    num_bytes: 74754662936.0
+    num_examples: 684
+  - name: test
+    num_bytes: 13775584735.0
+    num_examples: 124
+  download_size: 120234623488
+  dataset_size: 102802035597.0
+configs:
+- config_name: train
+  data_files:
+  - split: train
+    path: "data/train/*"
+- config_name: dev
+  data_files:
+  - split: train
+    path: "data/dev/*"
+- config_name: test
+  data_files:
+  - split: train
+    path: "data/test/*"
+- config_name: example
+  default: true
+  data_files:
+  - split: train
+    path: "data/example/*"
+---
+
+# Dataset Card for SUMM-RE 
+
+A collection of transcripts of French conversations, aligned with the audio signal.
+
+Data from the `dev` and `test` splits have been manually transcribed and aligned and so are suitable for the evaluation of automatic speech recognition and voice activity detection models. 
+
+Data from the `train` split has been automatically transcribed and aligned with the Whisper pipeline described in Yamasaki et al. (2023): "Transcribing And Aligning Conversational Speech: A Hybrid Pipeline Applied To French Conversations".
+
+The audio and transcripts used to evaluate this pipeline, a subset of the `dev` split<sup>*</sup>, can be found on [Ortolang](https://www.ortolang.fr/market/corpora/summ-re-asru/).
+
+The full dataset is described in Hunter et al. (2024): "SUMM-RE: A corpus of French meeting-style conversations".
+
+
+
+## Dataset Description
+
+The SUMM-RE dataset is a corpus of meeting-style conversations in French created for the purpose of the SUMM-RE project (ANR-20-CE23-0017). 
+
+Each conversation lasts roughly 20 minutes and involves 3-4 speakers. Each participant has an individual microphone and associated .wav file. 
+
+
+- **Created by:** Recording and manual correction of the corpus was carried out by the Language and Speech Lab (LPL) at the University of Aix-Marseille, France.
+- **Funded by:** The National Research Agency of France (ANR) for the SUMM-RE project (ANR-20-CE23-0017).
+- **Shared by:** LINAGORA (coordinator of the SUMM-RE project)
+- **Language:** French
+- **License:** CC BY-SA 4.0
+
+
+
+
+## Uses
+
+### Direct Use
+
+The `dev` and `test` splits of SUMM-RE can be used for the evaluation of automatic speech recognition models and voice activity detection for conversational, spoken French. All splits can be used for the training of large language models. 
+
+### Out-of-Scope Use
+
+Due to its size, the corpus is not suitable for training of automatic speech recognition or voice activity detection models.
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+To visualize an example from the corpus, select the "example" split in the Dataset Viewer.
+
+The corpus contains the following information for each .wav file:
+- **meeting_id**, e.g. 001a_PARL, includes:
+  - experiment number, e.g. 001
+  - meeting order: a|b|c (there were three meetings per experiment)
+  - experiment type: E (experiment) | P (pilot experiment)
+  - scenario/topic: A|B|C|D|E
+  - meeting type: R (reporting) | D (decision) | P (planning)
+  - recording location: L (LPL) | H (H2C2 studio) | Z (Zoom) | D (at home)
+- **speaker_id**
+- **audio_id**: meeting_id + speaker_id
+- **audio**: the .wav file for an individual speaker
+- **transcript**: a dictionary with the following format:
+
+```python
+{
+  "transcript": "bonjour toi ça va",
+  "segments": [
+    {
+      "start": 0.5,
+      "end": 1.2,
+      "transcript": "bonjour toi",
+      "words": [
+        {
+          "word": "bonjour",
+          "start": 0.5,
+          "end": 0.9
+        }
+        {
+          "word": "toi",
+          "start": 0.9,
+          "end": 1.2
+        }
+      ]
+    },
+    ...
+   ]
+}
+```
+
+## Example Use
+
+To load the dataset
+
+```python
+
+import datasets
+
+exampleset = datasets.load_dataset("linagora/SUMM-RE", "example", split="train")
+testset = datasets.load_dataset("linagora/SUMM-RE", "test", split="train")
+devset = datasets.load_dataset("linagora/SUMM-RE", "dev", split="train")
+trainset = datasets.load_dataset("linagora/SUMM-RE", "train", split="train")
+```
+
+Note that the `dev`, `train`and `test`splits are treated as configs, where each config has a single split, "train".
+
+## Dataset Creation
+
+### Curation Rationale
+
+The full SUMM-RE corpus, which includes meeting summaries, is designed to train and evaluate models for meeting summarization. This version is an extract of the full corpus used to evaluate various stages of the summarization pipeline, starting with automatic transcription of the audio signal.
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+The SUMM-RE corpus is an original corpus designed by members of LINAGORA and the University of Aix-Marseille and recorded by the latter. 
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+For details, see [Hunter et al. (2024)](https://hal.science/hal-04623038/).
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+Corpus design and production:
+- University of Aix-Marseille: Océane Granier (corpus conception, recording, annotation), Laurent Prévot (corpus conception, annotatation, supervision), Hiroyoshi Yamasaki (corpus cleaning, alignment and anonymization), Roxanne Bertrand (corpus conception and annotation) with helpful input from Brigitte Bigi and Stéphane Rauzy.
+
+- LINAGORA: Julie Hunter, Kate Thompson and Guokan Shang (corpus conception)
+
+Corpus participants:
+- Participants for the in-person conversations were recruited on the University of Aix-Marseille campus.
+- Participants for the Zoom meetings were recruited through [Prolific](https://www.prolific.com/).
+
+### Annotations
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+Transcripts are not punctuated and all words are in lower case.
+
+Annotations follow the conventions laid out in chapter 3 of [The SPPAS Book](https://sppas.org/book_03_annotations.html) by Brigitte Bigi. Transcripts may therefore contain additional annotations in the following contexts:
+
+* truncated words, noted as a - at the end of the token string (an ex- example);
+* noises, noted by a * (not available for some languages);
+* laughter, noted by a @ (not available for some languages);
+* short pauses, noted by a +;
+* elisions, mentioned in parentheses;
+* specific pronunciations, noted with brackets [example,eczap];
+* comments are preferably noted inside braces {this is a comment!};
+* comments can be noted inside brackets without using comma [this and this];
+* liaisons, noted between = (this =n= example);
+* morphological variants with <ice scream,I scream>,
+* proper name annotation, like $ John S. Doe $.
+
+Note that the symbols * + @ must be surrounded by whitespace.
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+Principal annotator for `dev`: Océane Granier 
+
+Principal annotators for `test`: [More Information Needed]
+
+Additional assistance from: Laurent Prévot, Hiroyoshi Yamasaki and Roxane Bertrand
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+A portion of the `dev`split has been (semi-automatically) anonymized for the pipeline described in Yamasaki et al. (2023).
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+
+
+## Citations
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+Please cite the papers below if using the dataset in your work.
+
+**Description of the full dataset:**
+
+Julie Hunter, Hiroyoshi Yamasaki, Océane Granier, Jérôme Louradour, Roxane Bertrand, Kate Thompson and Laurent Prévot (2024): "[SUMM-RE: A corpus of French meeting-style conversations](https://hal.science/hal-04623038/)," TALN 2024.
+
+```bibtex
+@inproceedings{hunter2024summre,
+  title={SUMM-RE: A corpus of French meeting-style conversations},
+  author={Hunter, Julie and Yamasaki, Hiroyoshi and Granier, Oc{\'e}ane and Louradour, J{\'e}r{\^o}me and Bertrand, Roxane and Thompson, Kate and Pr{\'e}vot, Laurent},
+  booktitle={Actes de JEP-TALN-RECITAL 2024. 31{\`e}me Conf{\'e}rence sur le Traitement Automatique des Langues Naturelles, volume 1: articles longs et prises de position},
+  pages={508--529},
+  year={2024},
+  organization={ATALA \& AFPC}
+}
+```
+
+**The Whisper Pipeline:**
+
+Hiroyoshi Yamasaki, Jérôme Louradour, Julie Hunter and Laurent Prévot (2023): "[Transcribing and aligning conversational speech: A hybrid pipeline applied to French conversations](https://hal.science/hal-04404777/document)," Workshop on Automatic Speech Recognition and Understanding (ASRU).
+
+```bibtex
+@inproceedings{yamasaki2023transcribing,
+  title={Transcribing And Aligning Conversational Speech: A Hybrid Pipeline Applied To French Conversations},
+  author={Yamasaki, Hiroyoshi and Louradour, J{\'e}r{\^o}me and Hunter, Julie and Pr{\'e}vot, Laurent},
+  booktitle={2023 IEEE Automatic Speech Recognition and Understanding Workshop (ASRU)},
+  pages={1--6},
+  year={2023},
+  organization={IEEE}
+}
+  ```
+<sup>*</sup>The following meetings were used to evaluate the pipeline in Yamasaki et al. (2023):
+
+```python
+asru = ['018a_EARZ_055', '018a_EARZ_056', '018a_EARZ_057', '018a_EARZ_058', '020b_EBDZ_017', '020b_EBDZ_053', '020b_EBDZ_057', '020b_EBDZ_063', '027a_EBRH_025', '027a_EBRH_075', '027a_EBRH_078', '032b_EADH_084', '032b_EADH_085', '032b_EADH_086', '032b_EADH_087', '033a_EBRH_091', '033a_EBRH_092', '033a_EBRH_093', '033a_EBRH_094', '033c_EBPH_091', '033c_EBPH_092', '033c_EBPH_093', '033c_EBPH_094', '034a_EBRH_095', '034a_EBRH_096', '034a_EBRH_097', '034a_EBRH_098', '035b_EADH_088', '035b_EADH_096', '035b_EADH_097', '035b_EADH_098', '036c_EAPH_091', '036c_EAPH_092', '036c_EAPH_093', '036c_EAPH_099', '069c_EEPL_156', '069c_EEPL_157', '069c_EEPL_158', '069c_EEPL_159']
+```
+
+## Acknowledgements
+
+We gratefully acknowledge support from the Agence Nationale de Recherche for the SUMM-RE project (ANR-20-CE23-0017).