Megan Chiovaro commited on
Commit
6b131c3
1 Parent(s): 51e0bf2

Update README

Browse files
Files changed (1) hide show
  1. README.md +18 -3
README.md CHANGED
@@ -1,8 +1,23 @@
1
  ---
2
  title: StockAIdvisor
3
- emoji: 🏃
4
- colorFrom: yellow
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
8
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: StockAIdvisor
3
+ emoji: 💸
4
+ colorFrom: blue
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
8
+ ---
9
+
10
+ # StockAIdvisor
11
+
12
+ _An app for stock identification and assessment using Claude._
13
+
14
+ **StockAIdvisor** is a tool for assessing stocks based on the previous years performance. Users can enter descriptions of the type of company they'd like to invest in. Claude will identify the company that they are most likely referring to (or that with the largest market cap) and return the ticker. The ticker is then used to collect performance data from `yfinance` and calculate various performance metrics. These metrics are then fed to Claude again to evaluate the stock's viability as a current investment choice based on risk tolerance.
15
+
16
+ ## Instructions
17
+ Navigate to the [Stock AIdvisor on Huggingface Spaces](https://huggingface.co/spaces/mchiovaro/stock-aidvisor) to give it a try.
18
+
19
+ _This costs $$ to run! Please be mindful of others so that there are enough credits to go around. If there appear to be no more credits, feel free to send a message._
20
+
21
+ ## Contributions
22
+ Feel free to submit a pull request for any issues or improvements! \
23
+ Author: Megan Chiovaro (@mchiovaro)