add script and readme

README.md

@@ -1,3 +1,189 @@
 ---
-license: cc
+annotations_creators:
+- no-annotation
+language:
+- eu
+language_creators:
+- found
+license:
+- cc
+multilinguality:
+- monolingual
+pretty_name: EusCrawl
+size_categories:
+- 10M<n<100M
+source_datasets:
+- original
+tags:
+- high-quality
+- scraping
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
+- masked-language-modeling
+dataset_info:
+  features:
+  - name: id
+    dtype: int32
+  - name: title
+    dtype: string
+  - name: text
+    dtype: string
+  - name: source
+    dtype: string
+  - name: license
+    dtype: string
+  - name: url
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 2314407002
+    num_examples: 1724544
+  download_size: 728281801
+  dataset_size: 2314407002
 ---
+
+# Dataset Card for EusCrawl
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** https://ixa.ehu.eus/euscrawl/
+- **Repository:** 
+- **Paper:** https://arxiv.org/abs/2203.08111
+- **Leaderboard:**
+- **Point of Contact:** [email protected]
+
+### Dataset Summary
+
+EusCrawl (http://www.ixa.eus/euscrawl/) is a high-quality corpus for
+Basque comprising 12.5 million documents and 423 million tokens,
+totalling 2.1 GiB of uncompressed text. EusCrawl was built using
+ad-hoc scrapers to extract text from 33 Basque websites with
+high-quality content, resulting in cleaner text compared to general
+purpose approaches.
+
+### Supported Tasks and Leaderboards
+
+EusCrawlis intended for pretarining models for language modeling or masked language modeling.
+
+### Languages
+
+Basque (eu)
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+We do not claim ownership of any document in the corpus. All documents
+we collected were published under a Creative Commons license in their
+original website, and the specific variant can be found in the
+"license" field of each document. Should you consider
+that our data contains material that is owned by you and you would not
+like to be reproduced here, please contact Aitor Soroa at
+[email protected].
+
+### Citation Information
+
+If you use our corpus or models for academic research, please cite the paper in question:
+@misc{artetxe2022euscrawl,
+    title={Does corpus quality really matter for low-resource languages?},
+    author={Mikel Artetxe, Itziar Aldabe, Rodrigo Agerri,
+    Olatz Perez-de-Viñaspre, Aitor Soroa},
+    year={2022},
+    eprint={2203.08111},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+
+### Contributions
+
+Thanks to [@juletx](https://github.com/juletx) for adding this dataset.

euscrawl.py

@@ -0,0 +1,99 @@
+"""EusCrawl dataset."""
+
+import json
+import datasets
+
+
+_DESCRIPTION = """\
+EusCrawl (http://www.ixa.eus/euscrawl/) is a high-quality corpus for
+Basque comprising 12.5 million documents and 423 million tokens,
+totalling 2.1 GiB of uncompressed text. EusCrawl was built using
+ad-hoc scrapers to extract text from 33 Basque websites with
+high-quality content, resulting in cleaner text compared to general
+purpose approaches.
+
+We do not claim ownership of any document in the corpus. All documents
+we collected were published under a Creative Commons license in their
+original website, and the specific variant can be found in the
+"license" field of each document. Should you consider
+that our data contains material that is owned by you and you would not
+like to be reproduced here, please contact Aitor Soroa at
+[email protected].
+
+For more details about the corpus, refer to our paper "Artetxe M.,
+Aldabe I., Agerri R., Perez-de-Viñaspre O, Soroa A. (2022). Does
+Corpus Quality Really Matter for Low-Resource Languages?"
+https://arxiv.org/abs/2203.08111
+
+If you use our corpus or models for academic research, please cite the paper in question:
+@misc{artetxe2022euscrawl,
+      title={Does corpus quality really matter for low-resource languages?},
+      author={Mikel Artetxe, Itziar Aldabe, Rodrigo Agerri, Olatz Perez-de-Viñaspre, Aitor Soroa},
+      year={2022},
+      eprint={2203.08111},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+
+For questions please contact Aitor Soroa at [email protected].
+"""
+_HOMEPAGE_URL = "https://ixa.ehu.eus/euscrawl/"
+_CITATION = """\
+@misc{artetxe2022euscrawl,
+    title={Does corpus quality really matter for low-resource languages?},
+    author={Mikel Artetxe, Itziar Aldabe, Rodrigo Agerri,
+    Olatz Perez-de-Viñaspre, Aitor Soroa},
+    year={2022},
+    eprint={2203.08111},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+"""
+
+_URL = "http://ixa.ehu.eus/euscrawl/files/euscrawl-v1-free-jsonl.tar.bz2"
+_FILEPATH = "euscrawl-v1-free-jsonl/euscrawl-v1.free.jsonl"
+
+
+class EusCrawl(datasets.GeneratorBasedBuilder):
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("int32"),
+                    "title": datasets.Value("string"),
+                    "text": datasets.Value("string"),
+                    "source": datasets.Value("string"),
+                    "license": datasets.Value("string"),
+                    "url": datasets.Value("string"),
+                },
+            ),
+            supervised_keys=None,
+            homepage=_HOMEPAGE_URL,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        path = dl_manager.download_and_extract(_URL)
+        filepath = f"{path}/{_FILEPATH}"
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={"filepath": filepath},
+            )
+        ]
+
+    def _generate_examples(self, filepath):
+        with open(filepath, encoding="utf-8") as f:
+            for id, line in enumerate(f):
+                data = json.loads(line)
+
+                # defaut to empty string if field is missing
+                yield id, {
+                    "id": id,
+                    "title": data.get("title", ""),
+                    "text": data.get("text", ""),
+                    "source": data.get("source", ""),
+                    "license": data.get("license", ""),
+                    "url": data.get("url", ""),
+                }