diff --git a/README.md b/README.md index e500bbb709545f14aca13f52a7c9cf1cdf911c44..e3aba61682be4e537023eb003573ef2287cc7ad4 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,19 @@ language: - es - oc - la -pretty_name: Mc CATMuS +pretty_name: CATMuS modern (or McCATMuS) size_categories: - 100K - - - - +![CATMuS Modern Banner](banner_catmus_modern.png) # Dataset Card for CATMuS Modern and Contemporary (McCATMuS) @@ -42,58 +40,46 @@ We introduce the Consistent Approaches to Transcribing Manuscripts (CATMuS) data - 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. +Built upon datasets from institutions and projects committed to Open Science, McCATMuS provides an interoperable dataset encompassing over 180 manuscripts in 8 different languages. It includes more than 118,000 lines of text and nearly 4 million characters, covering a period from the early 16th century to the present day. + +All the datasets were automatically or, when precised, manually corrected to correspond to the CATMuS guidelines, available here: https://catmus-guidelines.github.io/ ### Dataset Description - - **Curated by:** Alix Chagué - **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 | +- **License:** CC-BY 4.0 -#### Validation +### Train -| 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 | +| Writing Type | Total Count | Languages and Counts | +|--------------|-------------|----------------------| +| Handwritten | 71296 | French: 65844, Spanish: 2864, German: 1940, English: 390, Italian: 258 | +| Printed | 34684 | French: 30376, Middle French: 1873, Latin: 1592, Italian: 266, Occitan: 258, German: 174, English: 85, Spanish: 60 | +| Typewritten | 298 | English: 298 | -#### Test +### Validation -| 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 | +| Writing Type | Total Count | Languages and Counts | +|--------------|-------------|----------------------| +| Handwritten | 3833 | French: 3662, Spanish: 149, English: 21, German: 1 | +| Printed | 1825 | French: 1608, Middle French: 115, Latin: 82, Occitan: 12, Spanish: 4, English: 3, German: 1 | +| Typewritten | 18 | English: 18 | +### Test +| Writing Type | Total Count | Languages and Counts | +|--------------|-------------|----------------------| +| Handwritten | 3898 | French: 3724, Spanish: 152, English: 21, German: 1 | +| Printed | 1760 | French: 1546, Middle French: 115, Latin: 82, Occitan: 12, English: 3, Spanish: 1, German: 1 | +| Typewritten | 18 | English: 18 | - - - ## Uses ### Direct Use @@ -108,28 +94,36 @@ providing a comprehensive benchmark for evaluating HTR models on historical sour ## 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 +- Data contains the main `split` that can be loaded through `load_dataset("CATMuS/modern")` +- Data can also be split with each manuscript represented in 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. +- When `shelfmark` contains "nobs", it means that the documents are not associated to any known shelfmark, the shelfmark in these cells was thus created for the purpose of this metadataset. + +## Annotations +### Annotation process -### Annotations [optional] +The annotations in this dataset result: -#### Annotation process +- for layout extraction, line extraction, typing and transcription, from the original creators of the dataset in most cases, or from automatic or manual corrections by the curator of the CATMuS modern dataset, +- for the rest of the metadata, from automatic or manual collection of the metadata by the curator of the CATMuS modern dataset. -TBD - +The metadata where set generally set at document level. - - +The values in`region_type` and `line_type` are, as much as possible, conformant with the [SegmOnto vocabulary](https://segmonto.github.io/). +The values in `writing_type` and `genre` follow a vocabulary set for this dataset: -#### Who are the annotators? +- possible values in `writing_type` are: `handwritten`, `printed` or `typewritten`. +- possible values in `genre` are: `document of practice`, `drama`, `narratives`, `epistolary`, `treaties`, `poetry`. There can be multiple values, in which case they are separated by semi-colons. -This list includes all the annotators identified by the producer of the datasets gathered in McCATMuS dataset. +The detail of the annotation rules applied for the transcription of the text can be found at [https://catmus-guidelines.github.io/](https://catmus-guidelines.github.io/). + +### Who are the annotators? + +This list includes all the annotators identified by the producers of the datasets gathered in McCATMuS dataset. - Chagué, Alix - Clérice, Thibault @@ -176,7 +170,6 @@ This list includes all the annotators identified by the producer of the datasets - Rebetez, Jean-Claude - Riondet, Charles - Rostaing, Aurélia -- Simon Gabay - Skilbeck-Gaborit, Eden - Van Kote, Elsa - Vanneau, Laurie @@ -221,51 +214,36 @@ This list includes all the annotators identified by the producer of the datasets - mickael.lefevr - sgauthier - - +### Software + +The software used to generate this version of the dataset was built by Thibault Clérice and Alix Chagué. + +### Reused datasets + +All the datasets reused to create the CATMuS Modern and Contemporary dataset are listed below along with the version we used. They can also be found in the [Zotero group](https://www.zotero.org/groups/5601331/catmus_modern__contemporary) dedicated to this metadataset. + +- Chagué, A. (2023). *Moonshines* (v2.0.2) [Dataset]. https://github.com/alix-tz/moonshines +- Chagué, A., Champougny, K., Meissel, N., Genero, J.-D., Skilbeck-Gaborit, E., Vanneau, L., Bey, L., Le Fourner, V., Albert, A., Riondet, C., & Martini, M. (2022). *Time Us Corpus* (v0.0.3) [Dataset]. https://doi.org/10.5281/zenodo.6230755 +- Chagué, A., Clérice, T., Mazoue, A., & Van Kote, E. (2024). *CREMMA-AN-TestamentDePoilus* (v1.0.2) [Dataset]. https://doi.org/10.5281/zenodo.10177106 +- Chagué, A., Clérice, T., & Van Kote, E. (2023). *CREMMA WIKIPEDIA* (v1.0.4) [Dataset]. https://doi.org/10.5281/zenodo.10666988 +- Chagué, A., & Pérez, G. (2023). *Peraire Ground Truth* (v2.1.0) [Dataset]. https://doi.org/10.5281/zenodo.7185907 +- Clérice, T. (2021). *CREMMA Early Modern Books* (v0.0.1) [Dataset]. https://doi.org/10.5281/zenodo.5235144 +- Clérice, T., Chagué, A., Davoury, B., Doat, S., Faure, M., & Humeau, M. (2022). *CREMMA-MSS-19* (v1.0.0) [Dataset]. HTR United. https://github.com/HTR-United/CREMMA-MSS-19 +- Clérice, T., Chagué, A., Davoury, B., Faure, M., Mazoue, A., & Norindr, J. (2022). *CREMMA-MSS-17* (v1.0.0) [Dataset]. HTR United. https://github.com/HTR-United/CREMMA-MSS-17 +- Clérice, T., Chagué, A., & Doat, S. (2021). *CREMMA-MSS-20* (v1.0.0) [Dataset]. HTR United. https://github.com/HTR-United/CREMMA-MSS-20 (Original work published 2021) +- Faure, M., Norindr, J., Van Kote, E., Clérice, T., & Chagué, A. (2024). *CREMMA-MSS-18* (v0.0.1) [Dataset]. https://github.com/HTR-United/CREMMA-MSS-18 +- Gabay, S., Paupe, E., & Rebetez, J.-C. (2024). *FoNDUE-FR-MSS-17* (v1.0.0) [Dataset]. https://github.com/FoNDUE-HTR/FONDUE-FR-MSS-17 +- Gabay, S., Pinche, A., Fabert, E., & Christensen, K. (2024). *Imprimés du 18e siècle (Gallicorpora)* (v0.0.17) [Dataset]. https://github.com/Gallicorpora/HTR-imprime-17e-siecle +- Gabay, S., Pinche, A., Fabert, E., Vlachou-Efstathiou, M., Humeau, M., & Christensen, K. (2023). *Imprimés du 17e siècle (Gallicorpora)* (v0.0.46) [Dataset]. https://github.com/Gallicorpora/HTR-imprime-17e-siecle +- Guimarães, I., Maurel, P., Ozturk, Y., Chagué, A., & Clérice, T. (2022). *Memorials for Jane Lathrop Stanford* (v1.0 (corrected)) [Dataset]. https://doi.org/10.5281/zenodo.6126625 +- Humeau, M., & Chiaretti, A. (2022). *AraucaniaCorpus* [Dataset]. Araucania Project. https://github.com/Proyecto-Ocupacion-Araucania-UChile/HTR_Araucania_XIX +- Jacsont, P., Simon, G., & Weddigen, T. (2023). *FoNDUE for the Heinrich Wölfflin Fotosammlung of the Kunsthistorisches Institut UZH* (v1.0) [Dataset]. https://github.com/FoNDUE-HTR/FoNDUE_Wolfflin_Fotosammlung +- Jahan, C., & Gabay, S. (2021). *OCR17+—Layout analysis and text recognition for 17th c. French prints* (v1.0) [Dataset]. https://github.com/e-ditiones/OCR17plus +- Limon-Bonnet, M.-F., Chagué, A., & Rostaing, A. (2024). *Notaires de Paris—Bronod (Lectaurep)* (v1.0) [Dataset]. https://doi.org/10.5281/zenodo.10631356 +- Norindr, J., Clérice, T., & Chagué, A. (2023). *HTRomance—Modern* (v0.0.3) [Dataset]. https://github.com/HTRomance-Project/medieval-italian +- Rostaing, A., Denis, N., & Chagué, A. (2024). *Notaires de Paris—Mariages et Divorces (Lectaurep)* (v2.0) [Dataset]. https://doi.org/10.5281/zenodo.10632594 +- Rostaing, A., Durand, M., & Chagué, A. (2021). *Notaires de Paris—Répertoires (Lectaurep)* (v2.0.0) [Dataset]. https://doi.org/10.5072/zenodo.977691 +- Van Kote, E., Faure, M., Norindr, J., Clérice, T., & Chagué, A. (2024). *CREMMA-MSS-18* (v0.0.1) [Dataset]. https://github.com/HTR-United/CREMMA-MSS-18 ## Bias, Risks, and Limitations @@ -275,9 +253,12 @@ No language is represented over all centuries and all writing type, but French h Only one document is available in Spanish. Occitan is only represented in printed lines. +Since the metadata were set at document level, some lines may incorrectly be set to `handwritten` when they are in fact `printed`, and inversely. Further versions of the dataset will aim to reduce this phenomenon. + ## Citation -TBD +TBD +