first version of the README

README.md

@@ -1,3 +1,309 @@
 ---
 license: cc-by-4.0
+task_categories:
+- image-to-text
+version: "1.0.0"
+language:
+- fr
+- de
+- en
+- it
+- es
+- oc
+- la
+pretty_name: Mc CATMuS
+size_categories:
+- 100K<n<1M
+tags:
+- optical-character-recognition
+- humanities
+- handwritten-text-recognition
 ---
+
+
+<!-- Preparing description card for Hugging Face -->
+
+
+<!-- make banner -->
+
+
+# Dataset Card for CATMuS Modern and Contemporary (McCATMuS)
+
+Join our Discord to ask questions about this dataset:
+
+Join our Discord to ask questions about the dataset: [![Join the Discord](https://img.shields.io/badge/CATMuS-Discord?style=flat-square&logo=discord&logoColor=%23333333&color=%235865F2)](https://discord.gg/J38xgNEsGk)
+
+## Dataset Details
+
+Handwritten Text Recognition (HTR) has emerged as a crucial tool for converting manuscripts images into machine-readable formats, enabling researchers and scholars to analyze vast collections efficiently. Despite significant technological progress, establishing consistent ground truth across projects for HTR tasks, particularly for complex and heterogeneous historical sources, remains nonetheless challenging.  
+
+We introduce the Consistent Approaches to Transcribing Manuscripts (CATMuS) dataset for **m**odern and **c**ontemporary manuscripts (McCATMuS), which offers:
+
+- a uniform framework framework for annotating modern and contemporary manuscripts;
+- a benchmarking environment for evaluating automatic text recognition models across multiple dimensions, enriched with metadata such as century, language, and writing technique;
+- a benchmarking environment for additional tasks like script classification and dating approaches;
+- a benchmarking environment for exploratory work in computer vision and digital paleography, particularly for line-based tasks including generative approaches.
+
+Built upon datasets from institutions and projects committed to Open Science, McCATMuS provides an interoperable dataset encompassing over 170 manuscripts in 8 different languages. It includes more than 115,000 lines of text and nearly 4 million characters, covering a period from the early 16th century to the present day.
+
+<!--rephrase: 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:** Alix Chagué
+- **Funded by:** <!--BnF Datalab, Biblissima +, DIM PAMIR-->
+- **Language(s) (NLP):** French and Middle French, Spanish, Italian, English, Latin, German, Occitan
+- **License:** CC-BY
+
+#### Train
+
+| Writing Type | Total Count (lines) | Languages and Counts (lines) |
+| :----------- | :------------------ | :--------------------------- |
+| Handwritten | 68243 | French: 63197, Spanish: 2845, German: 1744, English: 229, Italian: 228 |
+| Printed | 34069 | French: 29929, Middle French: 1885, Latin: 1507, Occitan: 249, Italian: 231, German: 154, English: 57, Spanish: 57 |
+| Typewritten | 42 | English: 42 |
+
+#### Validation
+
+| Writing Type | Total Count (lines) | Languages and Counts (lines) |
+| :----------- | :------------------ | :--------------------------- |
+| Handwritten | 6057 | French: 5492, Spanish: 203, English: 186, German: 152, Italian: 24 |
+| Printed | 2917 | French: 2557, Middle French: 186, Latin: 105, English: 29, Occitan: 20, Italian: 11, Spanish: 5, German: 4 |
+| Typewritten | 111 | English: 111 |
+
+#### Test
+
+| Writing Type | Total Count (lines) | Languages and Counts (lines) |
+| :----------- | :------------------ | :--------------------------- |
+| Handwritten | 3421 | French: 3235, Spanish: 117, German: 46, English: 17, Italian: 6 |
+| Printed | 1262 | French: 1041, Latin: 142, Middle French: 32, Italian: 16, German: 15, Occitan: 13, Spanish: 3 |
+| Typewritten | 181 | English: 181 |
+
+
+
+
+
+<!--
+### Dataset Sources [optional]
+
+ Provide the basic links for the dataset.
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+ -->
+
+## Uses
+
+### Direct Use
+
+- Handwritten Text Recognition
+- Date classification
+- Script classification
+
+### Out-of-Scope Use
+
+- Text-To-Image
+
+## Dataset Structure
+
+- Data contains the main `split` that is loaded through `load_dataset("CATMuS/modern")`
+- Data can be split with each manuscript inside train, val and test using the `gen_split` columns which roughly results in a 90/5/5 split
+- The image is in the `im` column, and the text in the `text` column
+- Each text line is dated with the combination of `not_before` and `not_after`, the precision of the dating can very greatly depending on the available metadata
+- Each text line is associated to a `genre`, a `writing_type` (printed, handwritten or typewritten), a `region_type` and a `line_type` following SegmOnto's vocabulary, a `shelfmark` identifying the documents from which the text line is extracted, and a `project` identifying the project having produced the original dataset.
+- When `shelfmark` contains "nobs", it means that the documents are not associated to any known shelfmark.
+
+
+### Annotations [optional]
+
+#### Annotation process
+
+TBD
+<!-- include link to CATMuS modern guidelines when they are online -->
+
+<!--The annotation process is described in the [dataset paper](https://inria.hal.science/hal-04453952).-->
+<!-- add a reference when we'll have a paper similar to CATMuS Medieval -->
+
+
+#### Who are the annotators?
+
+This list includes all the annotators identified by the producer of the datasets gathered in McCATMuS dataset.
+
+- Chagué, Alix
+- Clérice, Thibault
+- Gabay, Simon
+- Pinche, Ariane
+- Albert, Anaïs
+- Bey, Laura
+- Carrow, Jennifer
+- Champougny, Kevin
+- Charbonnier, Pauline
+- Chiaretti, Alessandro
+- Christensen, Kelly
+- Cicchini, Marco
+- Claire Jahan
+- Clavaud, Florence
+- Davoury, Baudoin
+- de Champs, Emmanuelle
+- Dechavanne, Sylvie
+- Denis, Nathalie
+- Doat, Soline
+- Dubourg Glatigny, Pascal
+- Durand, Marc
+- Elsa, Falcoz
+- Fabert, Eliott
+- Faure, Margaux
+- Genero, Jean-Damien
+- Guimarães, Ingrid
+- Humeau, Maxime
+- Jacsont, Pauline
+- Jaureguy, Yvan
+- Le Fourner, Victoria
+- Limon-Bonnet, Marie-Françoise
+- Martini, Manuela
+- Maurel, Perrine
+- Mazoue, Anais
+- Meissel, Nina
+- Mikhalchuk, Anna
+- Nahon, Peter
+- Norindr, Jade
+- Nougaret, Christine
+- Ozturk, Yagmur
+- Paupe, Elodie
+- Pérez, Gilles
+- Rebetez, Jean-Claude
+- Riondet, Charles
+- Rostaing, Aurélia
+- Simon Gabay
+- Skilbeck-Gaborit, Eden
+- Van Kote, Elsa
+- Vanneau, Laurie
+- Vlachou-Efstathiou, Malamatenia
+- Weddigen, Tristan
+- Wojszvzyk, Elise
+- ALemoine
+- ASJPeronneau
+- Alcofrybas
+- BeaLct
+- CLbt
+- Chloelsa
+- DMichel
+- Desauthieux
+- EPerrin
+- EdChamps
+- GBMireille
+- GPINET
+- Genea78
+- JMGoux
+- Jideuxhemme
+- LBIsabelle
+- Lamotte
+- MFGarreau
+- MIna
+- Maniet
+- MarionJo
+- PGambette
+- PPocard
+- PROMBAUT
+- PaulineTest
+- SCayeux
+- SL.
+- SLespinasse
+- Silver08
+- TPellé
+- Valérie
+- alp
+- jmorvan
+- lelia
+- majubama
+- mickael.lefevr
+- sgauthier
+
+<!--
+- 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
+
+The data is skewed toward French which is overly represented in the current version of the dataset.
+
+No language is represented over all centuries and all writing type, but French has the better coverage for handwritten text lines.
+
+Only one document is available in Spanish. Occitan is only represented in printed lines.
+
+## Citation
+
+TBD 
+<!--- below is the README from CATMuS Medieval --->
+<!--
+**BibTeX:**
+
+```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 Pinche, Ariane and Vlachou-Efstathiou, Malamatenia and Chagu{\'e}, Alix and Camps, Jean-Baptiste and Gille-Levenson, Matthias and Brisville-Fertin, Olivier and Fischer, Franz and Gervers, Michaels and Boutreux, Agn{\`e}s and Manton, Avery and Gabay, Simon and O'Connor, Patricia and Haverals, Wouter and Kestemont, Mike and Vandyck, Caroline and Kiessling, Benjamin},
+  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:**
+
+> Thibault Clérice, Ariane Pinche, Malamatenia Vlachou-Efstathiou, Alix Chagué, Jean-Baptiste Camps, et al.. CATMuS Medieval: A multilingual large-scale cross-century dataset in Latin script for handwritten text recognition and beyond. 2024. ⟨hal-04453952⟩
+-->
+
+## Dataset Card Contact
+
+Alix Chagué ([email protected])