Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
manishshettym committed Feb 23, 2024
1 parent b155fae commit da43c25
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ python search.py --dataset <dataset_name> --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)


Expand All @@ -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:
-----------------------

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit da43c25

Please sign in to comment.