Update README.md

README.md

@@ -1,14 +1,30 @@
 ---
+---
 pretty_name: BigFixes
+description: A clean union of BigVul and CVE-Fixes. 
 configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: "train.csv"
-  - split: cleantest
-    path: "clean_test.csv"
-  - split: test
-    path: "test.csv"
+  - config_name: default
+    data_files:
+      - split: train
+        path: train.csv
+      - split: cleantest
+        path: clean_test.csv
+      - split: test
+        path: test.csv
+
+---
+---
 
+# Information
 
----
+This is a clean version of the union of BigVul and CVE-Fixes used
+  [here](https://huggingface.co/datasets/MickyMike/cvefixes_bigvul).
+  We have
+  three splits: 
+  - train, which has the de-duplicated training data;
+  - cleantest, which has de-duplicated testing data that is completely disjoint from the
+  training set;
+  - test, which has the deduplicated training data with a
+  significant intersection with the training data (as seen in the original
+  repository).
+Our preprocessing is available in `preprocessing.ipynb`.