Update README.md

README.md

@@ -12,141 +12,183 @@ language:
 pretty_name: CATMuS Medieval
 size_categories:
 - 100K<n<1M
+tags:
+- optical-character-recognition
+- humanities
+- handwritten-text-recognition
 ---
-# Dataset Card for Dataset Name
+# Dataset Card for CATMuS Medieval
 
-<!-- Provide a quick summary of the dataset. -->
+## Dataset Details
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+Handwritten Text Recognition (HTR) has emerged as a crucial tool for converting manuscripts images into machine-readable formats, 
+enabling researchers and scholars to analyse vast collections efficiently. 
+Despite significant technological progress, establishing consistent ground truth across projects for HTR tasks, 
+particularly for complex and heterogeneous historical sources like medieval manuscripts in Latin scripts (8th-15th century CE), remains nonetheless challenging. 
+We introduce the **Consistent Approaches to Transcribing Manuscripts (CATMuS)** dataset for medieval manuscripts, 
+which offers:
+1. a uniform framework for annotation practices for medieval manuscripts,
+2. a benchmarking environment for evaluating automatic text recognition models across multiple dimensions thanks to rich metadata (century of production, 
+language, genre, script, etc.),
+3. a benchmarking environment for other tasks (such as script classification or dating approaches),
+4. a benchmarking environment  and finally for exploratory work pertaining to computer vision and digital paleography around line-based tasks, such as generative approaches.
 
-## Dataset Details
+Developed through collaboration among various institutions and projects, CATMuS provides an inter-compatible dataset spanning more than 200 manuscripts and incunabula in 10 
+different languages, comprising over 160,000 lines of text and 5 million characters spanning from the 8th century to the 16th.
+
+The dataset's consistency in transcription approaches aims to mitigate challenges arising from the diversity in standards for medieval manuscript transcriptions, 
+providing a comprehensive benchmark for evaluating HTR models on historical sources. 
 
 ### Dataset Description
 
 <!-- Provide a longer summary of what this dataset is. -->
 
+- **Curated by:** Thibault Clérice
+- **Funded by:** BnF Datalab, Biblissima +, DIM PAMIR
+- **Language(s) (NLP):** Middle and Old French, Middle Dutch, Catalan, Spanish, Navarese, Italian, Venitian, Old English, Latin
+- **License:** CC-BY
 
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
+<!--
 ### Dataset Sources [optional]
 
-<!-- Provide the basic links for the dataset. -->
+ Provide the basic links for the dataset.
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
+ -->
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
-
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+- Handwritten Text Recognition
+- Data classification
+- Script classification
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+- Text-To-Image
 
 ## 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. -->
-
-[More Information Needed]
+- Data contains the main `split` that is loaded through `load_dataset("CATMuS/medieval")`
+- Data can be split with each manuscript inside train, val and test using the `gen_split` columns which results in a 90/5/5 split
+- The image is in the `im` column, and the text in the `text` column
 
+<!--
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
+ Motivation for the creation of this dataset.
 
 [More Information Needed]
 
 ### Source Data
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+ This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). 
 
 #### 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. -->
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc.
 
 [More Information Needed]
 
 #### 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. -->
+<!-- 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. 
 
 [More Information Needed]
+ -->
 
 ### Annotations [optional]
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
 #### 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]
+The annotation process is described in the [dataset paper](https://inria.hal.science/hal-04453952).
 
 #### Who are the annotators?
 
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### 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. -->
-
-[More Information Needed]
+- Pinche, Ariane
+- Clérice, Thibault
+- Chagué, Alix
+- Camps, Jean-Baptiste
+- Vlachou-Efstathiou, Malamatenia
+- Gille Levenson, Matthias
+- Brisville-Fertin, Olivier
+- Boschetti, Federico
+- Fischer, Franz
+- Gervers, Michael
+- Boutreux, Agnès
+- Manton, Avery
+- Gabay, Simon
+- Bordier, Julie
+- Glaise, Anthony
+- Alba, Rachele
+- Rubin, Giorgia
+- White, Nick
+- Karaisl, Antonia
+- Leroy, Noé
+- Maulu, Marco
+- Biay, Sébastien
+- Cappe, Zoé
+- Konstantinova, Kristina
+- Boby, Victor
+- Christensen, Kelly
+- Pierreville, Corinne
+- Aruta, Davide
+- Lenzi, Martina
+- Le Huëron, Armelle
+- Possamaï, Marylène
+- Duval, Frédéric
+- Mariotti, Violetta
+- Morreale, Laura
+- Nolibois, Alice
+- Foehr-Janssens, Yasmina
+- Deleville, Prunelle
+- Carnaille, Camille
+- Lecomte, Sophie
+- Meylan, Aminoel
+- Ventura, Simone
+- Dugaz, Lucien
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The data are skewed toward Old French, Middle Dutch and Spanish, specifically from the 14th century.
 
-### Recommendations
+The only language that is represented over all centuries is Latin, and in each scripts. The other language with a coverage close to Latin is Old French.
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+Only one document is available in Old English.
 
 ## Citation [optional]
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
 **BibTeX:**
 
-[More Information Needed]
+```tex
+@unpublished{clerice:hal-04453952,
+  TITLE = {{CATMuS Medieval: A multilingual large-scale cross-century dataset in Latin script for handwritten text recognition and beyond}},
+  AUTHOR = {Cl{\'e}rice, Thibault and Ariane, Pinche and Malamatenia, Vlachou-Efstathiou and Alix, Chagu{\'e} and Jean-Baptiste, Camps and Matthias, Gille-Levenson and Olivier, Brisville-Fertin and Franz, Fischer and Michaels, Gervers and Agn{\`e}s, Boutreux and Avery, Manton and Simon, Gabay and Patricia, O'Connor and Wouter, Haverals and Mike, Kestemont and Caroline, Vandyck and Benjamin, Kiessling},
+  URL = {https://inria.hal.science/hal-04453952},
+  NOTE = {working paper or preprint},
+  YEAR = {2024},
+  MONTH = Feb,
+  KEYWORDS = {Historical sources ; medieval manuscripts ; Latin scripts ; benchmarking dataset ; multilingual ; handwritten text recognition},
+  PDF = {https://inria.hal.science/hal-04453952/file/ICDAR24___CATMUS_Medieval-1.pdf},
+  HAL_ID = {hal-04453952},
+  HAL_VERSION = {v1},
+}
+```
 
 **APA:**
 
-[More Information Needed]
+> Thibault Clérice, Pinche Ariane, Vlachou-Efstathiou Malamatenia, Chagué Alix, Camps Jean-Baptiste, et al.. CATMuS Medieval: A multilingual large-scale cross-century dataset in Latin script for handwritten text recognition and beyond. 2024. ⟨hal-04453952⟩
 
 ## Glossary [optional]
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
+- Scripts: In the middle ages, the writing style changed over time, specifically in "litterary" manuscripts, for which we call the general scripts "Bookscripts". This is what CATMuS Medieval covers at the time
 
 ## Dataset Card Contact
 
-[More Information Needed]
+Thibault Clérice ([email protected])