Update README.md

README.md

@@ -1,22 +1,83 @@
+---
+license: other
+task_categories:
+- translation
+language:
+- en
+- ja
+pretty_name: en-ja-align
+size_categories:
+- 10K<n<100K
+---
+
 # en-ja-align
 
+[日英対訳文対応付けデータ](https://www2.nict.go.jp/astrec-att/member/mutiyama/align/)(内山ら, 2003)として公開されている日英対訳文データセットです。
+本リポジトリはデータセットのダウンロード・解析・前処理のみを行うスクリプトを提供しているものであり、データの再配布はしておりません。
+
+
+## Usage
+
+
+```python
+
+import datasets as ds
+
+dataset = ds.load_dataset("hpprc/en-ja-align", num_proc=16, trust_remote_code=True)
+
+print(dataset)
+# DatasetDict({
+#     train: Dataset({
+#         features: ['id', 'en', 'ja', 'source'],
+#         num_rows: 42728
+#     })
+# })
+
+print(dataset["train"][1])
+# {
+#     'id': 1,
+#     'en': 'Work is the source of nearly all the misery in the world.',
+#     'ja': '労働こそが、この世のほとんど全ての不幸の源泉なのである。',
+#     'source': 'abolition-0.htm',
+# }
+```
+
 
 ## Preprocess
 
 
+[ホームページ](https://www2.nict.go.jp/astrec-att/member/mutiyama/align/)にて公開されているテキストデータは形態素解析器ChaSenで前処理されており、生文を取得するのが難しかったため、HTM (HTML)ファイルを直接解析することで対訳文を取得しています。
+
+前処理の改善案がある方はPull RequestやCommunity Discussionを遠慮なく利用していただければと思います。
 
 
 ## License
 
+[日英対訳文対応付けデータ](https://www2.nict.go.jp/astrec-att/member/mutiyama/align/)には、一部再配布が禁じられているデータセットが存在します。
+
+また、ライセンス関連の記述として以下のような記載があります。
+
 > オリジナルの各作品の著作権は，それぞれの作品の著作権に従います．
 > その他のものについては Creative Commons Attribution-ShareAlike 3.0 Unported に従い，それらの著作権は情報通信研究機構多言語翻訳研究室が保持します．
 > なお，オリジナルの作品が二次配布を禁止している場合には，そこからの派生物（対訳データなど）も二次配布することを禁止します．
 > また，オリジナルの作品が営利目的の利用を禁止している場合には，派生物の営利目的の利用も禁止します．
 
+しかし、すべてのデータについてライセンスを確認するには多少手間がかかります。
+
+そこで本リポジトリでは、ライセンスの問題を可能な限り回避するため、[ダウンロードページ](https://www2.nict.go.jp/astrec-att/member/mutiyama/align/download/index.html)のデータを前処理するスクリプトを提供し、データの再配布をしないという選択をしています。
+具体的な処理内容は本リポジトリの[hpprc/en-ja-align/blob/main/en-ja-align.py](https://huggingface.co/datasets/hpprc/en-ja-align/blob/main/en-ja-align.py)に記載されているので、よろしければご覧ください。
+
 
 ## Citation
 
+本リポジトリのデータセットを参考文献等に引用する際には、[日英対訳文対応付けデータ](https://www2.nict.go.jp/astrec-att/member/mutiyama/align/)の節「引用について」に基づき、以下のいずれかの記述による引用をしていただくようお願いいたします。
+
 ```
 内山将夫，高橋真弓．(2003) 日英対訳文対応付けデータ．
 Masao Utiyama and Mayumi Takahashi. (2003) English-Japanese Translation Alignment Data.
-```
+```
+
+
+## Acknowledgement
+
+データセットを作成・公開いただいた内山将夫様、高橋真弓様、そのほかデータの構築に携わった全ての方々に感謝申し上げます。