Update README.md

README.md

@@ -16,7 +16,7 @@ The model supports the recognition of multiple skill categories, including techn
 
 
 ## How to Use
-You can use the Nucha/Nucha_SkillNER_BERT model for Named Entity Recognition (NER) by loading it directly from Hugging Face's transformers library. Below is an example of how to use the model with the pipeline API for entity extraction.
+You can use the **Nucha/Nucha_SkillNER_BERT** model for Named Entity Recognition (NER) by loading it directly from Hugging Face's **transformers** library. Below is an example of how to use the model with the **pipeline** API for entity extraction.
 ### Step-by-Step Example:
 ```python
 # Libraly
@@ -44,14 +44,29 @@ for entity in ner_results:
 ```
 ### Output Explanation:
 - Entity: This is the word or phrase identified in the text that matches one of the model's recognized categories.
-- Label: The classification label assigned to the entity, such as ** SKILL ** or ** TECHNOLOGY ** .
+- Label: The classification label assigned to the entity, such as **SKILL** or **TECHNOLOGY** .
 - Score: The confidence score of the model for the identified entity, represented as a floating-point number.
 
 ## Demo
+The **Nucha/Nucha_SkillNER_BERT** model is designed for Named Entity Recognition (NER) specifically targeting skill-related entities in text. This demo allows users to input any text and see how well the model identifies different skills.
 https://huggingface.co/spaces/Nucha/NuchaSkillNER
 
+### How to Use:
+- Input Text: Enter any text that contains information about skills or related topics. For example, you can input job descriptions, resumes, or any relevant text.
+- Analyze: Click the "Analyze" button to run the model on the provided text. The model will process the input and extract named entities, specifically skills.
+- Results: The output will display the recognized entities along with their labels and confidence scores. The labels will indicate the type of skills identified (e.g., programming languages, frameworks, tools).
+
+
 ## Evaluation
-You can employ this model using the Transformers library's *pipeline* for NER, or incorporate it as a conventional Transformer in the HuggingFace ecosystem.
+The **Nucha/Nucha_SkillNER_BERT** model has undergone rigorous evaluation to ensure its effectiveness in Named Entity Recognition (NER) tasks, specifically in identifying and categorizing skills relevant to various domains. The evaluation was conducted on a diverse set of datasets designed to reflect real-world scenarios.
+
+### Metrics
+The model's performance was assessed using standard NER metrics:
+
+- **Accuracy**: Measures the overall correctness of the model's predictions.
+- **Precision**: Indicates the proportion of true positive results in the total predicted positives.
+- **Recall**: Reflects the ability of the model to find all relevant instances in the dataset.
+- **F1 Score**: The harmonic mean of precision and recall, providing a single score that balances both metrics.
 
 ```
                 precision   recall    f1-score  support
@@ -97,4 +112,7 @@ You can employ this model using the Transformers library's *pipeline* for NER, o
 ...
 
 ]
-```
+```
+
+## Conclusion
+The **Nucha/Nucha_SkillNER_BERT** model demonstrates strong performance in identifying skills in text data, making it a valuable tool for applications in recruitment, resume screening, and skill extraction tasks. Continuous improvements and further evaluations will enhance its accuracy and adaptability to specific use cases.