Update README.md

README.md

@@ -30,4 +30,63 @@ source_datasets:
 - openai_humaneval
 size_categories:
 - n<1K
----
+---
+
+# Dataset Card for JHumanEval: Japanese Hand-Translated HumanEval
+
+## Dataset Summary
+This is a Japanese translated version of HumanEval, an evaluation harness for the HumanEval problem solving dataset described in the paper "Evaluating Large Language Models Trained on Code".
+
+LLMのコード生成能力の標準ベンチマーク HumanEval の日本語翻訳版です。
+機械翻訳(DeepL, GPT-4)の翻訳結果を全て人手によって再修正し、 訳文を日本人のプログラマが読んで理解し、コードが書ける内容かチェックしました。
+ただし、英語版 HumanEval の間違いは、修正せずに残して、 HumanEval 同様に不完全なドキュメントからの生成能力を見るようになっています。
+日本語LLMのベンチマークとしてお使いください。
+
+## Languages
+The programming problems are written in Python and contain English natural text in comments and docstrings.
+
+## Dataset Structure
+
+```python
+from datasets import load_dataset
+load_dataset("kogi-jwu/jhumaneval")
+
+DatasetDict({
+    test: Dataset({
+        features: ['task_id', 'prompt_en', 'prompt', 'entry_point', 'canonical_solution', 'test'],
+        num_rows: 164
+    })
+})
+```
+
+### Data Instances
+An example of a dataset instance:
+
+{
+    "task_id": "test/0",
+    "prompt_en": "def return1():\n    \"\"\"\n    A simple function that returns the integer 1.\n    \"\"\"\n",
+    "prompt": "def return1():\n    \"\"\"\n    整数1を返すシンプルな関数。\n    \"\"\"\n",
+    "canonical_solution": "    return 1",
+    "test": "def check(candidate):\n    assert candidate() == 1",
+    "entry_point": "return1"
+}
+
+### Data Fields
+- task_id: Unique identifier for a task.
+- prompt_en: Function header and English docstrings as model input.
+- prompt: Function header and Japanese docstrings, parallel to prompt_en.
+- canonical_solution: The expected function implementation.
+- test: Function to verify the correctness of generated code.
+- entry_point: Function name to initiate the test.
+
+### Data Splits
+The dataset only consists of a test split with 164 samples.
+
+## Additional Information
+
+### Licensing Information
+MIT License
+
+## GitHub Repository
+
+[https://github.com/KuramitsuLab/jhuman-eval](https://github.com/KuramitsuLab/jhuman-eval)