Upload README.md

README.md

@@ -0,0 +1,133 @@
+## Dataset Summary
+
+A dataset for benchmarking keyphrase extraction and generation techniques from english news articles. For more details about the dataset please refer the original paper - [https://dl.acm.org/doi/10.5555/1859664.1859668](https://dl.acm.org/doi/10.5555/1859664.1859668)
+
+Original source of the data - [https://github.com/LIAAD/KeywordExtractor-Datasets/blob/master/datasets/SemEval2010.zip](https://github.com/LIAAD/KeywordExtractor-Datasets/blob/master/datasets/SemEval2010.zip)
+
+
+## Dataset Structure
+
+
+### Data Fields
+
+- **id**: unique identifier of the document.
+- **document**: Whitespace separated list of words in the document.
+- **doc_bio_tags**: BIO tags for each word in the document. B stands for the beginning of a keyphrase and I stands for inside the keyphrase. O stands for outside the keyphrase and represents the word that isn't a part of the keyphrase at all.
+- **extractive_keyphrases**: List of all the present keyphrases.
+- **abstractive_keyphrase**: List of all the absent keyphrases.
+
+
+### Data Splits
+
+|Split| #datapoints  |
+|--|--|
+| Test | 243 |
+
+
+## Usage
+
+### Full Dataset
+
+```python
+from datasets import load_dataset
+
+# get entire dataset
+dataset = load_dataset("midas/semeval2010", "raw")
+
+# sample from the train split
+print("Sample from train dataset split")
+test_sample = dataset["train"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Document BIO Tags: ", test_sample["doc_bio_tags"])
+print("Extractive/present Keyphrases: ", test_sample["extractive_keyphrases"])
+print("Abstractive/absent Keyphrases: ", test_sample["abstractive_keyphrases"])
+print("\n-----------\n")
+
+# sample from the test split
+print("Sample from test dataset split")
+test_sample = dataset["test"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Document BIO Tags: ", test_sample["doc_bio_tags"])
+print("Extractive/present Keyphrases: ", test_sample["extractive_keyphrases"])
+print("Abstractive/absent Keyphrases: ", test_sample["abstractive_keyphrases"])
+print("\n-----------\n")
+```
+**Output**
+
+```bash
+
+```
+
+### Keyphrase Extraction
+```python
+from datasets import load_dataset
+
+# get the dataset only for keyphrase extraction
+dataset = load_dataset("midas/semeval2010", "extraction")
+
+print("Samples for Keyphrase Extraction")
+
+# sample from the train split
+print("Sample from train data split")
+test_sample = dataset["train"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Document BIO Tags: ", test_sample["doc_bio_tags"])
+print("\n-----------\n")
+
+# sample from the test split
+print("Sample from test data split")
+test_sample = dataset["test"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Document BIO Tags: ", test_sample["doc_bio_tags"])
+print("\n-----------\n")
+```
+
+### Keyphrase Generation
+```python
+# get the dataset only for keyphrase generation
+dataset = load_dataset("midas/semeval2010", "generation")
+
+print("Samples for Keyphrase Generation")
+
+# sample from the train split
+print("Sample from train data split")
+test_sample = dataset["train"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Extractive/present Keyphrases: ", test_sample["extractive_keyphrases"])
+print("Abstractive/absent Keyphrases: ", test_sample["abstractive_keyphrases"])
+print("\n-----------\n")
+
+# sample from the test split
+print("Sample from test data split")
+test_sample = dataset["test"][0]
+print("Fields in the sample: ", [key for key in test_sample.keys()])
+print("Tokenized Document: ", test_sample["document"])
+print("Extractive/present Keyphrases: ", test_sample["extractive_keyphrases"])
+print("Abstractive/absent Keyphrases: ", test_sample["abstractive_keyphrases"])
+print("\n-----------\n")
+```
+
+## Citation Information
+```
+@inproceedings{10.5555/1859664.1859668,
+author = {Kim, Su Nam and Medelyan, Olena and Kan, Min-Yen and Baldwin, Timothy},
+title = {SemEval-2010 Task 5: Automatic Keyphrase Extraction from Scientific Articles},
+year = {2010},
+publisher = {Association for Computational Linguistics},
+address = {USA},
+abstract = {This paper describes Task 5 of the Workshop on Semantic Evaluation 2010 (SemEval-2010). Systems are to automatically assign keyphrases or keywords to given scientific articles. The participating systems were evaluated by matching their extracted keyphrases against manually assigned ones. We present the overall ranking of the submitted systems and discuss our findings to suggest future directions for this task.},
+booktitle = {Proceedings of the 5th International Workshop on Semantic Evaluation},
+pages = {21–26},
+numpages = {6},
+location = {Los Angeles, California},
+series = {SemEval '10}
+}
+```
+
+## Contributions
+Thanks to [@debanjanbhucs](https://github.com/debanjanbhucs), [@dibyaaaaax](https://github.com/dibyaaaaax) and [@ad6398](https://github.com/ad6398) for adding this dataset