Tasfiya025 commited on
Commit
93cb78c
·
verified ·
1 Parent(s): 77013c3

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -0
README.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # FinancialNewsSentimentClassifier_DistilBERT
2
+
3
+ ## 📰 Overview
4
+
5
+ This is a fine-tuned **DistilBERT** model optimized for **Sequence Classification** to analyze the sentiment of financial news headlines and short articles. It categorizes the text into three classes: **Bullish**, **Neutral**, and **Bearish**, providing a quantifiable measure of market outlook derived from textual data. The model was trained on a comprehensive dataset of news articles from major financial publications, labeled by human experts.
6
+
7
+ ## 🧠 Model Architecture
8
+
9
+ This model is built upon the **DistilBERT base uncased** architecture, a smaller, faster, and lighter version of BERT.
10
+
11
+ * **Base Model:** `distilbert-base-uncased`
12
+ * **Task:** Sequence Classification (`DistilBertForSequenceClassification`)
13
+ * **Input:** Tokenized financial news headlines or short-form texts (max sequence length 512).
14
+ * **Output:** Logits for three classes:
15
+ * `0`: Bullish (Positive market sentiment)
16
+ * `1`: Neutral (No significant market impact)
17
+ * `2`: Bearish (Negative market sentiment)
18
+ * **Training Details:** Fine-tuned for 3 epochs with a batch size of 16 and AdamW optimizer. Achieved an F1-score of 0.89 on the validation set.
19
+
20
+
21
+ ## 💡 Intended Use
22
+
23
+ * **Quantitative Finance:** Generating sentiment scores for stocks, sectors, or the entire market based on real-time news feeds.
24
+ * **Algorithmic Trading:** Using the sentiment output as an input feature for high-frequency trading models.
25
+ * **Market Research:** Tracking historical shifts in market sentiment towards specific companies or topics.
26
+ * **News Filtering:** Prioritizing news articles based on their potential market impact.
27
+
28
+ ### How to use
29
+
30
+ ```python
31
+ from transformers import pipeline
32
+
33
+ classifier = pipeline(
34
+ "sentiment-analysis",
35
+ model="[YOUR_HF_USERNAME]/FinancialNewsSentimentClassifier_DistilBERT",
36
+ tokenizer="distilbert-base-uncased"
37
+ )
38
+
39
+ # Example usage
40
+ result = classifier("Tesla stock surges 5% on better-than-expected Q4 earnings and new China factory plans.")
41
+ print(result)
42
+ # Expected output: [{'label': 'Bullish', 'score': 0.98...}]