Update README.md

README.md

@@ -1,47 +1,150 @@
 ---
+license: cc-by-sa-4.0
+language:
+- en
+metrics:
+- accuracy
+pipeline_tag: text-classification
 tags:
-- generated_from_keras_callback
-model-index:
-- name: partypress-monolingual-ireland
-  results: []
+- partypress
+- political science
+- parties
+- press releases
+widget:
+ - text: 'Immissionsschutzgesetz muss ein Klagerecht für BürgerInnen beinhalten: "Es ist seit Jahren bekannt, welche Maßnahmen zur Reduktion der Feinstaubbelastung gesetzt werden müssen. Diese neuerlich bloß aufzuzählen, wie es jetzt Minister Berlakovich tut, hilft den Betroffenen nicht", kritisiert die Grüne Umweltsprecherin Christiane Brunner die jüngsten Aussagen des Umweltministers zur Problematik Feinstaub.'
 ---
 
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
+# PARTYPRESS monolingual Ireland
 
-# partypress-monolingual-ireland
 
-This model is a fine-tuned version of [cornelius/partypress-monolingual-ireland](https://huggingface.co/cornelius/partypress-monolingual-ireland) on an unknown dataset.
-It achieves the following results on the evaluation set:
+Fine-tuned model, based on [distilbert-base-uncased-finetuned-sst-2-english](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english). Used in Erfort et al. (2023), building on the PARTYPRESS database. For the downstream task of classyfing press releases from political parties into 23 unique policy areas we achieve a performance comparable to expert human coders.
 
 
 ## Model description
 
-More information needed
+The PARTYPRESS monolingual model builds on [distilbert-base-uncased-finetuned-sst-2-english](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english) but has a supervised component. This means, it was fine-tuned using texts labeled by humans. The labels indicate 23 different political issue categories derived from the Comparative Agendas Project (CAP):
+| Code | Issue |
+|--|-------|
+| 1 | Macroeconomics |
+| 2 | Civil Rights |
+| 3 | Health |
+| 4 | Agriculture |
+| 5 | Labor |
+| 6 | Education |
+| 7 | Environment |
+| 8 | Energy |
+| 9 | Immigration |
+| 10 | Transportation |
+| 12 | Law and Crime |
+| 13 | Social Welfare |
+| 14 | Housing |
+| 15 | Domestic Commerce |
+| 16 | Defense |
+| 17 | Technology |
+| 18 | Foreign Trade |
+| 19.1 | International Affairs |
+| 19.2 | European Union |
+| 20 | Government Operations |
+| 23 | Culture |
+| 98 | Non-thematic |
+| 99 | Other |
+
+## Model variations
+
+There are several monolingual models for different countries, and a multilingual model. The multilingual model can be easily extended to other languages, country contexts, or time periods by fine-tuning it with minimal additional labeled texts.
 
 ## Intended uses & limitations
 
-More information needed
+The main use of the model is for text classification of press releases from political parties. It may also be useful for other political texts.
 
-## Training and evaluation data
+The classification can then be used to measure which issues parties are discussing in their communication.
 
-More information needed
+### How to use
+
+This model can be used directly with a pipeline for text classification:
+
+```python
+>>> from transformers import pipeline
+>>> tokenizer_kwargs = {'padding':True,'truncation':True,'max_length':512}
+>>> partypress = pipeline("text-classification", model = "cornelius/partypress-monolingual-ireland", tokenizer = "cornelius/partypress-monolingual-ireland", **tokenizer_kwargs)
+>>> partypress("Your text here.")
+```
+
+### Limitations and bias
+
+The model was trained with data from parties in Ireland. For use in other countries, the model may be further fine-tuned. Without further fine-tuning, the performance of the model may be lower.
+
+The model may have biased predictions. We discuss some biases by country, party, and over time in the release paper for the PARTYPRESS database. For example, the performance is highest for press releases from Ireland (75%) and lowest for Poland (55%).
+
+## Training data
+
+The PARTYPRESS multilingual model was fine-tuned with about 3,000 press releases from parties in Ireland. The press releases were labeled by two expert human coders.
+
+For the training data of the underlying model, please refer to [distilbert-base-uncased-finetuned-sst-2-english](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english)
 
 ## Training procedure
 
-### Training hyperparameters
+### Preprocessing
 
-The following hyperparameters were used during training:
-- optimizer: None
-- training_precision: float32
+For the preprocessing, please refer to [distilbert-base-uncased-finetuned-sst-2-english](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english)
 
-### Training results
+### Pretraining
 
+For the pretraining, please refer to [distilbert-base-uncased-finetuned-sst-2-english](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english)
 
+### Fine-tuning
 
-### Framework versions
+We fine-tuned the model using about 3,000 labeled press releases from political parties in Ireland. 
+
+#### Training Hyperparameters
+
+The batch size for training was 12, for testing 2, with four epochs. All other hyperparameters were the standard from the transformers library.
+
+
+#### Framework versions
 
 - Transformers 4.28.0
 - TensorFlow 2.12.0
 - Datasets 2.12.0
 - Tokenizers 0.13.3
+
+
+## Evaluation results
+
+Fine-tuned on our downstream task, this model achieves the following results in a five-fold cross validation that are comparable to the performance of our expert human coders. Please refer to Erfort et al. (2023)
+
+### BibTeX entry and citation info
+
+```bibtex
+@article{erfort_partypress_2023,
+  author    = {Cornelius Erfort and
+               Lukas F. Stoetzer and
+               Heike Klüver},
+  title     = {The PARTYPRESS Database: A New Comparative Database of Parties’ Press Releases},
+  journal   = {Research and Politics},
+  volume    = {forthcoming},
+  year      = {2023},
+}
+```
+
+### Further resources
+
+Github: [cornelius-erfort/partypress](https://github.com/cornelius-erfort/partypress)
+
+Research and Politics Dataverse: [Replication Data for: The PARTYPRESS Database: A New Comparative Database of Parties’ Press Releases](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi%3A10.7910%2FDVN%2FOINX7Q)
+
+
+
+## Acknowledgements
+
+Research for this contribution is part of the Cluster of Excellence "Contestations of the Liberal Script" (EXC 2055, Project-ID: 390715649), funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Ireland´s Excellence Strategy. Cornelius Erfort is moreover grateful for generous funding provided by the DFG through the Research Training Group DYNAMICS (GRK 2458/1).
+
+## Contact
+
+Cornelius Erfort
+
+Humboldt-Universität zu Berlin
+
+[corneliuserfort.de](corneliuserfort.de)
+
+