Update README.md

README.md

@@ -1,5 +1,5 @@
 ---
-license: mit
+license: cc-by-nc-sa-4.0
 tags:
 - generated_from_trainer
 metrics:
@@ -11,17 +11,30 @@ model-index:
 - name: req_mod_ner_modelv2
   results: []
 widget:
-- text: "De Oplossing ondersteunt het zoeken op de metadata van zaken, documenten en objecten en op gegevens uit de basisregistraties die gekoppeld zijn aan een zaak."
-- text: "De Oplossing ondersteunt parafering en het plaatsen van een gecertificeerde elektronische handtekening."
-- text: "De Aangeboden oplossing stelt de medewerker in staat een zaak te registreren."
-- text: "Het Financieel systeem heeft functionaliteit om een debiteurenadministratie te voeren."
-- text: "Als gebruiker wil ik dat de oplossing mij naar zaken laat zoeken op basis van zaaknummer, zaaktitel, omschrijving en datum."
+- text: >-
+    De Oplossing ondersteunt het zoeken op de metadata van zaken, documenten en
+    objecten en op gegevens uit de basisregistraties die gekoppeld zijn aan een
+    zaak.
+- text: >-
+    De Oplossing ondersteunt parafering en het plaatsen van een gecertificeerde
+    elektronische handtekening.
+- text: >-
+    De Aangeboden oplossing stelt de medewerker in staat een zaak te
+    registreren.
+- text: >-
+    Het Financieel systeem heeft functionaliteit om een debiteurenadministratie
+    te voeren.
+- text: >-
+    Als gebruiker wil ik dat de oplossing mij naar zaken laat zoeken op basis
+    van zaaknummer, zaaktitel, omschrijving en datum.
+language:
+- nl
 ---
 
 
 # req_mod_ner_modelv2
 
-This model is a fine-tuned version of [pdelobelle/robbert-v2-dutch-ner](https://huggingface.co/pdelobelle/robbert-v2-dutch-ner) on a private dataset with 300 sentences/phrases with 1954 token labels (IOB2 format) aimed at extracting software requirement related named entities. The following labels are used:
+This model is a fine-tuned version of [pdelobelle/robbert-v2-dutch-ner](https://huggingface.co/pdelobelle/robbert-v2-dutch-ner) on a private dataset with 300 sentences/phrases with 1,954 token labels (IOB2 format) aimed at extracting software requirement related named entities. The following labels are used:
 - Actor (used for all types of software users and groups of users)
 - COTS (abbreviation for Commercial Off-The-Shelf Software)
 - Function (used for functions, functionality, features)
@@ -29,7 +42,11 @@ This model is a fine-tuned version of [pdelobelle/robbert-v2-dutch-ner](https://
 - Entity (used for all entities stored/processed by the software)
 - Attribute (used for attributes of entities)
 
-It achieves the following results on the evaluation set:
+Please contact me via [LinkedIn](https://www.linkedin.com/in/denizayhan/) if you have any questions about this model or the dataset used. 
+
+The dataset and this model were created as part of the final project assignment of the Natural Language Understanding course (XCS224U) from Professional AI Program of the Stanford School of Engineering. 
+
+The model achieves the following results on the evaluation set:
 - Loss: 0.6791
 - Precision: 0.7515
 - Recall: 0.7299
@@ -47,17 +64,14 @@ It achieves the following results on the evaluation set:
 | Entity    | 0.78      | 0.83   | 0.81 | 35      | 
 | Attribute | 0.92      | 0.71   | 0.80 | 31      | 
 
-## Model description
-
-More information needed
 
 ## Intended uses & limitations
 
-More information needed
+The model performs automated extraction of functionality concepts from source documents for which software requirements are needed. Its intended use is as a preceding processing step for Question-Answering. 
 
 ## Training and evaluation data
 
-More information needed
+The model was trained on the req_mod_ner dataset. This dataset is private and contains 300 sentences/phrases and 1,954 IOB2 labels. 
 
 ## Training procedure
 
@@ -99,4 +113,4 @@ The following hyperparameters were used during training:
 - Transformers 4.24.0
 - Pytorch 2.0.0
 - Datasets 2.9.0
-- Tokenizers 0.11.0
+- Tokenizers 0.11.0