Update README.md

README.md

@@ -74,7 +74,7 @@ tags:
 - speaker-segmentation
 ---
 
-## Dataset Description
+# Dataset Card for the AMI dataset for speaker diarization
 
 The AMI Meeting Corpus consists of 100 hours of meeting recordings. The recordings use a range of signals
 synchronized to a common timeline. These include close-talking and far-field microphones, individual and
@@ -84,5 +84,78 @@ were recorded in English using three different rooms with different acoustic pro
 non-native speakers.
 
 **Note**: This dataset has been preprocessed using [diarizers](https://github.com/kamilakesbi/diarizers/tree/main/datasets). 
-It makes the dataset compatible with `diarizers` scripts to fine-tune `pyannote` segmentation models. 
+It makes the dataset compatible with the `diarizers` repository scripts to fine-tune `pyannote` segmentation models. 
+
+
+## Motivation
+
+
+
+
+
+### Example Usage
+
+
+```python
+from datasets import load_dataset
+ds = load_dataset("diarizers-community/ami", "ihm")
+
+print(ds)
+```
+gives:
+```
+DatasetDict({
+    train: Dataset({
+        features: ['audio', 'timestamps_start', 'timestamps_end', 'speakers'],
+        num_rows: 136
+    })
+    validation: Dataset({
+        features: ['audio', 'timestamps_start', 'timestamps_end', 'speakers'],
+        num_rows: 18
+    })
+    test: Dataset({
+        features: ['audio', 'timestamps_start', 'timestamps_end', 'speakers'],
+        num_rows: 16
+    })
+})
+```
+
+### Dataset Description
+
+- **License:** CC BY 4.0
+
+
+## Dataset source
+
+- **Homepage:** https://groups.inf.ed.ac.uk/ami/corpus/
+- **Repository:** https://github.com/kamilakesbi/diarizers/tree/main/datasets
+- **Paper:** 
+- **Leaderboard:** 
+- **Point of Contact:** [[email protected]](mailto:[email protected])
+
+## Citation
+
+```
+@misc{akesbi-diarizers,
+  author = {Kamil Akesbi and Sanchit Gandhi},
+  title = {"Diarizers: A repository for fine-tuning speaker diarization models"},
+  year = {2024},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/huggingface/diarizers}}
+}
+```
+
+```
+@article{article,
+author = {Mccowan, Iain and Carletta, J and Kraaij, Wessel and Ashby, Simone and Bourban, S and Flynn, M and Guillemot, M and Hain, Thomas and Kadlec, J and Karaiskos, V and Kronenthal, M and Lathoud, Guillaume and Lincoln, Mike and Lisowska Masson, Agnes and Post, Wilfried and Reidsma, Dennis and Wellner, P},
+year = {2005},
+month = {01},
+pages = {},
+title = {The AMI meeting corpus},
+journal = {Int'l. Conf. on Methods and Techniques in Behavioral Research}
+}
+```
+
+