Fix imports, filename, README.

.gitignore

@@ -1,3 +1,7 @@
+data
+test_loader.ipynb
+preprocess.ipynb
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -48,7 +48,8 @@ task_ids: []
 ## 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
+Given a `src` and `tgt` language, this repository can load *all* available parallel corpus. To my knowledge, other OPUS datasets on Huggingface loads a specific corpus
+
 
 **Requirements**. Pip install my fork of `OpusTools`.
 
@@ -57,6 +58,25 @@ git clone https://github.com/larrylawl/OpusTools.git
 pip install -e OpusTools/opustools_pkg
 ```
 
+**Example Usage**.
+
+```
+# args follows `opustools`: https://pypi.org/project/opustools/
+
+src="en"
+tgt="id"
+download_dir="data"  # dir to save downloaded files
+corpus="bible-uedin" # corpus name. Leave as `None` to download all available corpus for the src-tgt pair.
+
+
+dataset = load_dataset("larrylawl/opus", 
+                       src=src, 
+                       tgt=tgt,
+                       download_dir=download_dir,
+                       corpus=corpus)
+                       )
+```
+
 **Disclaimer**.
 
 This repository is still in active development. Do make a PR if there're any issues!

load_script.py → opus.py

@@ -22,9 +22,7 @@ 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
+import opustools
 
 _DESCRIPTION = """\
 Downloads OPUS data using `opustools`.
@@ -43,7 +41,7 @@ class OpusConfig(datasets.BuilderConfig):
         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.
+            corpus: str, corpus name. Leave as `None` to download all available corpus for the src-tgt pair.
             download_dir: str, dir to save downloaded files
         
         """