hariharan220 commited on
Commit
7a64d44
·
verified ·
1 Parent(s): bb7bb51

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -0
README.md CHANGED
@@ -7,5 +7,20 @@ sdk: docker
7
  pinned: false
8
  license: mit
9
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
 
11
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
7
  pinned: false
8
  license: mit
9
  ---
10
+ # Stock Sentiment Analysis API
11
+
12
+ This is a FastAPI-based sentiment analysis API using FinBERT trained for stock-related news.
13
+
14
+ ## How to Use
15
+
16
+ - **Endpoint**: `/predict`
17
+ - **Method**: `POST`
18
+ - **Input**: JSON with a `text` field (stock-related text)
19
+ - **Output**: JSON with `"sentiment"` (Positive, Neutral, or Negative)
20
+
21
+ Example request:
22
+ ```bash
23
+ curl -X POST "https://your-huggingface-space-url/predict" -H "Content-Type: application/json" -d '{"text": "Apple stock is rising today!"}'
24
+
25
 
26
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference