From da43c257cdec9f4422d9ec64ee66014229db8001 Mon Sep 17 00:00:00 2001 From: Manish Shetty Date: Fri, 23 Feb 2024 10:14:46 -0800 Subject: [PATCH] readme update --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7345e83..c334ac3 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ python search.py --dataset --seed json.load ## Table of Contents - [How to install CodeScholar](#how-to-install-codescholar) +- [How to use CodeScholar](#how-to-use-codescholar) +- [How to run CodeScholar App](#how-to-run-codescholar-streamlit-app) - [How to train CodeScholar](#how-to-train-codescholar) -- [How to run pre-trained CodeScholar](#how-to-use-codescholar) -- [How to run CodeScholar Streamlit App](#how-to-run-codescholar-streamlit-app) - [Reproducability of CodeScholar Evaluation](#reproducability-of-codescholar-evaluation) @@ -52,12 +52,6 @@ pip install -r requirements-{pyg,torch}.txt pip install -e . ``` - -How to train CodeScholar: ------------------------ -Refer to the [training README](./codescholar/representation/README.md) for a detailed description of how to train CodeScholar. - - How to use CodeScholar: ----------------------- @@ -108,7 +102,7 @@ How to use CodeScholar: ``` *note: see more configurations in [/search/search_config.py](./codescholar/search/search_config.py)* -How to run CodeScholar Streamlit App: +How to run CodeScholar App: --------------------------- 1. Setup services @@ -149,6 +143,12 @@ How to run CodeScholar Streamlit App: View details about the app using: `./app.sh show` + +How to train CodeScholar: +----------------------- +Refer to the [training README](./codescholar/representation/README.md) for a detailed description of how to train CodeScholar. + + Reproducability of CodeScholar Evaluation: --------------------------- Refer to the [evaluation README](./codescholar/evaluation/README.md) for a detailed description of how to reproduce the evaluation results reported in the paper.