Update README.md

Update README.md with summary info on model.

Still to do: Add detailed information

README.md

@@ -1,12 +1,24 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- afcp
+- automatic_classifiers_for_peace
+- hatespeech
+license: agpl-3.0
+language:
+- fr
+- en
+base_model:
+- google-bert/bert-base-multilingual-uncased
+pipeline_tag: text-classification
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
+This model classifies text - specifically social media posts - on if they contain intimidating speech. 
+It has been fine-tuned on a small sample (n=8442) of facebook comments, which are only slightly imbalanced (n_intimidating=3115, n_not_intimidating=5327).
+These comments were placed under facebook posts originating from 3 countries in the Sahel region (Burkina Faso, Niger, Mali). 
+The language in the dataset is predominantly French and English, with some code-switching between the two languages. It is also slang-heavy as it is social media data.
 
 
 ## Model Details
@@ -15,27 +27,17 @@ tags: []
 
 <!-- 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]
+- **Developed by:** [datavaluepeople](https://datavaluepeople.com) in conjunction with [How to Build UP](https://howtobuildup.org/) for a project to find and counteract intimidating speech which  
+- **Language(s) (NLP):** French, English
+- **License:** agpl-3.0
+- **Finetuned from model:** [google-bert/bert-base-multilingual-uncased](https://huggingface.co/google-bert/bert-base-multilingual-uncased)
 
 ## 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. -->
+This model is intended for use by (digital) peacebuilders and anyone working towards depolarising the digital public sphere.
+We have used it in conjunction with [Phoenix](https://howtobuildup.org/phoenix/), an ethical, open source, non-commercial platform designed to enable peacebuilders and mediators to conduct ethical and participatory social media listening in order to inform conflict transformation work. 
+There is a lot of social media data, and this allows peacebuilders to quickly find instances of comments that discourage the dialogue to continue through intimidation of the other participants. 
+The peacebuilder can then use this to inform programming, as well as conduct targeted interventions to mitigate that intimidation.
 
 ### Direct Use
 
@@ -43,12 +45,6 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 [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. -->