Update README.md

README.md

@@ -1,3 +1,50 @@
----
-license: mit
----
+---
+language:
+- en
+multilinguality:
+- monolingual
+size_categories:
+- <1K
+task_categories:
+- feature-extraction
+- sentence-similarity
+pretty_name: ms-marco-mini
+tags:
+- sentence-transformers
+- colbert
+- lightonai
+dataset_info:
+- config_name: triplet
+  features:
+  - name: query
+    dtype: string
+  - name: positive
+    dtype: string
+  - name: negative
+    dtype: string
+  splits:
+  - name: train
+    num_examples: 30
+configs:
+- config_name: triplet
+  data_files:
+  - split: train
+    path: triplet/train-*
+---
+
+# ms-marco-mini
+
+This dataset gathers 30 triplets [MS MARCO](https://microsoft.github.io/msmarco/) to provide an example of triplet-based dataset formatting.
+
+#### `triplet` subset
+
+* Columns: "query", "positive", "negative"
+* Column types: `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      "query": "what are the liberal arts?",
+      "positive": 'liberal arts. 1. the academic course of instruction at a college intended to provide general knowledge and comprising the arts, humanities, natural sciences, and social sciences, as opposed to professional or technical subjects.',
+      "negative": 'The New York State Education Department requires 60 Liberal Arts credits in a Bachelor of Science program and 90 Liberal Arts credits in a Bachelor of Arts program. In the list of course descriptions, courses which are liberal arts for all students are identified by (Liberal Arts) after the course number.'
+    }
+    ```