Create README.md

README.md

@@ -0,0 +1,31 @@
+# RePublic
+
+### Model description
+RePublic (reputation analyzer for public agencies) is a Dutch BERT model based on BERTje (De Vries, 2019). 
+
+### Intended use
+The model was designed to predict the sentiment in Dutch-language news article text about public agencies.
+
+### How to use
+The model can be loaded and used to make predictions as follows:
+
+ ```
+from transformers import pipeline
+model_path = 'clips/republic'
+pipe = pipeline(task="text-classification", model=model_path, tokenizer=model_path)	
+text = … # load your text here
+output = pipe(text)
+prediction  = output[0]['label'] # 0=”neutral”; 1=”positive”; 2=”negative”
+```
+
+### Training and data procedure
+RePublic was domain-adapted on 91,661 Flemish news articles from three popular Flemish news providers (“Het Laatste Nieuws”, “Het Nieuwsblad” and “De Morgen”) that mention public agencies. This was done by performing BERT’s language modeling tasks (masked language modeling & next sentence prediction).
+
+The model was then fine-tuned on a sentiment classification task (“positive”, “negative”, “neutral”). The data consisted of 4,404 annotated sentences mentioning Flemish public agencies and fine-tuning was performed for 4 epochs using a batch size of 8 and a learning rate of 5e-5. 
+
+[TABLE 1: STATISTICS OF FINE-TUNING DATA]
+
+### Evaluation
+The model was evaluated by performing 10-fold cross validation on the annotated data described above. During cross validation, the optimal number of epochs (4), batch size (8), and learning rate (5e-5) were determined. 
+
+[TABLE 2: CROSS VALIDATION RESULTS]