Update README.md

README.md

@@ -73,12 +73,26 @@ DatasetDict({
 - `signature`: The signature for the problem.
 - `signature_with_docstring`: The signature with the adequately formatted docstring for the given problem.
 - `arguments`: The arguments of the problem.
-- `entry_fn_name`: The function's name to use an entry point.
-- `entry_cls_name`: The class name to use an entry point.
 - `source`: The source solution in Python.
-- `test_code`: The raw testing script used in the language. If you want to use this, replace `PLACEHOLDER_FN_NAME` (and `PLACEHOLDER_CLS_NAME` if needed) with the corresponding entry points. Next, replace `PLACEHOLDER_CODE_BODY` with the postprocessed prediction.  
-- `test_list`: The raw json line of the list of tests for the problem. To load them, use `json.loads`
-- `test_case_ids`: The list of test case ids for the problem. These are used to determine if a prediction passes or not.
+- `question_info`: The dict of information used for executing predictions. It has the keys:
+  - `test_code`: The raw testing script used in the language. If you want to use this, replace `PLACEHOLDER_FN_NAME` (and `PLACEHOLDER_CLS_NAME` if needed) with the corresponding entry points. Next, replace `PLACEHOLDER_CODE_BODY` with the postprocessed prediction.  
+  - `test_list`: The raw json line of the list of tests for the problem. To load them, use `json.loads`
+  - `test_case_ids`: The list of test case ids for the problem. These are used to determine if a prediction passes or not.
+  - `entry_fn_name`: The function's name to use an entry point.
+  - `entry_cls_name`: The class name to use an entry point. 
+
+**NOTE:** If you want to use a different function name (or class name for languages that require class names) for the prediction, you must update the `entry_fn_name` and `entry_cls_name` accordingly. For example, if you have the original question with `entry_fn_name` of `add`, but want to change it to `f`, you must update `ds["question_info"]["entry_fn_name"]` to `f`:
+```python
+>>> from datasets import load_dataset
+>>> ds = load_dataset("gabeorlanski/bc-mbpp")['test']
+>>> # The original entry_fn_name
+>>> ds[0]['question_info']['entry_fn_name']
+removeOcc
+>>> # You MUST update the corresponding entry_fn_name
+>>> ds[0]['question_info']['entry_fn_name'] = 'f'
+>>> ds[0]['question_info']['entry_fn_name']
+f
+```
 ## Dataset Creation
 See section 2 and section 4.4 of the [BabelCode Paper](https://arxiv.org/abs/2302.01973) to learn more about how the datasets are translated.