Update README.md

README.md

@@ -29,3 +29,93 @@ configs:
   - split: validation
     path: data/validation-*
 ---
+
+# Dataset Card for OPUS-100-en-ja
+
+### Dataset Summary
+
+This corpus is extracted from **[Helsinki-NLP/opus-100](https://huggingface.co/datasets/Helsinki-NLP/opus-100)**, with Japanese and English pairs.
+
+### How to use
+
+It is used in much the same way as **[Helsinki-NLP/opus-100](https://huggingface.co/datasets/Helsinki-NLP/opus-100)**. The only difference is that you do not have to specify the language.
+
+```
+from datasets import load_dataset
+dataset = load_dataset("Hoshikuzu/opus-100-en-ja")
+```
+If data loading times are too long and boring, use Streaming.
+
+```
+from datasets import load_dataset
+dataset = load_dataset("Hoshikuzu/opus-100-en-ja", streaming=True)
+```
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{
+  'translation': {
+    'en': 'Yeah, Vincent Hanna.',
+    'ja': '- ラウール - ラウールに ヴィンセント・ハンナだ'
+  }
+}
+```
+
+### Data Fields
+Translation dictionaries containing texts from languages 1 and 2.
+
+### Data Splits
+Only a `train` split is provided.
+
+### Citation Information
+
+Follow the instructions described in the Helsinki-NLP/opus-100 readme. The following is taken from Helsinki-NLP/opus-100:
+
+If you use this corpus, please cite the paper:
+```bibtex
+@inproceedings{zhang-etal-2020-improving,
+    title = "Improving Massively Multilingual Neural Machine Translation and Zero-Shot Translation",
+    author = "Zhang, Biao  and
+      Williams, Philip  and
+      Titov, Ivan  and
+      Sennrich, Rico",
+    editor = "Jurafsky, Dan  and
+      Chai, Joyce  and
+      Schluter, Natalie  and
+      Tetreault, Joel",
+    booktitle = "Proceedings of the 58th Annual Meeting of the Association for Computational Linguistics",
+    month = jul,
+    year = "2020",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2020.acl-main.148",
+    doi = "10.18653/v1/2020.acl-main.148",
+    pages = "1628--1639",
+}
+```
+and, please, also acknowledge OPUS:
+```bibtex
+@inproceedings{tiedemann-2012-parallel,
+    title = "Parallel Data, Tools and Interfaces in {OPUS}",
+    author = {Tiedemann, J{\"o}rg},
+    editor = "Calzolari, Nicoletta  and
+      Choukri, Khalid  and
+      Declerck, Thierry  and
+      Do{\u{g}}an, Mehmet U{\u{g}}ur  and
+      Maegaard, Bente  and
+      Mariani, Joseph  and
+      Moreno, Asuncion  and
+      Odijk, Jan  and
+      Piperidis, Stelios",
+    booktitle = "Proceedings of the Eighth International Conference on Language Resources and Evaluation ({LREC}'12)",
+    month = may,
+    year = "2012",
+    address = "Istanbul, Turkey",
+    publisher = "European Language Resources Association (ELRA)",
+    url = "http://www.lrec-conf.org/proceedings/lrec2012/pdf/463_Paper.pdf",
+    pages = "2214--2218",
+}
+```