Update README.md

README.md

@@ -9,7 +9,17 @@ datasets:
 metrics:
 - seqeval
 widget:
-- text: "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."
+- text: "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."
   example_title: "Example 1"
 - text: "FoodEx is the largest trade exhibition for food and drinks in Asia, with about 70,000 visitors checking out the products presented by hundreds of participating companies. I was lucky to enter as press; otherwise, visitors must be affiliated with the food industry— and pay ¥5,000 —  to enter. The FoodEx menu is global, including everything from cherry beer from Germany and premium Mexican tequila to top-class French and Chinese dumplings. The event was a rare chance to try out both well-known and exotic foods and even see professionals making them. In addition to booths offering traditional Japanese favorites such as udon and maguro sashimi, there were plenty of innovative twists, such as dorayaki , a sweet snack made of two pancakes and a red-bean filling, that came in coffee and tomato flavors. While I was there I was lucky to catch the World Sushi Cup Japan 2013, where top chefs from around the world were competing … and presenting a wide range of styles that you would not normally see in Japan, like the flower makizushi above."
   example_title: "Example 2"
@@ -23,18 +33,23 @@ model-index:
       type: midas/kptimes
       name: kptimes
     metrics:
-      - type: seqeval 
+      - type: F1 (Seqeval) 
         value: 0.539
-        name: F1-score
+        name: F1 (Seqeval)
+      - type: F1@M
+        value: 0.328
+        name: F1@M        
 ---
-# 🔑 Keyphrase Extraction model: distilbert-kptimes
-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: distilbert-kptimes
+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 distilbert model on the KPTimes dataset. More information can be found here: https://huggingface.co/distilbert-base-uncased.
+This model uses [KBIR](https://huggingface.co/distilbert-base-uncased) as its base model and fine-tunes it on the [KPTimes dataset](https://huggingface.co/datasets/midas/kptimes). 
 
-The model is fine-tuned as a token classification problem where the text is labeled using the BIO scheme.
+Keyphrase extraction models are transformer models fine-tuned as a token classification problem where each word in the document is classified as being part of a keyphrase or not.
 
 | Label | Description                     |
 | ----- | ------------------------------- |
@@ -42,14 +57,14 @@ The model is fine-tuned as a token classification problem where the text is labe
 | I-KEY | Inside a keyphrase              |
 | O     | Outside a keyphrase             |
 
-## ✋ Intended uses & limitations
+## ✋ Intended Uses & Limitations
 ### 🛑 Limitations
 * This keyphrase extraction model is very domain-specific and will perform very well on news articles from NY Times. It's not recommended to use this model for other domains, but you are free to test it out.
 * Limited amount of predicted keyphrases.
 * 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,
@@ -72,7 +87,7 @@ class KeyphraseExtractionPipeline(TokenClassificationPipeline):
     def postprocess(self, model_outputs):
         results = super().postprocess(
             model_outputs=model_outputs,
-            aggregation_strategy=AggregationStrategy.SIMPLE,
+            aggregation_strategy=AggregationStrategy.FIRST,
         )
         return np.unique([result.get("word").strip() for result in results])
 
@@ -86,20 +101,27 @@ extractor = KeyphraseExtractionPipeline(model=model_name)
 ```python
 # Inference
 text = """
-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.
-""".replace(
-    "\n", ""
-)
+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.
+""".replace("\n", " ")
 
 keyphrases = extractor(text)
 
 print(keyphrases)
+
 ```
 
 ```
@@ -113,7 +135,7 @@ KPTimes is a keyphrase extraction/generation dataset consisting of 279,923 news
 You can find more information here: https://huggingface.co/datasets/midas/kptimes
 
 ## 👷‍♂️ Training procedure
-For more in detail information, you can take a look at the training notebook (link incoming).
+For more in detail information, you can take a look at the [training notebook]().
 
 ### Training parameters
 
@@ -125,7 +147,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("distilbert-base-uncased", add_prefix_space=True)
+max_length = 512
+
+# Dataset parameters
+dataset_full_name = "midas/kptimes"
+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],
@@ -159,10 +200,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.
+### Postprocessing (Without Pipeline Function)
+If you do not use the pipeline function, you must filter out the B and I labeled tokens. Each B and I will then be merged into a keyphrase. Finally, you need to strip the keyphrases to make sure all unnecessary spaces have been removed.
 ```python
 # Define post_process functions
 def concat_tokens_by_tag(keyphrases):
@@ -194,16 +242,17 @@ def extract_keyphrases(example, predictions, tokenizer, index=0):
     return np.unique([kp.strip() for kp in extracted_kps])
 
 ```
-## 📝 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.
+## 📝 Evaluation Results
+
+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 KPTimes test set:
 
 | Dataset           | P@5  | R@5  | F1@5 | P@10 | R@10 | F1@10 | P@M  | R@M  | F1@M |
 |:-----------------:|:----:|:----:|:----:|:----:|:----:|:-----:|:----:|:----:|:----:|
 | KPTimes Test Set  | 0.19 | 0.36 | 0.23 | 0.10 | 0.37 | 0.15  | 0.35 | 0.37 | 0.33 |
 
-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.