Update README.md

README.md

@@ -4,57 +4,60 @@ language:
 - en
 metrics:
 - accuracy
-base_model:
-- FacebookAI/roberta-large
+base_model: facebook/roberta-large
 pipeline_tag: text-classification
 tags:
 - framing
 ---
 
-Sentence Frame Classifier
+# Sentence Frame Classifier
+
 A RoBERTa-based model for detecting media frames at the sentence level. This model can classify sentences into 9 different frame categories and works across both news articles and reader comments.
-Model Description
-This model was trained to identify media frames in text at the sentence level. It's based on the Media Frame Corpus (Card et al., 2015) and extends to online discussion contexts, making it suitable for analyzing both professional journalism and user-generated content.
-Key Features:
 
-Sentence-level frame classification
-Cross-domain capability (news articles + comments)
-9 frame categories based on established political communication theory
-Robust performance across different topics
+## Model Description
+
+This model was trained to identify media frames in text at the sentence level. It's based on the Media Frame Corpus (Card et al., 2015) and extends to online discussion contexts (Hartmann et al., 2019), making it suitable for analyzing both professional journalism and user-generated content.
+
+**Key Features:**
+
+- Sentence-level frame classification
+- Cross-domain capability (news articles + comments)
+- 9 frame categories based on established political communication theory
+- Robust performance across different topics
+
+## Frame Categories
 
-Frame Categories
 The model classifies sentences into these 9 frame categories:
 
-Economic - Economic costs, benefits, or implications
-Morality - Moral or ethical considerations
-Fairness and Equality - Issues of fairness, equality, or discrimination
-Legality and Crime - Legal aspects, constitutionality, crime, and punishment
-Political and Policies - Political processes, policy prescriptions, and evaluations
-Security and Defense - Security threats, defense, or public safety
-Health and Safety - Health risks, safety concerns, or medical implications
-Cultural Identity - Cultural values, traditions, or identity issues
-Public Opinion - Public sentiment, polls, or popular support
+- Economic — Economic costs, benefits, or implications
+- Morality — Moral or ethical considerations
+- Fairness and Equality — Issues of fairness, equality, or discrimination
+- Legality and Crime — Legal aspects, constitutionality, crime, and punishment
+- Political and Policies — Political processes, policy prescriptions, and evaluations
+- Security and Defense — Security threats, defense, or public safety
+- Health and Safety — Health risks, safety concerns, or medical implications
+- Cultural Identity — Cultural values, traditions, or identity issues
+- Public Opinion — Public sentiment, polls, or popular support
+
+## Performance
 
-Performance
+- Macro F1: 0.66
+- Accuracy: 0.77
+- Cross-topic generalization: Robust performance across different topics
+- Validation: Human-validated on 600 sentences
 
-Macro F1: 0.66
-Accuracy: 0.77
-Cross-topic generalization: Robust performance across different topics
-Validation: Human-validated on 600 sentences
+## Usage
 
-Usage
-pythonfrom transformers import pipeline
+```python
+from transformers import pipeline
 
-# Load the classifier
 classifier = pipeline("text-classification", model="your-username/sentence-frame-classifier")
 
-# Classify a sentence
 text = "The new policy will cost taxpayers millions of dollars while providing few benefits."
 result = classifier(text)
 print(result)
-# Output: [{'label': 'Economic', 'score': 0.89}]
+# [{'label': 'Economic', 'score': 0.89}]
 
-# Multiple examples
 examples = [
     "This violates our constitutional rights and freedoms.",
     "The public strongly supports this initiative according to recent polls.",
@@ -66,23 +69,3 @@ for text in examples:
     print(f"Text: {text}")
     print(f"Frame: {result[0]['label']} (confidence: {result[0]['score']:.2f})")
     print()
-Training Data
-The model was trained on:
-
-Media Frame Corpus (MFC): Professionally annotated news articles
-Online Forum Data: Sentence-level annotations from online discussions
-Total: 63,626 sentences across multiple topics
-
-Citation
-If you use this model in your research, please cite:
-
-
-License
-This model is released under the MIT License. You are free to use, modify, and distribute this model for any purpose, provided you include appropriate attribution.
-Model Details
-
-Model Type: Text Classification
-Base Model: RoBERTa-large
-Parameters: ~355M
-Training Framework: Transformers
-Inference Framework: Transformers Pipeline