From 5f7a4f97fc8e815343b3270f6601d027fb3642de Mon Sep 17 00:00:00 2001 From: Sudarshan Koirala Date: Mon, 4 Dec 2023 15:00:09 +0000 Subject: [PATCH 1/3] updated the readme for correctly creating and activating virtual environment. Also the metaphor api key part is updated --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b22ee3..6ffc959 100644 --- a/README.md +++ b/README.md @@ -17,18 +17,24 @@ 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. Get the metaphor api key from the [metaphor website](https://metaphor.systems/) Then put the following: ``` openai_key = "" +metaphor_key="" ``` From bc783e2a4894b9a924b4dbb0feec7d6d83e8f7f2 Mon Sep 17 00:00:00 2001 From: Sudarshan Koirala Date: Mon, 4 Dec 2023 15:02:25 +0000 Subject: [PATCH 2/3] added metaphor python module in toml file --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index ca8e30a..187a261 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" [tool.poetry.dev-dependencies] # pytest = "7.2.1" From 390891c05515b730e8dd88bd0b21e44eed368d0a Mon Sep 17 00:00:00 2001 From: Sudarshan Koirala Date: Thu, 7 Dec 2023 17:15:20 +0200 Subject: [PATCH 3/3] updated readme stating that the metaphor is optional --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ffc959..615ad66 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,14 @@ 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. Get the metaphor api key from the [metaphor website](https://metaphor.systems/) +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 = "" -metaphor_key="" +metaphor_key="" #optional ```