Update README.md

README.md

@@ -51,6 +51,31 @@ The programming problems are written in Python and contain English and Japanese
 
 Pythonで書かれたプログラミング問題のデータセットには、英語と日本語のコメントやドキュメントストリングがそれぞれ別々に含まれています。
 
+## How to use
+
+参照コードでpass@1を算出する例: 
+
+```python
+import os
+from evaluate import load
+
+os.environ["HF_ALLOW_CODE_EVAL"] = "1"
+
+code_eval = load("code_eval")
+
+candidates = []
+test_cases = []
+
+for d in ds:
+  # FIXME: 参照コードをそのまま入れているが、予測コードに置き換えるべき
+  candidates.append([d['prompt']+d['canonical_solution']])
+  # テストケースを実行可能な形式にする
+  text_cases.append([d['test']+f"\n\ncheck({d['entry_point']})\n"v])
+
+pass_at_k, results = code_eval.compute(references=test_cases, predictions=candidates, k=[1])
+print(pass_at_k)
+```
+
 ## Dataset Structure
 
 ```python
@@ -65,7 +90,7 @@ DatasetDict({
 })
 ```
 
-### Data Instances
+## Data Instances
 An example of a dataset instance:
 
 ```
@@ -79,7 +104,7 @@ An example of a dataset instance:
 }
 ```
 
-### Data Fields
+## 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.
@@ -87,11 +112,11 @@ An example of a dataset instance:
 - `test` : Function to verify the correctness of generated code.
 - `entry_point` : Function name to initiate the test.
 
-### Data Splits
+## Data Splits
 The dataset only consists of a test split with 164 samples.
 
 ## Additional Information
 
-### Licensing Information
+## Licensing Information
 MIT License