Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mchiovaro committed Jul 8, 2024
1 parent 51e0bf2 commit 6b131c3
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
---
title: StockAIdvisor
emoji: 🏃
colorFrom: yellow
emoji: 💸
colorFrom: blue
colorTo: green
sdk: docker
pinned: false
---
---

# StockAIdvisor

_An app for stock identification and assessment using Claude._

**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.

## Instructions
Navigate to the [Stock AIdvisor on Huggingface Spaces](https://huggingface.co/spaces/mchiovaro/stock-aidvisor) to give it a try.

_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._

## Contributions
Feel free to submit a pull request for any issues or improvements! \
Author: Megan Chiovaro (@mchiovaro)

0 comments on commit 6b131c3

Please sign in to comment.