Update README.md

README.md

@@ -1,4 +1,20 @@
 ---
+annotations_creators:
+  - expert-generated
+language:
+  - en
+language_creators:
+  - found
+multilinguality:
+  - monolingual
+size_categories:
+  - 100K<n<1M
+task_categories:
+  - feature-extraction
+  - sentence-similarity
+pretty_name: Quora Duplicate Questions
+tags:
+  - sentence-transformers
 dataset_info:
 - config_name: duplicates
   features:
@@ -54,3 +70,62 @@ configs:
   - split: test
     path: questions/test-*
 ---
+
+# Dataset Card for Quora Duplicate Questions
+
+This dataset contains the [Quora](https://huggingface.co/datasets/quora) Question Pairs dataset in a format that is easily used with the [`ParaphraseMiningEvaluator`](https://sbert.net/docs/package_reference/evaluation.html#sentence_transformers.evaluation.ParaphraseMiningEvaluator) evaluator in Sentence Transformers. The data was originally created by Quora for [this Kaggle Competition](https://www.kaggle.com/c/quora-question-pairs).
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+from sentence_transformers.SentenceTransformer import SentenceTransformer
+from sentence_transformers.evaluation import ParaphraseMiningEvaluator
+
+# Load the Quora Duplicates Mining dataset
+questions_dataset = load_dataset("sentence-transformers/quora-duplicates-mining", "questions", split="dev")
+duplicates_dataset = load_dataset("sentence-transformers/quora-duplicates-mining", "duplicates", split="dev")
+
+# Create a mapping from qid to question & a list of duplicates (qid1, qid2)
+qid_to_questions = dict(zip(questions_dataset["qid"], questions_dataset["question"]))
+duplicates = list(zip(duplicates_dataset["qid1"], duplicates_dataset["qid2"]))
+
+# Initialize the paraphrase mining evaluator
+paraphrase_mining_evaluator = ParaphraseMiningEvaluator(qid_to_questions, duplicates, name="dev")
+
+# Load a model to evaluate
+model = SentenceTransformer("all-MiniLM-L6-v2")
+results = paraphrase_mining_evaluator(model)
+print(results)
+```
+
+## Dataset Subsets
+
+### `questions` subset
+
+* Columns: "question", "qid"
+* Column types: `str`, `str`
+* Examples:
+    ```python
+    {
+      'question': 'How do I prepare for TCS IT Wiz?',
+      'qid': '107646',
+    }
+   ```
+* Collection strategy: A direct copy of the `quora-IR-dataset/duplicate-mining` as generated from [`create_splits.py`](https://github.com/UKPLab/sentence-transformers/tree/master/examples/training/quora_duplicate_questions/create_splits.py).
+* Deduplified: No
+
+### `duplicates` subset
+
+* Columns: "qid1", "qid2"
+* Column types: `str`, `str`
+* Examples:
+    ```python
+    {
+      'qid1': '43345',
+      'qid2': '43346',
+    }
+    ```
+* Collection strategy: A direct copy of the `quora-IR-dataset/duplicate-mining` as generated from [`create_splits.py`](https://github.com/UKPLab/sentence-transformers/tree/master/examples/training/quora_duplicate_questions/create_splits.py).
+* Deduplified: No