Update README.md

README.md

@@ -28,26 +28,26 @@ should probably proofread and complete it, then remove this comment. -->
 
 # requirements_ambiguity_v2
 
-This model is a fine-tuned version of [GroNLP/bert-base-dutch-cased](https://huggingface.co/GroNLP/bert-base-dutch-cased) on an unknown dataset.
+This model is a fine-tuned version of [GroNLP/bert-base-dutch-cased](https://huggingface.co/GroNLP/bert-base-dutch-cased) on a private dataset with 2,523 labeled software requirements for ambiguity detection.
+
+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 the Professional AI Program of the Stanford School of Engineering. 
+
 It achieves the following results on the evaluation set:
 - Loss: 0.7485
 - Accuracy: 0.8458
 - F1: 0.8442
 - Recall: 0.7474
 
-## Model description
-
-More information needed
-
 ## Intended uses & limitations
 
-More information needed
+The model performs automated ambiguity detection through binary text classification. Its intended use is as a tool voor requirements engineers to detect spurious and ambiguous formulations. 
 
 ## Training and evaluation data
 
-More information needed
-
-## Training procedure
+The model was trained on ReqAmbi dataset. This dataset is private and contains 2,523 requirement formulations. Each requirement is manually 
+labeled 0 (unambiguous) or 1 (ambiguous). The dataset is split 2,019/253/253 into train, validation and test. The reported metrics are from the evaluation on the test set. The validation set was used for cross-validation during training.
 
 ### Training hyperparameters