Update README.md

README.md

@@ -1,24 +1,64 @@
-!pip install gliner
+# AITSecNER - Entity Recognition for Cybersecurity
 
+This repository demonstrates how to use the **AITSecNER** model hosted on Hugging Face, based on the powerful GLiNER library, to extract cybersecurity-related entities from text.
+
+## Installation
+
+Install GLiNER via pip:
+
+```bash
+pip install gliner
+```
+
+## Usage
+
+### Import and Load Model
+
+Load the pretrained AITSecNER model directly from Hugging Face:
+
+```python
 from gliner import GLiNER
 
-### Load model directly from Hugging Face
 model = GLiNER.from_pretrained("selfconstruct3d/AITSecNER", load_tokenizer=True)
+```
 
+### Predict Entities
+
+Define the input text and entity labels you wish to extract:
+
+```python
+# Example input text
 text = """
-Upon opening Emotet maldocs , victims are greeted with fake Microsoft 365 prompt that states “ THIS DOCUMENT IS PROTECTED , ” and instructs victims on how to enable macros .
+Upon opening Emotet maldocs, victims are greeted with fake Microsoft 365 prompt that states
+“THIS DOCUMENT IS PROTECTED,” and instructs victims on how to enable macros.
 """
 
-### Labels for entity prediction
-labels = ['CLICommand/CodeSnippet','CON','DATE','GROUP','LOC','MALWARE','ORG','SECTOR','TACTIC','TECHNIQUE','TOOL']
+# Entity labels
+labels = [
+    'CLICommand/CodeSnippet', 'CON', 'DATE', 'GROUP', 'LOC',
+    'MALWARE', 'ORG', 'SECTOR', 'TACTIC', 'TECHNIQUE', 'TOOL'
+]
 
-### Perform entity prediction
+# Predict entities
 entities = model.predict_entities(text, labels, threshold=0.5)
 
-### Display predicted entities and their labels
+# Display results
 for entity in entities:
-    print(entity["text"], "=>", entity["label"])
+    print(f"{entity['text']} => {entity['label']}")
+```
+
+### Sample Output
+
+```bash
+Emotet => MALWARE
+Microsoft => ORG
+```
+
+## About
+
+**AITSecNER** leverages GLiNER to quickly and accurately extract cybersecurity-specific entities, making it highly suitable for tasks such as:
+
+- Cyber threat intelligence analysis
+- Incident response documentation
+- Automated cybersecurity reporting
 
-#### Output:
-#### Emotet => MALWARE
-#### Microsoft => ORG