corpus-carolina / README.md
guilhermelmello's picture
Fix: usage example
34c17a8
|
raw
history blame
5.38 kB
---
pretty_name: Carolina
annotations_creators:
- no-annotation
language_creators:
- crowdsourced
languages:
- pt-BR
licenses:
- cc-by-nc-sa-4.0
multilinguality:
- monolingual
size_categories:
- 1B<n<10B
source_datasets:
- original
task_categories:
- sequence-modeling
task_ids:
- language-modeling
---
# Dataset Card for Corpus Carolina
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Dataset Description](#dataset-description)
- [Dataset Summary](#dataset-summary)
- [Supported Tasks](#supported-tasks)
- [Languages](#languages)
- [Dataset Structure](#dataset-structure)
- [Data Instances](#data-instances)
- [Data Fields](#data-fields)
- [Data Splits](#data-splits)
- [Additional Information](#additional-information)
- [Dataset Curators](#dataset-curators)
- [Licensing Information](#licensing-information)
- [Citation Information](#citation-information)
## Dataset Description
- **Homepage:** [sites.usp.br/corpuscarolina](https://sites.usp.br/corpuscarolina/)
- **Current Version:** 1.1 (Ada)
- **Point of Contact:** [Guilherme L. Mello](mailto:guilhermelmello@ime.usp.br)
### Dataset Summary
Carolina is an Open Corpus for Linguistics and Artificial Intelligence with a
robust volume of texts of varied typology in contemporary Brazilian Portuguese
(1970-2021). This corpus contains documents and texts extracted from the web
and includes information (metadata) about its provenance and tipology.
The documents are clustered into taxonomies and the corpus can be loaded in complete or taxonomy modes. To load a single taxonomy, it is possible to pass a code as a parameter to the loading script (see the example bellow). Codes are 3-letters string and possible values are:
- `dat` : datasets and other corpora;
- `jud` : judicial branch;
- `leg` : legislative branch;
- `pub` : public domain works;
- `soc` : social media;
- `uni` : university domains;
- `wik` : wikis.
Usage Example:
```python
from datasets import load_dataset
# to load all taxonomies
corpus_carolina = load_dataset("carolina-c4ai/corpus-carolina")
# to load social media documents
social_media = load_dataset("carolina-c4ai/corpus-carolina", taxonomy="soc")
```
### Supported Tasks
Carolina corpus was compiled for academic purposes,
namely linguistic and computational analysis.
### Languages
Contemporary Brazilian Portuguese (1970-2021).
## Dataset Structure
Files are stored inside `corpus` folder with a subfolder
for each taxonomy. Every file folows a XML structure
(TEI P5) and contains multiple extracted documents. For
each document, the text and metadata are exposed as
`text` and `meta` features, respectively.
### Data Instances
Every instance have the following structure.
```
{
"meta": datasets.Value("string"),
"text": datasets.Value("string")
}
```
| Code | Taxonomy | Instances | Size |
|:----:|:---------------------------|----------:|-------:|
| | **Total** | 1745187 | 7.3 GB |
| dat | Datasets and other Corpora | 1098717 | 3.3 GB |
| wik | Wikis | 603968 | 2.6 GB |
| jud | Judicial Branch | 38068 | 1.4 GB |
| leg | Legislative Branch | 14 | 20 MB |
| soc | Social Media | 3449 | 15 MB |
| uni | University Domains | 945 | 9.4 MB |
| pub | Public Domain Works | 26 | 3.6 MB |
||
### Data Fields
- `meta`: a XML string with a TEI conformant `teiHeader` tag. It is exposed as text and needs to be parsed in order to access the actual metada;
- `text`: a string containing the extracted document.
### Data Splits
As a general corpus, Carolina does not have splits. In order to load the dataset, it is used `corpus` as its single split.
## Additional Information
### Dataset Curators
The Corpus Carolina is developed by a multidisciplinary
team of linguists and computer scientists, members of the
Virtual Laboratory of Digital Humanities - LaViHD and the Artificial Intelligence Center of the University of São Paulo - C4AI.
### Licensing Information
The Open Corpus for Linguistics and Artificial Intelligence (Carolina) was
compiled for academic purposes, namely linguistic and computational analysis.
It is composed of texts assembled in various digital repositories, whose
licenses are multiple and therefore should be observed when making use of the
corpus. The Carolina headers are licensed under Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International."
### Citation Information
```
@misc{corpusCarolinaV1.1,
title={
Carolina:
The Open Corpus for Linguistics and Artificial Intelligence
},
author={
Finger, Marcelo and
Paixão de Sousa, Maria Clara and
Namiuti, Cristiane and
Martins do Monte, Vanessa and
Costa, Aline Silva and
Serras, Felipe Ribas and
Sturzeneker, Mariana Lourenço and
Guets, Raquel de Paula and
Mesquita, Renata Morais and
Mello, Guilherme Lamartine de and
Crespo, Maria Clara Ramos Morales and
Rocha, Maria Lina de Souza Jeannine and
Brasil, Patrícia and
Silva, Mariana Marques da and
Palma, Mayara Feliciano
},
howpublished={\url{
https://sites.usp.br/corpuscarolina/corpus}},
year={2022},
note={Version 1.1 (Ada)},
}
```