mlburnham
/

Political_DEBATE_base_v1.0

@@ -1,199 +1,71 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: mit
+datasets:
+- mlburnham/Pol_NLI
+pipeline_tag: zero-shot-classification
+language:
+- en
 library_name: transformers
+tags:
+- Politics
+- Topic Classification
+- Hate Speech
+- Opinion Mining
+- Event Extraction
 ---
+# Model Details
+Political DEBATE (DeBERTa Algorithm for Textual Entailment) is an NLI classifier trained for zero-shot and few-shot classification of political documents.
+The model was trained using [Moritz Laurer's](https://huggingface.co/MoritzLaurer/deberta-v3-large-zeroshot-v2.0-c) zero shot model as the foundation, and then trained further using the [PolNLI dataset.](https://huggingface.co/datasets/mlburnham/Pol_NLI) The model was trained for four classification categories:
+1. Stance detection (i.e. opinion mining).
+2. Hatespeech detection.
+3. Event extraction.
+4. Topic classification.
+The PolNLI dataset contains documents from social media, news outlets, congressional bills, court case summaries, and more. Classification should work well across a broad set of document sources and subjects, but for best performance refer to the recommendations section.
+If you use this model or the PolNLI data set please cite:
+```
+@article{burnham2024debate,
+  title={Political DEBATE: Efficient Zero-shot and Few-shot Classifiers for Political Text},
+  author={Burnham, Michael, Kayla Kahn, Rachel Peng, Ryan Wang},
+  journal={working manuscript},
+  year={2024}
+}
+```
+# Using NLI Classifiers
+NLI classifiers work by pairing a document (AKA the 'premise') with a 'hypothesis', and determining if the hypothesis is true given the content of the document. The hypothesis is supplied by the user and can be thought of as a simplified version of a prompt for an LLM. It's best to keep hypotheses short and simple with a single classification criteria. If a more complicated hypothesis is necessary, consider few-shot training.
+For more detailed reading on using NLI classifiers see:
+```
+@article{burnham2024stance,
+  title={Stance Detection: A Practical Guide to Classifying Political Beliefs in Text},
+  author={Burnham, Michael},
+  journal={Political Science Research and Methods},
+  year={2024}
+}
+```
+# Recommendations
+1. Use the Political DEBATE large model for zero-shot and few-shot applications unless your use case is explicitly in the training data, in which case the base model should perform well. The base model is more appropriate for using the model as a supervised classifier.
+2. For best results, format hypotheses similar to the PolNLI dataset. Ex:
+  - "This text is about {}"
+  - "The author of this text believes {}"
+3. For few-shot training, use a small batch size of 1-2.
+4. Use a minimum of 10 samples for few-shot training, but we generally recommend 25 because the variance of outcomes at 10 can be quite large. You will see more benefit from more samples the more difficult your classification task and varied your data.
+5. Train for 3-5 epochs for few-shot learning.
+# Evaluation
+Evaluation is primarily conducted on the PolNLI test set. No hypotheses in the PolNLI test set are present in the training data in order to estimate zero-shot performance.
+### Overal performance on the PolNLI test set:
+<img src="https://cdn-uploads.huggingface.co/production/uploads/64d0341901931c60161f2a06/-sQhURg-zeacZAUNEVUpc.png" width="750" height="500"  />
+### Performance on the PolNLI test set by task:
+<img src="https://cdn-uploads.huggingface.co/production/uploads/64d0341901931c60161f2a06/66BOUiVt7Fdl0UhYxmjQB.png" width="750" height="500"  />
+### Few-shot performance on open-text survey answers vs. Llama 3.1 8B (unquantized):
+<img src="https://cdn-uploads.huggingface.co/production/uploads/64d0341901931c60161f2a06/kDZXC-OsZtmTCxq0HsJMg.png" width="750" height="500"  />
+### Few-shot performance vs. and Electra classifier trained on 2,000 documents:
+<img src="https://cdn-uploads.huggingface.co/production/uploads/64d0341901931c60161f2a06/WpQ_ZofMJMFPraCK_a3Fb.png" width="750" height="500"  />