add readme

README.md

@@ -1 +1,40 @@
-test
+# Amazon ESCI/ESCI-S dataset
+
+A combination of [Amazon ESCI](https://github.com/amazon-science/esci-data) and [ESCI-S](https://github.com/shuttie/esci-s) datasets in a JSON format. 
+Used for fine-tuning bi- and cross-encoder models in the [Metarank](https://huggingface.co/metarank) project.
+
+## Dataset format
+
+The dataset is encoded in a JSON-line format, where each row is a single ranking event,
+with all item metadata pre-joined. An example:
+
+
+```json
+{
+  "query": "!qscreen fence without holes",
+  "e": [
+    {
+      "title": "Zippity Outdoor Products ZP19026 Lightweight Portable Vinyl Picket Fence Kit w/Metal Base(42\" H x 92\" W), White",
+      "desc": "..."
+    },
+    {
+      "title": "Sunnyglade 6 feet x 50 feet Privacy Screen Fence Heavy Duty Fencing Mesh Shade Net Cover for Wall Garden Yard Backyard (6 ft X 50 ft, Green)",
+      "desc": "..."
+    },
+    {
+      "title": "Amgo 6' x 50' Black Fence Privacy Screen Windscreen,with Bindings & Grommets, Heavy Duty for Commercial and Residential, 90% Blockage, Cable Zip Ties Included, (Available for Custom Sizes)",
+      "desc": "..."
+    },
+    {
+      "title": "Amgo 4' x 50' Black Fence Privacy Screen Windscreen,with Bindings & Grommets, Heavy Duty for Commercial and Residential, 90% Blockage, Cable Zip Ties Included, (Available for Custom Sizes)",
+      "desc": "..."
+    }
+  ]
+}
+
+```
+
+
+## License
+
+Apache 2.0