Update README.md

README.md

@@ -22,6 +22,12 @@ model-index:
       - type: F1-Score         
         value: 90.709
         name: Test F1-Score              
+
+---
+# To Update
+
+[AUTHORS] "[PAPER NAME]". [PAPER DETAILS] [PAPER LINK]
+
 ---
 Indian Legal Named Entity Recognition: Identifying relevant entities in an Indian legal document
 
@@ -37,15 +43,57 @@ Indian Legal Named Entity Recognition: Identifying relevant entities in an India
 | **License** | `MIT` |
 | **Author** | [Aman Tiwari](https://www.linkedin.com/in/amant555/) |
 
+## Load Pretrained Model
+
+Install the model using pip
+
+```sh
+pip install https://huggingface.co/opennyaiorg/en_legal_ner_trf/resolve/main/en_legal_ner_trf-any-py3-none-any.whl
+```
+
+Using pretrained NER model
+
+```python
+# Using spacy.load().
+import spacy
+nlp = spacy.load("en_legal_ner_trf")
+text = "Section 319 Cr.P.C. contemplates a situation where the evidence adduced by the prosecution for Respondent No.3-G. Sambiah on 20th June 1984"
+doc = nlp(text)
+
+# Print indentified entites
+for ent in doc.ents:
+     print(ent,ent.label_)
+
+##OUTPUT     
+#Section 319 PROVISION
+#Cr.P.C. STATUTE
+#G. Sambiah RESPONDENT
+#20th June 1984 DATE
+```
+
+
 ### Label Scheme
 
 <details>
 
 <summary>View label scheme (14 labels for 1 components)</summary>
 
-| Component | Labels |
+| ENTITY | BELONGS TO |
 | --- | --- |
-| **`ner`** | `CASE_NUMBER`, `COURT`, `DATE`, `GPE`, `JUDGE`, `LAWYER`, `ORG`, `OTHER_PERSON`, `PETITIONER`, `PRECEDENT`, `PROVISION`, `RESPONDENT`, `STATUTE`, `WITNESS` |
+| `LAWYER` | PREAMBLE |
+| `COURT` | PREAMBLE, JUDGEMENT |
+| `JUDGE` | PREAMBLE, JUDGEMENT |
+| `PETITIONER` | PREAMBLE, JUDGEMENT |
+| `RESPONDENT` | PREAMBLE, JUDGEMENT |
+| `CASE_NUMBER` | JUDGEMENT | 
+| `GPE` | JUDGEMENT |
+| `DATE` | JUDGEMENT |
+| `ORG` | JUDGEMENT |
+| `STATUTE` | JUDGEMENT |
+| `WITNESS` | JUDGEMENT |
+| `PRECEDENT` | JUDGEMENT |
+| `PROVISION` | JUDGEMENT |
+| `OTHER_PERSON` | JUDGEMENT |
 
 </details>
 
@@ -56,3 +104,10 @@ Indian Legal Named Entity Recognition: Identifying relevant entities in an India
 | **F1-Score** | **90.709** |
 | `Precision` | 91.474 |
 | `Recall` | 89.956 |
+
+
+## Author - Publication
+
+```
+[CITATION DETAILS]
+```