kristada673 commited on
Commit
2c7b0fc
1 Parent(s): 931d5fb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -40
README.md CHANGED
@@ -1,40 +1,8 @@
1
- # RoboAdvisor
2
-
3
- ## What it does and how it works
4
- 1) User gives a stock ticker symbol
5
- 2) The bot queries the Finnhub API and searches for articles, news, Tweets, etc about this company over the last 7 days and downloads them
6
- 3) It then converts the documents into smaller chunks, and uses LLM vector embeddings to convert the documents into a vector index DB, for easy querying
7
- 4) When the user asks (prompts) a question, a vector embedding of the query/prompt is calculated, and a similarity search of this prompt vector is performed against the vector index DB
8
- 5) The top 'k' chunks are retrieved according to the vector similarity search (in this particular case, I am using the FAISS algorithm to perform the similarity search)
9
- 6) The bot then queries the OpenAI GPT-3.5-Turbo API to query on those retrieved chunks, and returns a response.
10
-
11
- In short, given a stock ticker symbol, this app uses GPT-3.5 to give investment outlook about it by reading articles, tweets and news about that company
12
-
13
- ## Steps to install Ta-Lib in Linux
14
-
15
- ```
16
- wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
17
- tar -xzf ta-lib-0.4.0-src.tar.gz
18
- cd ta-lib/
19
- ./configure --prefix=/usr
20
- make
21
- sudo make install
22
- pip install ta-lib
23
- ```
24
- Run `pip install -r requirements.txt` only after install Ta-Lib correctly.
25
-
26
- ## Steps for Kuberenetes deplolyment is GCP
27
-
28
- 1. docker build -t robo_advisor .
29
- 2. docker tag robo_advisor gcr.io/asom-barta-qna-bot/robo_advisor
30
- 3. docker push gcr.io/asom-barta-qna-bot/robo_advisor
31
- 4. Go to "container registry" and verify that the docker image is present
32
- 5. Go to 'Kubernetes Engine' in the Google Cloud Console and create a new Kubernetes cluster in Autopilot mode. Select a location in Asia. Wait for the k8s cluster to be created.
33
- 6. Once the cluster is created, create a deployment. Select the docker image from container registry, give a suitable name to the deployment.
34
- 7. Click on "Expose deployment as a new service", and set the port as 7860 (since the default port used by the Gradio app is 7860), and deploy.
35
-
36
- It may appear like this at first:
37
-
38
- ![image](https://github.com/PrashantSaikia/RoboAdvisor/assets/39755678/164ef861-8689-44d5-8709-851c36f3bc8c)
39
-
40
- But it just needs some time to allocate the resources. Check back after 10-15 mins, it should be all green and ready.
 
1
+ title: Robo Advisor
2
+ emoji: 🏃
3
+ colorFrom: gray
4
+ colorTo: purple
5
+ sdk: gradio
6
+ sdk_version: 3.35.2
7
+ app_file: app.py
8
+ pinned: false