Update README.md

README.md

@@ -6,5 +6,82 @@ metrics:
 - f1
 ---
 
-ACC : 48688 %
-Mac-F1 : 35.937%
+# Federated Learning Based Multilingual Emoji Prediction
+
+This repository contains code for training and evaluating transformer-based models for Uni/multilingual emoji prediction in clean and attack scenarios using Federated Learning. This work is described in the paper "Federated Learning-Based Multilingual Emoji Prediction in Clean and Attack Scenarios."
+
+# Abstract
+
+Federated learning is a growing field in the machine learning community due to its decentralized and private design. Model training in federated learning is distributed over multiple clients giving access to lots of client data while maintaining privacy. Then, a server aggregates the training done on these multiple clients without access to their data, which could be emojis widely used in any social media service and instant messaging platforms to express users' sentiments. This paper proposes federated learning-based multilingual emoji prediction in both clean and attack scenarios. Emoji prediction data have been crawled from both Twitter and SemEval emoji datasets. This data is used to train and evaluate different transformer model sizes including a sparsely activated transformer with either the assumption of clean data in all clients or poisoned data via label flipping attack in some clients. Experimental results on these models show that federated learning in either clean or attacked scenarios performs similarly to centralized training in multilingual emoji prediction on seen and unseen languages under different data sources and distributions. Our trained transformers perform better than other techniques on the SemEval emoji dataset in addition to the privacy as well as distributed benefits of federated learning.
+
+# Performance
+> * ACC : 48688 %
+> * Mac-F1 : 35.937%
+> * Also see our [GitHub Repo](https://github.com/kareemgamalmahmoud/FEDERATED-LEARNING-BASED-MULTILINGUAL-EMOJI-PREDICTION-IN-CLEAN-AND-ATTACK-SCENARIOS)
+
+# Dependencies
+> * Python 3.6+
+> * PyTorch 1.7.0+
+> * Transformers 4.0.0+
+
+# Usage
+
+> To use the model, first install the `transformers` package from Hugging Face:
+```python
+pip install transformers
+```
+
+> Then, you can load the model and tokenizer using the following code:
+```python
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+import numpy as np
+import urllib.request
+import csv
+```
+
+```python
+MODEL = "Karim-Gamal/MMiniLM-L12-finetuned-SemEval-2018-emojis-cen-2"
+tokenizer = AutoTokenizer.from_pretrained(MODEL)
+model = AutoModelForSequenceClassification.from_pretrained(MODEL)
+```
+
+> Once you have the tokenizer and model, you can preprocess your text and pass it to the model for prediction:
+
+```python
+# Preprocess text (username and link placeholders)
+def preprocess(text):
+    new_text = []
+    for t in text.split(" "):
+        t = '@user' if t.startswith('@') and len(t) > 1 else t
+        t = 'http' if t.startswith('http') else t
+        new_text.append(t)
+    return " ".join(new_text)
+
+text = "Hello world"
+text = preprocess(text)
+encoded_input = tokenizer(text, return_tensors='pt')
+output = model(**encoded_input)
+scores = output[0][0].detach().numpy()
+```
+
+> The scores variable contains the probabilities for each of the possible emoji labels. To get the top k predictions, you can use the following code:
+
+```python
+# download label mapping
+labels=[]
+mapping_link = "https://raw.githubusercontent.com/cardiffnlp/tweeteval/main/datasets/emoji/mapping.txt"
+with urllib.request.urlopen(mapping_link) as f:
+    html = f.read().decode('utf-8').split("\n")
+    csvreader = csv.reader(html, delimiter='\t')
+labels = [row[1] for row in csvreader if len(row) > 1]
+
+k = 3 # number of top predictions to show
+ranking = np.argsort(scores)
+ranking = ranking[::-1]
+for i in range(k):
+    l = labels[ranking[i]]
+    s = scores[ranking[i]]
+    print(f"{i+1}) {l} {np.round(float(s), 4)}")
+```
+
+## Note : this is the source for that code : [Link](https://huggingface.co/cardiffnlp/twitter-roberta-base-emoji)