First commit

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

README.md

@@ -0,0 +1,155 @@
+---
+annotations_creators:
+- expert-generated
+- found
+language_creators:
+- found
+- expert-generated
+license: []
+multilinguality:
+- translation
+pretty_name: opus
+size_categories: []
+source_datasets: []
+tags:
+- parallel-corpus
+task_categories:
+- translation
+task_ids: []
+---
+
+# Dataset Card for [opus]
+
+## 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
+Loads [OPUS](https://opus.nlpl.eu/) as HuggingFace dataset. OPUS is an open parallel corpus covering 700+ languages and 1100+ datasets.
+
+Given a `src` and `tgt` language, this repository loads *all* available parallel corpus. To my knowledge, other OPUS datasets on Huggingface loads a specific corpus
+
+**Requirements**. Pip install my fork of `OpusTools`.
+
+```
+git clone https://github.com/larrylawl/OpusTools.git
+pip install -e OpusTools/opustools_pkg
+```
+
+**Disclaimer**.
+
+This repository is still in active development. Do make a PR if there're any issues!
+
+### Dataset Summary
+
+[More Information Needed]
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+Available languages can be viewed on the [OPUS API](https://opus.nlpl.eu/opusapi/?languages=True)
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+```
+features = {
+            "src": datasets.Value("string"),
+            "tgt": datasets.Value("string"),
+        }
+```
+
+### Data Splits
+
+Merged all data into train split.
+
+## 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
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+Thanks to [@larrylawl](https://larrylawl.github.io/) for adding this dataset.

load_script.py

@@ -0,0 +1,110 @@
+# coding=utf-8
+# Copyright 2020 The TensorFlow Datasets Authors and the HuggingFace Datasets Authors.
+#
+# 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.
+
+# Lint as: python3
+
+
+
+import json
+import os
+from typing import List
+import datasets
+import pandas as pd
+from constants import *
+from OpusTools.opustools_pkg.opustools.opus_read import OpusRead
+from OpusTools.opustools_pkg.opustools.opus_get import OpusRead
+
+_DESCRIPTION = """\
+Downloads OPUS data using `opustools`.
+"""
+
+_VERSION = "1.0.0"
+_URL = "https://opus.nlpl.eu/"
+
+class OpusConfig(datasets.BuilderConfig):
+    """BuilderConfig for Opus Dataset."""
+
+    def __init__(self, *args, src=None, tgt=None, corpus=None, download_dir="data", **kwargs):
+        """ BuilderConfig for Opus Dataset.
+        The following args follows `opustools`: https://pypi.org/project/opustools/
+        
+        Args:
+            src: str, source language
+            tgt: str, target language
+            corpus: List[str], List of corpus names. Leave as `None` to download all available corpus for the src-tgt pair.
+            download_dir: str, dir to save downloaded files
+        
+        """
+        
+        super(OpusConfig, self).__init__(
+            *args,
+            name=f"{src}-{tgt}",
+            description=f"Translating {src} to {tgt} or vice versa",
+            **kwargs)
+        self.src = src
+        self.tgt = tgt
+        self.opus_get = opustools.OpusGet(source=src, target=tgt, list_resources=True, directory=corpus)
+        self.download_dir = download_dir
+        
+    def get_corpora_data(self):
+        """ Returns corpora, number of files, and total size. """
+        return self.opus_get.get_corpora_data()
+        
+
+class Opus(datasets.GeneratorBasedBuilder):
+    """ Opus dataset. 
+    See: https://huggingface.co/docs/datasets/dataset_script#create-a-dataset-loading-script"""
+    
+    BUILDER_CONFIG_CLASS = OpusConfig
+    
+    def _info(self):
+        features = {
+            "src": datasets.Value("string"),
+            "tgt": datasets.Value("string"),
+        }
+        
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(features),
+            homepage=_URL,
+        )
+    
+    def _split_generators(self, dl_manager: datasets.DownloadManager) -> List[datasets.SplitGenerator]:
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={}),
+        ]
+
+    def _generate_examples(self):
+        # read from specific corpus
+        id_ = 0
+        
+        data = self.config.opus_get.get_corpora_data()
+        self.config.opus_get.print_files(*data)
+        
+        for d in data[0]:        
+            opus_reader = opustools.OpusRead(
+                directory=d["corpus"],
+                source=self.config.src,
+                target=self.config.tgt,
+                write_mode="yield_tuple",
+                leave_non_alignments_out=True,
+                download_dir=self.config.download_dir,
+                suppress_prompts=True,
+            )
+            gen = opus_reader.printPairs()
+            for src, tgt in gen:
+                yield id_, {"src": src, "tgt": tgt}
+                id_ += 1
+