Skip to content

Commit

Permalink
run locally - readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geemi725 authored May 22, 2024
1 parent eda72e2 commit 27e2739
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ In this case, you can add keywords to search arxiv and set the maximum number of
This video is made faster for demonstration purposes. General run time in the streamlit app is ~3 minutes. But this may vary depending on the size of the dataframe and the literature dataset.

## Run Locally
After installing the required packages given in [reference.txt](https://github.com/geemi725/XpertAI/blob/main/requirements.txt), a user can run the streamlit app locally with `streamlit run app.py`
1. Clone the XpertAI GitHub repository `git clone https://github.com/geemi725/XpertAI.git`
2. From the home directory, install the required packages given in [reference.txt](https://github.com/geemi725/XpertAI/blob/main/requirements.txt). You can do so with `pip install -r requirements.txt`,
3. Run the streamlit app locally with `streamlit run app.py`

## Cite our work
Wellawatte, Geemi P., and Philippe Schwaller. "Extracting human interpretable structure-property relationships in chemistry using XAI and large language models." arXiv preprint arXiv:2311.04047 (2023).

Expand Down

0 comments on commit 27e2739

Please sign in to comment.