Update README.md

README.md

@@ -27,13 +27,16 @@ model-index:
         value: 0.588
         name: F1-score
 ---
-# 🔑 Keyphrase Extraction model: KBIR-inspec
-Keyphrase extraction is a technique in text analysis where you extract the important keyphrases from a text. Since this is a time-consuming process, Artificial Intelligence is used to automate it. Currently, classical machine learning methods, that use statistics and linguistics, are widely used for the extraction process. The fact that these methods have been widely used in the community has the advantage that there are many easy-to-use libraries. Now with the recent innovations in NLP, transformers can be used to improve keyphrase extraction. Transformers also focus on the semantics and context of a document, which is quite an improvement.
+# 🔑 Keyphrase Extraction Model: KBIR-inspec
+Keyphrase extraction is a technique in text analysis where you extract the important keyphrases from a document. Thanks to these keyphrases humans can understand the content of a text very quickly and easily without reading it completely. Keyphrase extraction was first done primarily by human annotators, who read the text in detail and then wrote down the most important keyphrases. The disadvantage is that if you work with a lot of documents, this process can take a lot of time ⏳. 
+
+Here is where Artificial Intelligence 🤖 comes in. Currently, classical machine learning methods, that use statistical and linguistic features, are widely used for the extraction process. Now with deep learning, it is possible to capture the semantic meaning of a text even better than these classical methods. Classical methods look at the frequency, occurrence and order of words in the text, whereas these neural approaches can capture long-term semantic dependencies and context of words in a text.
+
 
 
 ## 📓 Model Description
