Data loader complete and documented

opusparcus.py

@@ -1,5 +1,6 @@
 # coding=utf-8
-# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+# Copyright 2021 The HuggingFace Datasets Authors and
+# the current dataset script contributor (Mathias Creutz).
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""TODO: Add a description here."""
+"""Data loader for the Opusparcus paraphrase corpus."""
 
 import csv
 import json
@@ -24,22 +25,36 @@ import bz2
 # Add BibTeX citation
 
 _CITATION = """\
-
-@InProceedings{huggingface:dataset,
-title = {A great new dataset},
-author={huggingface, Inc.
-},
-year={2020}
+@InProceedings{creutz:lrec2018,
+  title = {Open Subtitles Paraphrase Corpus for Six Languages},
+  author={Mathias Creutz},
+  booktitle={Proceedings of the 11th edition of the Language Resources
+  and Evaluation Conference (LREC 2018)},
+  year={2018},
+  month = {May 7-12},
+  address = {Miyazaki, Japan},
+  editor = {Nicoletta Calzolari (Conference chair) and Khalid Choukri
+  and Christopher Cieri and Thierry Declerck and Sara Goggi and Koiti
+  Hasida and Hitoshi Isahara and Bente Maegaard and Joseph Mariani and
+  Hélène Mazo and Asuncion Moreno and Jan Odijk and Stelios Piperidis
+  and Takenobu Tokunaga},
+  publisher = {European Language Resources Association (ELRA)},
+  isbn = {979-10-95546-00-9},
+  language = {english},
+  url={http://www.lrec-conf.org/proceedings/lrec2018/pdf/131.pdf}
 }
 """
 
 _DESCRIPTION = """\
-Test adding a dataset with challenge set to GEM benchmark .
+Opusparcus is a paraphrase corpus for six European languages: German,
+English, Finnish, French, Russian, and Swedish. The paraphrases are
+extracted from the OpenSubtitles2016 corpus, which contains subtitles
+from movies and TV shows.
 """
 
-_HOMEPAGE = ""
+_HOMEPAGE = "http://urn.fi/urn:nbn:fi:lb-2018021221"
 
-_LICENSE = ""
+_LICENSE = "CC-BY-NC"
 
 # The HuggingFace dataset library doesn't host the datasets but only
 # points to the original files. This can be an arbitrary nested
@@ -61,9 +76,10 @@ class OpusparcusConfig(datasets.BuilderConfig):
     def __init__(self, lang=None, quality=100, **kwargs):
         """BuilderConfig for Wikipedia.
         Args:
-          language: string, the language code for the Wikipedia dump to use.
-          date: string, date of the Wikipedia dump in YYYYMMDD format. A list of
-            available dates can be found at https://dumps.wikimedia.org/enwiki/.
+          lang: string, two letter language code:
+                de, en, fi, fr, ru, sv
+          quality: int, filter training set according to quality:
+                   [ 60, 65, 70, 75, 80, 85, 90, 95, 100]
           **kwargs: keyword arguments forwarded to super.
         """
         super(OpusparcusConfig, self).__init__(
@@ -94,19 +110,44 @@ QUALITIES = [ 100, 95, 90, 85, 80, 75, 70, 65, 60 ]
     
 class Opusparcus(datasets.GeneratorBasedBuilder):
 
-    """TODO: Short description of my dataset."""
+    """Opusparcus is a paraphrase corpus for six European languages:
+    German, English, Finnish, French, Russian, and Swedish. The
+    paraphrases are extracted from the OpenSubtitles2016 corpus, which
+    contains subtitles from movies and TV shows.
+
+    The data in Opusparcus has been extracted from OpenSubtitles2016
+    (http://opus.nlpl.eu/OpenSubtitles2016.php), which is in turn
+    based on data from http://www.opensubtitles.org/.
+
+    For each target language, the Opusparcus data have been
+    partitioned into three types of data sets: training, validation
+    and test sets. The training sets are large, consisting of millions
+    of sentence pairs, and have been compiled automatically, with the
+    help of probabilistic ranking functions. The development and test
+    sets consist of sentence pairs that have been annotated manually;
+    each set contains approximately 1000 sentence pairs that have been
+    verified to be acceptable paraphrases by two indepedent
+    annotators.
+    """
 
-    # This is an example of a dataset with multiple configurations.
-    # If you don't want/need to define several sub-sets in your dataset,
-    # just remove the BUILDER_CONFIG_CLASS and the BUILDER_CONFIGS attributes.
-    # If you need to make complex sub-parts in the datasets with configurable options
-    # You can create your own builder configuration class to store attribute, inheriting from datasets.BuilderConfig
+    # This is a dataset with multiple configurations.
     BUILDER_CONFIG_CLASS = OpusparcusConfig
-    # You will be able to load one or the other configurations in the following list with
-    # data = datasets.load_dataset('my_dataset', 'first_domain')
-    # data = datasets.load_dataset('my_dataset', 'second_domain')
+
+    # You can load configurations as follows:
+    # data = datasets.load_dataset('GEM/opusparcus', lang='de')
+    # data = datasets.load_dataset('GEM/opusparcus', lang='fr', quality='75')
+    # etc.
+    #
+    # The language parameter is compulsory, whereas the quality
+    # parameter is not (the default value being 100).
+    #
+    # The above commands can alternatively be expressed as:
+    # data = datasets.load_dataset('GEM/opusparcus', 'de.100')
+    # data = datasets.load_dataset('GEM/opusparcus', 'fr.75')
+    
     BUILDER_CONFIGS = [
-        OpusparcusConfig(lang=lang, quality=quality, version=_VERSION) for lang in LANGS for quality in QUALITIES
+        OpusparcusConfig(lang=lang, quality=quality, version=_VERSION) \
+        for lang in LANGS for quality in QUALITIES
     ]
     
     # There is no default configuration. User always needs to specify one: