diff --git a/README.md b/README.md index e187f0ec3fe68935f8fffcc82fb2c02c0fed776e..074aeb465758280424f2994142c41f1095bb72c0 100644 --- a/README.md +++ b/README.md @@ -61,3 +61,25 @@ The main.py script will: ## Part 2: +### Set up environment + +Install required python libraries listed in the 'requirements.txt': + +`pip3 install -r requirements.txt` + +### Step 1: Create VM + +## Step 2: Running the app + +Launch the Streamlit application which interacts with the Vector Store , LLM for embeddings and LLM for text generation: + +`streamlit run main.py -- --endpoint [YourVectorDBEndpoint] --index_name [YourIndexName]` + +Where: + +- **--endpoint**: Endpoint for the vector database. +- **--index_name**: The index_name where to store the embeddings in the collection. + +## Step 3: Accessing the app: + +Once the app starts, navigate to this URL `http://[public_ip_adress_of_yourVM]:8501` in your web browser to start interacting with your chatbot. \ No newline at end of file