-This model is a fine-tuned KBIR model on the Inspec dataset. KBIR or Keyphrase Boundary Infilling with Replacement is a pre-trained model which utilizes a multi-task learning setup for optimizing a combined loss of Masked Language Modeling (MLM), Keyphrase Boundary Infilling (KBI) and Keyphrase Replacement Classification (KRC).
-You can find more information about the architecture in this paper: https://arxiv.org/abs/2112.08547.
+This model uses [KBIR](https://huggingface.co/bloomberg/KBIR) as its base model and fine-tunes it on the [Inspec dataset](https://huggingface.co/datasets/midas/inspec). KBIR or Keyphrase Boundary Infilling with Replacement is a pre-trained model which utilizes a multi-task learning setup for optimizing a combined loss of Masked Language Modeling (MLM), Keyphrase Boundary Infilling (KBI) and Keyphrase Replacement Classification (KRC).
+You can find more information about the architecture in this [paper](https://arxiv.org/abs/2112.08547).
 
 The model is fine-tuned as a token classification problem where the text is labeled using the BIO scheme.
 
@@ -47,13 +50,13 @@ Kulkarni, Mayank, Debanjan Mahata, Ravneet Arora, and Rajarshi Bhowmik. "Learnin
 
 Sahrawat, Dhruva, Debanjan Mahata, Haimin Zhang, Mayank Kulkarni, Agniv Sharma, Rakesh Gosangi, Amanda Stent, Yaman Kumar, Rajiv Ratn Shah, and Roger Zimmermann. "Keyphrase extraction as sequence labeling using contextualized embeddings." In European Conference on Information Retrieval, pp. 328-335. Springer, Cham, 2020.
 
-## ✋ Intended uses & limitations
+## ✋ Intended Uses & Limitations
 ### 🛑 Limitations
 * This keyphrase extraction model is very domain-specific and will perform very well on abstracts of scientific papers. It's not recommended to use this model for other domains, but you are free to test it out.
 * Only works for English documents.
-* For a custom model, please consult the training notebook for more information (link incoming).
+* For a custom model, please consult the [training notebook]() for more information.
 
-### ❓ How to use
+### ❓ How To Use
 ```python
 from transformers import (
     TokenClassificationPipeline,
@@ -86,6 +89,7 @@ class KeyphraseExtractionPipeline(TokenClassificationPipeline):
 # Load pipeline
 model_name = "ml6team/keyphrase-extraction-kbir-inspec"
 extractor = KeyphraseExtractionPipeline(model=model_name)
+
 ```
 ```python
 # Inference
@@ -97,32 +101,30 @@ are widely used for the extraction process. The fact that these methods have bee
 has the advantage that there are many easy-to-use libraries. Now with the recent innovations in NLP, 
 transformers can be used to improve keyphrase extraction. Transformers also focus on the semantics 
 and context of a document, which is quite an improvement.
-""".replace(
-    "\n", ""
-)
+"""
 
 keyphrases = extractor(text)
 
 print(keyphrases)
+
 ```
 
 ```
 # Output
-['Artificial Intelligence', 'Keyphrase extraction', 'NLP',
- 'classical machine learning', 'keyphrase extraction',
- 'linguistics', 'semantics', 'statistics', 'text analysis',
- 'transformers']
+['Artificial Intelligence' 'Keyphrase extraction' 'NLP'
+ 'keyphrase extraction' 'linguistics' 'machine learning' 'semantics'
+ 'statistics' 'text analysis']
 ```
 
 ## 📚 Training Dataset
-Inspec is a keyphrase extraction/generation dataset consisting of 2000 English scientific papers from the scientific domains of Computers and Control and Information Technology published between 1998 to 2002. The keyphrases are annotated by professional indexers or editors.
+[Inspec](https://huggingface.co/datasets/midas/inspec) is a keyphrase extraction/generation dataset consisting of 2000 English scientific papers from the scientific domains of Computers and Control and Information Technology published between 1998 to 2002. The keyphrases are annotated by professional indexers or editors.
 
-You can find more information here: https://huggingface.co/datasets/midas/inspec
+You can find more information in the [paper](https://dl.acm.org/doi/10.3115/1119355.1119383).
 
-## 👷‍♂️ Training procedure
-For more in detail information, you can take a look at the training notebook (link incoming).
+## 👷‍♂️ Training Procedure
+For more in detail information, you can take a look at the [training notebook]().
 
-### Training parameters
+### Training Parameters
 
 | Parameter | Value |
 | --------- | ------|
@@ -132,12 +134,26 @@ For more in detail information, you can take a look at the training notebook (li
 
 ### Preprocessing
 The documents in the dataset are already preprocessed into list of words with the corresponding labels. The only thing that must be done is tokenization and the realignment of the labels so that they correspond with the right subword tokens.
+
 ```python
+from datasets import load_dataset
+from transformers import AutoTokenizer
+
 # Labels
 label_list = ["B", "I", "O"]
 lbl2idx = {"B": 0, "I": 1, "O": 2}
 idx2label = {0: "B", 1: "I", 2: "O"}
 
+# Tokenizer
+tokenizer = AutoTokenizer.from_pretrained("bloomberg/KBIR", add_prefix_space=True)
+max_length = 512
+
+# Dataset parameters
+dataset_full_name = "midas/inspec"
+dataset_subset = "raw"
+dataset_document_column = "document"
+dataset_biotags_column = "doc_bio_tags"
+
 def preprocess_fuction(all_samples_per_split):
     tokenized_samples = tokenizer.batch_encode_plus(
         all_samples_per_split[dataset_document_column],
@@ -171,10 +187,17 @@ def preprocess_fuction(all_samples_per_split):
         total_adjusted_labels.append(adjusted_label_ids)
     tokenized_samples["labels"] = total_adjusted_labels
     return tokenized_samples
+
+# Load dataset
+dataset = load_dataset(dataset_full_name, dataset_subset)
+
+# Preprocess dataset
+tokenized_dataset = dataset.map(preprocess_fuction, batched=True)
+    
 ```
 
 ### Postprocessing
-For the post-processing, you will need to filter out the B and I labeled tokens and concat the consecutive Bs and Is. As last you strip the keyphrase to ensure all spaces are removed.
+For the post-processing, you will need to filter out the B and I labeled tokens and concat the consecutive Bs and Is. As last you strip the keyphrases to ensure all spaces are removed.
 ```python
 # Define post_process functions
 def concat_tokens_by_tag(keyphrases):
@@ -208,14 +231,14 @@ def extract_keyphrases(example, predictions, tokenizer, index=0):
 ```
 ## 📝 Evaluation results
 
-One of the traditional evaluation methods is the precision, recall and F1-score @k,m where k is the number that stands for the first k predicted keyphrases and m for the average amount of predicted keyphrases.
+Traditional evaluation methods are the precision, recall and F1-score @k,m where k is the number that stands for the first k predicted keyphrases and m for the average amount of predicted keyphrases.
 The model achieves the following results on the Inspec test set:
 
 | Dataset           | P@5  | R@5  | F1@5 | P@10 | R@10 | F1@10 | P@M  | R@M  | F1@M |
 |:-----------------:|:----:|:----:|:----:|:----:|:----:|:-----:|:----:|:----:|:----:|
 | Inspec Test Set   | 0.53 | 0.47 | 0.46 | 0.36 | 0.58 | 0.41  | 0.58 | 0.60 | 0.56 |
 
-For more information on the evaluation process, you can take a look at the keyphrase extraction evaluation notebook.
+For more information on the evaluation process, you can take a look at the keyphrase extraction [evaluation notebook]().
 
 ## 🚨 Issues
 Please feel free to start discussions in the Community Tab.