Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the dependencies and readme file #50

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update the dependencies and readme file #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f7a4f9
updated the readme for correctly creating and activating virtual envi…
sudarshan-koirala Dec 4, 2023
bc783e2
added metaphor python module in toml file
sudarshan-koirala Dec 4, 2023
390891c
updated readme stating that the metaphor is optional
sudarshan-koirala Dec 7, 2023
fe21fcf
Merge branch 'main' into main
sudarshan-koirala Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,26 @@ This project is inspired by [GPTs](https://openai.com/blog/introducing-gpts), la

## Installation and Setup

Clone this project, go into the `rags` project folder. We recommend creating a virtual env for dependencies (`python3 -m venv .venv`).
Clone this project, go into the `rags` project folder. We recommend creating a virtual env for dependencies. Run the following to create and activate virtualenv.
```
python3 -m venv .venv && source .venv/bin/activate)
````

Once the virtual environment is activated, run the following to install the dependencies.

```
poetry install --with dev
```

By default, we use OpenAI for both the builder agent as well as the generated RAG agent.
Add `.streamlit/secrets.toml` in the home folder.
Add `.streamlit/secrets.toml` in the home folder.

(Optional) Get the metaphor api key from the [metaphor website](https://metaphor.systems/) for the web search.

Then put the following:
```
openai_key = "<openai_key>"
metaphor_key="<metaphor_key>" #optional
```


Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ llama-hub = "0.0.44"
# NOTE: this is due to a trivial dependency in the web tool, will refactor
langchain = "0.0.305"
pypdf = "3.17.1"
metaphor-python = "^0.1.23"
clip = { git = "https://github.com/openai/CLIP.git" }

[tool.poetry.dev-dependencies]
Expand Down