import from S3

README.md

@@ -0,0 +1,173 @@
+---
+YAML tags:
+- copy-paste the tags obtained with the tagging app: http://34.68.228.168:8501/
+---
+
+# Dataset Card for GermanCommonCrawl
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-instances)
+  - [Data Splits](#data-instances)
+- [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)
+
+## Dataset Description
+
+- **Homepage:**
+- **Repository:** https://github.com/German-NLP-Group/german-transformer-training
+- **Paper:** 
+- **Leaderboard:**
+- **Point of Contact:** [email protected]
+
+### Dataset Summary
+
+German Only Extract from Common Crawl 
+
+Stats: 
+
+Total Size after Deduplication: 142 Mio Pages / 194 GB (Gzipped)
+Total Size before Deduplcation: 263 Mio Pages / 392 GB (Gzipped)
+
+
+### Supported Tasks and Leaderboards
+
+This Dataset is for pretraining a German Language Model (Unsupervised).  
+
+### Languages
+
+German only (Sometimes websites are partially in another Language). One can filter these out through the `language_score` attribute. 
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{'url': 'http://my-shop.ru/shop/books/545473.html', 
+'date_download': '2016-10-20T19:38:58Z',
+ 'digest': 'sha1:F62EMGYLZDIKF4UL5JZYU47KWGGUBT7T', 
+ 'length': 1155, 
+ 'nlines': 4, 
+ 'source_domain': 'my-shop.ru', 
+ 'title': 'Grammatikalische Liebeslieder. Methodische Vorschläge', 
+ 'raw_content': 'Grammatikalische Liebeslieder. [....]', 
+ 'cc_segment': 'crawl-data/CC-MAIN-2016-44/segments/1476988717783.68/wet/CC-MAIN-20161020183837-00354-ip-10-171-6-4.ec2.internal.warc.wet.gz', 
+ 'original_nlines': 99, 
+ 'original_length': 2672, 
+ 'language': 'de', 
+ 'language_score': 1.0, 
+ 'perplexity': 283.0, 
+ 'bucket': 'head'}"
+```
+
+### Data Fields
+
+
+### Data Splits
+
+Train only
+
+## Dataset Creation
+
+### Curation Rationale
+
+Handling and Filtering of Common Crawl Data requires large scale Server Ressources at a location in the US (for downloading speed). The total computing time needed to create this dataset is above 100k CPU hours. To give others the opportunity to train models with this dataset easily we make it publicly available. 
+
+In most use cases you see an improved Model Performance when extending the pre-training Data so one can achieve highest accuracies as this is probably the largest available dataset. 
+
+
+### Source Data
+
+It was filtered from the Common Crawl Snapshots of the following months: 
+
+1. 2015-48
+2. 2016-18 
+3. 2016-44
+4. 2017-33
+5. 2017-30
+6. 2017-30
+7. 2017-39 
+8. 2017-51
+9. 2018-09
+10. 2018-17
+11. 2018-30
+12. 2018-39
+13. 2018-51
+14. 2019-09
+15. 2019-18
+16. 2019-30
+17. 2019-47
+18. 2020-10 
+
+#### Initial Data Collection and Normalization
+
+Filtering and deduplication of each month seperalety was performed with [CC_Net](https://github.com/facebookresearch/cc_net). The current datasets only contains the best part (head part) with the highest text quality (see CC_Net Paper for more details). Middle and tail part may be uploaded soon as well, or are available on request. 
+
+Afterwards this Dataset was deduplicated again to filter out Websites which occur in multiple monthly snapshots. This deduplication removes all Websites which have either the same url or the same hash (this is to filter out websites which are accessible under multiple domains)
+
+#### 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
+
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+```
+@inproceedings{wenzek2020ccnet,
+  title={CCNet: Extracting High Quality Monolingual Datasets from Web Crawl Data},
+  author={Wenzek, Guillaume and Lachaux, Marie-Anne and Conneau, Alexis and Chaudhary, Vishrav and Guzm{\'a}n, Francisco and Joulin, Armand and Grave, {\'E}douard},
+  booktitle={Proceedings of The 12th Language Resources and Evaluation Conference},
+  pages={4003--4012},
+  year={2020}
+```

de_head_0000_2015-48.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:de4ca886d66be678f88967812cc0e52c43392676487da0434d471431131e54ca
+size 1226773504

de_head_0000_2016-18.tar.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4bf70f415610188201036107205033d443af15209f929f648b93420d5c996144
+size 1564410794

german_common_crawl.py

@@ -0,0 +1,153 @@
+# coding=utf-8
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""German Common Crawl"""
+
+from __future__ import absolute_import, division, print_function
+
+import csv
+import json
+import os
+import gzip 
+
+import datasets
+
+
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = """\
+@inproceedings{wenzek2020ccnet,
+  title={CCNet: Extracting High Quality Monolingual Datasets from Web Crawl Data},
+  author={Wenzek, Guillaume and Lachaux, Marie-Anne and Conneau, Alexis and Chaudhary, Vishrav and Guzm{\'a}n, Francisco and Joulin, Armand and Grave, {\'E}douard},
+  booktitle={Proceedings of The 12th Language Resources and Evaluation Conference},
+  pages={4003--4012},
+  year={2020}
+}
+"""
+
+_DESCRIPTION = """\
+German Only Extract from Common Crawl 
+
+This Dataset is for pretraining a German Language Model (Unsupervised) or tune a Multilingual Model specifically to German 
+"""
+
+
+_URL = ["https://s3.amazonaws.com/datasets.huggingface.co/datasets/datasets/german-nlp-group/german_common_crawl/de_head_0000_2015-48.tar.gz"]
+
+
+class GermanCommonCrawl(datasets.GeneratorBasedBuilder):
+    """TODO: Short description of my dataset."""
+
+    VERSION = datasets.Version("1.1.0")
+
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="first_part", version=VERSION, description="Download only one part (2 GB) instead of everythong (200 GB)"),
+        datasets.BuilderConfig(name="data_only", version=VERSION, description="Only the website text without metadata"),
+        datasets.BuilderConfig(name="metadata", version=VERSION, description="Metadata and raw text"),
+    ]
+
+    DEFAULT_CONFIG_NAME = "metadata"
+
+    def _info(self):
+        if self.config.name == "data_only":  # This is the name of the configuration selected in BUILDER_CONFIGS above 
+            features = datasets.Features(
+                {
+                    "raw_content": datasets.Value("string"),
+                }
+            )
+        else:  # This is an example to show how to have different features for "first_domain" and "second_domain"
+            features = datasets.Features(
+                {
+                    "text": datasets.Value("string"),
+                    "url": datasets.Value("string"),
+                    "digest": datasets.Value("string"),
+                    "length": datasets.Value("int32"), 
+                    "nlines": datasets.Value("int32"),
+                    "source_domain": datasets.Value("string"), 
+                    "title": datasets.Value("string"), 
+                    "raw_content": datasets.Value("string"),
+                    "cc_segment": datasets.Value("string"),
+                    "original_nlines": datasets.Value("int32"), 
+                    "original_length": datasets.Value("int32"),
+                    "language": datasets.Value("string"),
+                    "perplexity": datasets.Value("int32"),
+                    "bucket": datasets.Value("int32"),
+                    
+                }
+            )
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # This defines the different columns of the dataset and their types
+            features=features,  # Here we define them above because they are different between the two configurations
+            # If there's a common (input, target) tuple from the features,
+            # specify them here. They'll be used if as_supervised=True in
+            # builder.as_dataset.
+            supervised_keys=None,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators.""" 
+        
+        if self.config == "first_part": 
+            data_dir = dl_manager.download_and_extract(_URL[0]) 
+        
+        else: 
+            data_dir = dl_manager.download_and_extract(_URL)
+            
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "folderpath": data_dir,
+                    "split": "train",
+                },
+            ),
+        ]
+
+    def _generate_examples(self, folderpath, split):
+        """ Yields examples. """
+        
+        files = os.listdir(folderpath)
+        
+        if self.config == "first_part": 
+            files = os.path.join(folderpath, files[0]) 
+        else: 
+            files = [os.path.join(folderpath, file) for file in files]
+            
+        #filepath = "/media/data/48_BERT/22_HF_Dataset/Data/de_head_0000_2015-48.tar.gz"
+        
+        for filepath in files: 
+            with gzip.open(filepath, 'rt', encoding="utf-8") as f:
+                for id_, row in enumerate(f):
+                    data = eval(row)
+                    if self.config.name == "data_only":
+                        yield id_, {
+                            "raw_content": data["raw_content"],
+                        }
+                    else: 
+                        yield id_, data
+                        
+                    
+                    
+                    
+                    
+                    
+                    
+
+
+