From 49d4fddc5fd5fdcae52c7ba1a75adfbe858b1816 Mon Sep 17 00:00:00 2001 From: Nishant Balepur <55101514+nbalepur@users.noreply.github.com> Date: Sat, 27 Jan 2024 01:16:29 -0500 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d438e67..73bb9aa 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,16 @@ The most important files in this repository are as follows: * `/scripts/`: Sample bash scripts to run our code ## Model Usage -Nugget -There are four relevant files: -* `/model/run_hf.py`: Code to run all possible prompt formats, except the second step of the -* `/model/run_hf_question.py`: Contains the code for generating our plots -* `/scripts/`: Sample bash scripts to run our code + +There are six relevant files: +* `/model/run_hf.py`: Code to run all possible prompt formats, except the second step of the inferring the question strategy and the random question prompt +* `/model/run_hf_remote.py`: Version of `run_hf.py` that works with models on the huggingface hub where you need to trust remote code (i.e. Phi) +* `/model/extract_generated_questions.py`: After running step one of the inferring the question strategy in the above two Python scripts, this will extract the questions generated by the LLM. This must be run before either of the last two Python scripts +* `/model/extract_random_questions.py`: This will sample a random set of questions from the test set. for the LLM to use. This must be run before either of the last two Python files +* `/model/run_hf_question.py`: Code to run the second step of the inferring the question strategy and the random question prompt +* `/model/run_hf_question_remote.py`: Version of `run_hf_question.py` that works with models on the huggingface hub where you need to trust remote code (i.e. Phi) + ## Evaluation Usage + +