Update README.md

README.md

@@ -1,10 +1,8 @@
 ---
 license: apache-2.0
+inference: False
 language:
 - en
-library_name: transformers
-
-
 widget:
 - text: "I am good. Just got back from vacation"
   example_title: "Example 1"
@@ -16,10 +14,44 @@ widget:
   example_title: "Example 4"
 ---
 
-Simple Model trained to classify 4 levels of politeness:
+# Polite Bert
+
+<img src="https://imgur.com/y8vqhCs" alt="drawing" style="width:300px;"/>
+
+### Model Details
+
+Polite Bert is, as the name implies, a BERT model trained to classify a given sentence on a scale of politeness:
+
 - Not Polite (aka Rude or Impolite)
 - Neutral
 - Somewhat Polite
 - Polite
 
-Made by Diogo M. Silva. PhD Student at NOVA FCT and Affiliated PhD Student at CMU
+#### Training
+
+Polite Bert was trained by fine-tuning a [BERT](https://huggingface.co/google-bert/bert-base-uncased) model on annotated politeness-level data. 
+The model was trained using SFT for 4 epochs, with a batch size 16, and a max sequence length of 128 tokens.
+
+### Data Details
+
+The training data consisted of 2000 annotated sentences. This training data was composed of the following:
+
+Manually annotated data:
+- 250 sentences sampled from [EUROPARL](https://www.statmt.org/europarl/) dataset. Specifically from the English version of PT-EN data.
+- 250 sentences sampled from [SIMMC2.0](https://aclanthology.org/2021.emnlp-main.401.pdf) dataset. From any domain (Fashion or Furniture) and speaker (System or User).
+- 250 sentences sampled from the Philosophy and Politics data of the [StackExchange](https://stackoverflow.blog/2014/01/23/stack-exchange-cc-data-now-hosted-by-the-internet-archive/) dataset.
+- 250 sentences sampled from a collection of hotel review replies from Trip Advisor.
+
+Automatically annotated data:
+- 1000 sentences from [4Chan Pol](https://arxiv.org/abs/2001.07487) dataset. Specifically, we only considered sentences annotated with TOXICITY > 0.85, SEVERE_TOXICITY > 0.85, and INSULT > 0.5.
+
+While we manually labelled the first 1000 sentences, the 1000 sentences from 4ChanPol were automatically set to **Not Polite**.
+
+These source datasets were chosen due to their likelihood of containing distinct, but pronounced, politeness levels (hate speech from 4chan, formal and polite speech from hotel staff and parliament members, etc)
+
+#### License
+
+Apache 2.0 license.
+
+
+Made by Diogo Glória-Silva. PhD Student at NOVA FCT and Affiliated PhD Student at CMU