Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ans155 authored Mar 5, 2024
1 parent b6d8bb1 commit e0bfc66
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StockBot : Your Personal Investment Assistant
# StockBot : Your Personal Financial Assistant

StockBot is an intelligent chatbot designed to provide accurate answers related to stock market queries. Built on the Retrieval Augmented Generation (RAG) structure, StockBot leverages the power of two cutting-edge language models: Gemini Pro and Llama-2-7B. With its vast knowledge base encompassing PDFs and documents, StockBot delivers precise responses to user inquiries, making it an indispensable tool for investors and traders alike.

Expand Down Expand Up @@ -39,7 +39,11 @@ StockBot is an intelligent chatbot designed to provide accurate answers related
- Google Gemini Pro
- hkunlp/instructor-large


## Clone the repository
```bash
git clone https://github.com/Ans155/StockBot.git
cd StockBot
```
## Installation and Set-up for Backend

To deploy StockBot locally, follow these steps:
Expand Down Expand Up @@ -99,6 +103,7 @@ With the virtual environment activated, you can now install the required package
2. Run the following command to install the required packages:

```bash
cd server
pip install -r requirements.txt
```
Obtain a Google Gemini API key and create a DataStax AstraDB account. Configure a new database and set DataStax AstraDB token, DataStax AstraDB API endpoint, and Google Gemini API key as environment variables.
Expand Down Expand Up @@ -144,4 +149,4 @@ Access the app in your browser at http://localhost:3000.

## Testing the App

To test the functionalities of our app, utilize the provided `.ipynb` files. Open `Bot_using_LLAMA2.ipynb` for StockBot with Llama2 LLM or `Bot_using_GeminiAPI.ipynb` for StockBot with Gemini LLM in Google Colab or any other virtual environment of your choice to experiment with the app.
To test the functionalities of our app, utilize the provided `.ipynb` files. Open `StockBot_using_LLAMA_2.ipynb` for StockBot with Llama2 LLM or `Bot_using_GeminiAPI.ipynb` for StockBot with Gemini LLM in Google Colab or any other virtual environment of your choice to experiment with the app.

0 comments on commit e0bfc66

Please sign in to comment.