Update README.md

README.md

@@ -1,3 +1,18 @@
 ---
 license: mit
 ---
+
+## Dataset
+The dataset is composed of messages labeled by ham or spam, merged from three data sources:
+1.	SMS Spam Collection https://www.kaggle.com/datasets/uciml/sms-spam-collection-dataset
+2.	Telegram Spam Ham https://huggingface.co/datasets/thehamkercat/telegram-spam-ham/tree/main
+3.	Enron Spam:  https://huggingface.co/datasets/SetFit/enron_spam/tree/main (only used message column and labels)
+
+The prepare script for enron is available at https://github.com/mshenoda/roberta-spam/tree/main/data/enron.
+The data is split 80% train 10% validation, and 10% test sets; the scripts used to split and merge of the three data sources are available at: https://github.com/mshenoda/roberta-spam/tree/main/data/utils.
+
+### Dataset Class Distribution
+
+Training  80%  |  Validation  10%   |  Testing  10%          
+:-------------------------:|:-------------------------:|:-------------------------: 
+![](plots/train_set_distribution.jpg "Train / Validation Loss") Class Distribution | ![](plots/val_set_distribution.jpg "Class Distribution") Class Distribution | ![](plots/test_set_distribution.jpg "Class Distribution")  Class Distribution