Update README.md

README.md

@@ -1,8 +1,83 @@
 ---
 license: unknown
-language:
-- en
-base_model:
-- microsoft/deberta-v3-base
+base_model: microsoft/deberta-v3-base
+tags:
+- generated_from_trainer
+- medical
+model-index:
+- name: deberta-med-ner-2
+  results: []
+widget:
+- text: A 28-year-old previously healthy man presented with a 6-week history of palpitations.The symptoms occurred during rest, 2–3 times per week, lasted up to 30 minutes at a time and were associated with dyspnea.
+  example_title: Example-1
+- text: A 30-year-old female (65 kg) underwent rhinoplasty under general anaesthesia, which was induced using a combination of a bolus of Remifentanyl (0.5 μg/kg) and Propofol 2 mg/kg.
+  example_title: Example-2
+- text: >-
+    An 18-year-old male was diagnosed with attention-deficit hyperactivity disorder (ADHD) in 2005.He was overweight with a body mass index (BMI) of 40.
+  example_title: example 3
 pipeline_tag: token-classification
----
+---
+
+
+### **BIOMed_NER: Named Entity Recognition for Biomedical Entities**
+
+**Model Overview:**
+BIOMed_NER is a Named Entity Recognition (NER) model which identifies 41 biomedical entities using DeBERTaV3. This model is useful for extracting structured information from clinical text, such as diseases, procedures, medications, and anatomical terms.
+
+**Hyperparameters:**
+- **Base Model**: `microsoft/deberta-v3-base`
+- **Learning Rate**: `3e-5`
+- **Batch Size**: `8`
+- **Gradient Accumulation Steps**: `2`
+- **Scheduler**: Cosine schedule with warmup
+- **Epochs**: `30`
+- **Optimizer**: AdamW with betas `(0.9, 0.999)` and epsilon `1e-8`
+
+**How to Use the Model for Inference:**
+
+You can use the Hugging Face `pipeline` for easy inference:
+
+```python
+from transformers import pipeline
+
+# Load the model
+model_path = "venkatd/BIOMed_NER"
+pipe = pipeline(
+    task="token-classification",
+    model=model_path,
+    tokenizer=model_path,
+    aggregation_strategy="simple"
+)
+
+# Test the pipeline
+text = ("A 48-year-old female presented with vaginal bleeding and abnormal Pap smears. "
+        "Upon diagnosis of invasive non-keratinizing SCC of the cervix, she underwent a radical "
+        "hysterectomy with salpingo-oophorectomy which demonstrated positive spread to the pelvic "
+        "lymph nodes and the parametrium.")
+result = pipe(text)
+print(result)
+```
+
+**Output Example:**
+
+The output will be a list of recognized entities with their entity type, score, and start/end positions in the text. Here’s a sample output format:
+
+```json
+[
+    {
+        "entity_group": "Disease_disorder",
+        "score": 0.98,
+        "word": "SCC of the cervix",
+        "start": 63,
+        "end": 80
+    },
+    ...
+]
+```
+
+**Use Cases:**
+- Extracting clinical information from unstructured text in medical records.
+- Structuring data for downstream biomedical research or applications.
+- Assisting healthcare professionals by highlighting relevant biomedical entities.
+
+This model is publicly available on Hugging Face and can be easily integrated into applications for medical text analysis.