feat: Upload fine-tuned medical NER model OpenMed-ZeroShot-NER-Protein-Small-166M

README.md

@@ -0,0 +1,197 @@
+---
+widget:
+- text: "The Maillard reaction is responsible for the browning of many foods."
+- text: "Casein micelles are the primary protein component of milk."
+- text: "Starch gelatinization is a key process in cooking pasta and rice."
+- text: "Polyphenols in green tea have antioxidant properties."
+- text: "Omega-3 fatty acids are essential fats found in fish oil."
+tags:
+- token-classification
+- entity recognition
+- named-entity-recognition
+- zero-shot
+- zero-shot-ner
+- zero shot
+- biomedical-nlp
+- gliner
+- protein-interactions
+- molecular-biology
+- biochemistry
+- systems-biology
+- protein
+- protein_complex
+- protein_family
+language:
+- en
+license: apache-2.0
+---
+
+# 🧬 [OpenMed-ZeroShot-NER-Protein-Small-166M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Small-166M)
+
+**Specialized model for Biomedical Entity Recognition - Various biomedical entities**
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/Python-3.11%2B-blue)]()
+[![GliNER](https://img.shields.io/badge/🤗-GliNER-yellow)]()
+[![OpenMed](https://img.shields.io/badge/🏥-OpenMed-green)](https://huggingface.co/OpenMed)
+
+## 📋 Model Overview
+
+Focuses on **protein entities** (families, complexes, variants) and related molecular biology terms.Applicable to **protein–protein interaction mining**, **pathway modeling**, and **systems biology**.
+
+OpenMed ZeroShot NER is an advanced, domain-adapted Named Entity Recognition (NER) model designed specifically for medical, biomedical, and clinical text mining. Leveraging state-of-the-art zero-shot learning, this model empowers researchers, clinicians, and data scientists to extract expert-level biomedical entities—such as diseases, chemicals, genes, species, and clinical findings—directly from unstructured text, without the need for task-specific retraining.
+
+Built on the robust GLiNER architecture and fine-tuned on curated biomedical corpora, OpenMed ZeroShot NER delivers high-precision entity recognition for critical healthcare and life sciences applications. Its zero-shot capability means you can flexibly define and extract any entity type relevant to your workflow, from standard biomedical categories to custom clinical concepts, supporting rapid adaptation to new research domains and regulatory requirements.
+
+Whether you are working on clinical NLP, biomedical research, electronic health record (EHR) de-identification, or large-scale literature mining, OpenMed ZeroShot NER provides a production-ready, open-source solution that combines expert-level accuracy with unmatched flexibility. Join the OpenMed community to accelerate your medical text analytics with cutting-edge, zero-shot NER technology.
+
+### 🎯 Key Features
+- **Zero-Shot Capability**: Can recognize any entity type without specific training
+- **High Precision**: Optimized for biomedical entity recognition
+- **Domain-Specific**: Fine-tuned on curated FSU dataset
+- **Production-Ready**: Validated on clinical benchmarks
+- **Easy Integration**: Compatible with Hugging Face Transformers ecosystem
+- **Flexible Entity Recognition**: Add custom entity types without retraining
+
+### 🏷️ Supported Entity Types
+
+This zero-shot model can identify and classify biomedical entities, including but not limited to these entity types. **You can also add custom entity types without retraining the model**:
+
+- `protein`
+- `protein_complex`
+- `protein_enum`
+- `protein_family_or_group`
+- `protein_variant`
+
+**💡 Zero-Shot Flexibility**: As a GliNER-based model, you can specify any entity types you want to detect, even if they weren't part of the original training. Simply provide the entity labels when using the model, and it will adapt to recognize them.
+
+## 📊 Dataset
+
+FSU corpus focuses on protein interactions and molecular biology entities for systems biology research.
+
+The FSU (Florida State University) corpus is a biomedical NER dataset designed for protein interaction recognition and molecular biology entity extraction. This corpus contains annotations for proteins, protein complexes, protein families, protein variants, and molecular interaction entities relevant to systems biology and biochemistry research. The dataset supports the development of text mining systems for protein-protein interaction extraction, molecular pathway analysis, and systems biology applications. It is particularly valuable for identifying protein entities involved in cellular processes, signal transduction pathways, and molecular mechanisms. The corpus serves as a benchmark for evaluating NER systems used in proteomics research, drug discovery, and molecular biology informatics.
+
+
+## 📊 Performance Metrics
+
+### Current Model Performance
+
+- **Finetuned F1 vs. Base Model (on test dataset excluded from training)**: `0.75`
+- **F1 Improvement vs Base Model**: `35.4%`
+
+### 🏆 Top F1 Improvements on FSU Dataset
+
+| Rank | Model | Base F1 | Finetuned F1 | ΔF1 | ΔF1 % |
+|------|-------|--------:|------------:|----:|------:|
+| 🥇 1 | [OpenMed-ZeroShot-NER-Protein-Large-459M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Large-459M) | 0.5612 | 0.9200 | 0.3589 | 63.9% |
+| 🥈 2 | [OpenMed-ZeroShot-NER-Protein-Medium-209M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Medium-209M) | 0.5631 | 0.8995 | 0.3364 | 59.7% |
+| 🥉 3 | [OpenMed-ZeroShot-NER-Protein-XLarge-770M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-XLarge-770M) | 0.5659 | 0.8786 | 0.3127 | 55.3% |
+|  4 | [OpenMed-ZeroShot-NER-Protein-Base-220M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Base-220M) | 0.5230 | 0.8454 | 0.3224 | 61.6% |
+|  5 | [OpenMed-ZeroShot-NER-Protein-Multi-209M](https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Multi-209M) | 0.5441 | 0.7810 | 0.2369 | 43.5% |
+
+
+*Rankings are sorted by finetuned F1 and show ΔF1% over base model. Test dataset is excluded from training.*
+
+![OpenMed ZeroShot Clinical & Biomedical NER vs. Original GLiNER models](https://huggingface.co/spaces/OpenMed/README/resolve/main/openmed-zero-shot-clinical-ner-finetuned.png)
+
+*Figure: OpenMed ZeroShot Clinical & Biomedical NER vs. Original GLiNER models.*
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install gliner==0.2.21
+```
+
+### Usage
+
+```python
+from transformers import pipeline
+
+# Load the model and tokenizer
+# Model: https://huggingface.co/OpenMed/OpenMed-ZeroShot-NER-Protein-Small-166M
+model_name = "OpenMed/OpenMed-ZeroShot-NER-Protein-Small-166M"
+
+from gliner import GLiNER
+model = GLiNER.from_pretrained("OpenMed-ZeroShot-NER-Protein-Small-166M")
+
+# Example usage with default entity types
+text = "The Maillard reaction is responsible for the browning of many foods."
+
+labels = ['protein', 'protein_complex', 'protein_enum', 'protein_family_or_group', 'protein_variant']
+entities = model.predict_entities(text, labels, flat_ner=True, threshold=0.5)
+for entity in entities:
+    print(entity)
+```
+
+### Zero-Shot Usage with Custom Entity Types
+💡 **Tip:** If you want to extract entities that are not present in the original training set (i.e., use custom or rare entity types), you may get better results by lowering the `threshold` parameter in `model.predict_entities`. For example, try `threshold=0.3` or even lower, depending on your use case:
+
+```python
+# You can specify custom entity types for zero-shot recognition - for instance:
+custom_entities = ["MISC", "protein", "PERSON", "LOCATION", "MEDICATION", "PROCEDURE"]
+
+entities = model.predict_entities(text, custom_entities, flat_ner=True, threshold=0.1)
+for entity in entities:
+    print(entity)
+```
+
+> Lowering the threshold makes the model more permissive and can help it recognize new or less common entity types, but may also increase false positives. Adjust as needed for your application.
+
+## 📚 Dataset Information
+
+- **Dataset**: FSU
+- **Description**: Biomedical Entity Recognition - Various biomedical entities
+
+### Training Details
+- **Base Model**: gliner_small-v2.1
+- **Training Framework**: Hugging Face Transformers
+- **Optimization**: AdamW optimizer with learning rate scheduling
+- **Validation**: Cross-validation on held-out test set
+
+## 💡 Use Cases
+
+This model is particularly useful for:
+- **Clinical Text Mining**: Extracting entities from medical records
+- **Biomedical Research**: Processing scientific literature
+- **Drug Discovery**: Identifying chemical compounds and drugs
+- **Healthcare Analytics**: Analyzing patient data and outcomes
+- **Academic Research**: Supporting biomedical NLP research
+- **Custom Entity Recognition**: Zero-shot detection of domain-specific entities
+
+## 🔬 Model Architecture
+
+- **Task**: Zero-Shot Classification (Named Entity Recognition)
+- **Labels**: Dataset-specific entity types
+- **Input**: Biomedical text
+- **Output**: Named entity predictions
+
+## 📜 License
+
+Licensed under the Apache License 2.0. See [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) for details.
+
+## 🤝 Contributing
+
+I welcome contributions of all kinds! Whether you have ideas, feature requests, or want to join my mission to advance open-source Healthcare AI, I'd love to hear from you.
+
+Follow [OpenMed Org](https://huggingface.co/OpenMed) on Hugging Face 🤗 and click "Watch" to stay updated on my latest releases and developments.
+
+## Citation
+
+If you use this model in your research or applications, please cite the following paper:
+
+```latex
+@misc{panahi2025openmedneropensourcedomainadapted,
+      title={OpenMed NER: Open-Source, Domain-Adapted State-of-the-Art Transformers for Biomedical NER Across 12 Public Datasets},
+      author={Maziyar Panahi},
+      year={2025},
+      eprint={2508.01630},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2508.01630},
+}
+```
+
+Proper citation helps support and acknowledge my work. Thank you!
+

added_tokens.json

@@ -0,0 +1,6 @@
+{
+  "<<ENT>>": 128002,
+  "<<SEP>>": 128003,
+  "[FLERT]": 128001,
+  "[MASK]": 128000
+}

gliner_config.json

@@ -0,0 +1,125 @@
+{
+  "class_token_index": 128002,
+  "dropout": 0.4,
+  "embed_ent_token": true,
+  "encoder_config": {
+    "_name_or_path": "microsoft/deberta-v3-small",
+    "add_cross_attention": false,
+    "architectures": null,
+    "attention_probs_dropout_prob": 0.1,
+    "bad_words_ids": null,
+    "begin_suppress_tokens": null,
+    "bos_token_id": null,
+    "chunk_size_feed_forward": 0,
+    "cross_attention_hidden_size": null,
+    "decoder_start_token_id": null,
+    "diversity_penalty": 0.0,
+    "do_sample": false,
+    "early_stopping": false,
+    "encoder_no_repeat_ngram_size": 0,
+    "eos_token_id": null,
+    "exponential_decay_length_penalty": null,
+    "finetuning_task": null,
+    "forced_bos_token_id": null,
+    "forced_eos_token_id": null,
+    "hidden_act": "gelu",
+    "hidden_dropout_prob": 0.1,
+    "hidden_size": 768,
+    "id2label": {
+      "0": "LABEL_0",
+      "1": "LABEL_1"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 3072,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "LABEL_0": 0,
+      "LABEL_1": 1
+    },
+    "layer_norm_eps": 1e-07,
+    "legacy": true,
+    "length_penalty": 1.0,
+    "max_length": 20,
+    "max_position_embeddings": 512,
+    "max_relative_positions": -1,
+    "min_length": 0,
+    "model_type": "deberta-v2",
+    "no_repeat_ngram_size": 0,
+    "norm_rel_ebd": "layer_norm",
+    "num_attention_heads": 12,
+    "num_beam_groups": 1,
+    "num_beams": 1,
+    "num_hidden_layers": 6,
+    "num_return_sequences": 1,
+    "output_attentions": false,
+    "output_hidden_states": false,
+    "output_scores": false,
+    "pad_token_id": 0,
+    "pooler_dropout": 0,
+    "pooler_hidden_act": "gelu",
+    "pooler_hidden_size": 768,
+    "pos_att_type": [
+      "p2c",
+      "c2p"
+    ],
+    "position_biased_input": false,
+    "position_buckets": 256,
+    "prefix": null,
+    "problem_type": null,
+    "pruned_heads": {},
+    "relative_attention": true,
+    "remove_invalid_values": false,
+    "repetition_penalty": 1.0,
+    "return_dict": true,
+    "return_dict_in_generate": false,
+    "sep_token_id": null,
+    "share_att_key": true,
+    "suppress_tokens": null,
+    "task_specific_params": null,
+    "temperature": 1.0,
+    "tf_legacy_loss": false,
+    "tie_encoder_decoder": false,
+    "tie_word_embeddings": true,
+    "tokenizer_class": null,
+    "top_k": 50,
+    "top_p": 1.0,
+    "torch_dtype": null,
+    "torchscript": false,
+    "type_vocab_size": 0,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "vocab_size": 128004
+  },
+  "ent_token": "<<ENT>>",
+  "eval_every": 5000,
+  "fine_tune": true,
+  "fuse_layers": false,
+  "has_rnn": true,
+  "hidden_size": 512,
+  "labels_encoder": null,
+  "labels_encoder_config": null,
+  "lr_encoder": "1e-5",
+  "lr_others": "5e-5",
+  "max_len": 384,
+  "max_neg_type_ratio": 1,
+  "max_types": 25,
+  "max_width": 12,
+  "model_name": "microsoft/deberta-v3-small",
+  "model_type": "gliner",
+  "name": "correct",
+  "num_post_fusion_layers": 1,
+  "num_steps": 30000,
+  "post_fusion_schema": "",
+  "random_drop": true,
+  "sep_token": "<<SEP>>",
+  "shuffle_types": true,
+  "size_sup": -1,
+  "span_mode": "markerV0",
+  "subtoken_pooling": "first",
+  "train_batch_size": 8,
+  "transformers_version": "4.53.2",
+  "vocab_size": 128004,
+  "warmup_ratio": 3000,
+  "words_splitter_type": "whitespace"
+}

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:daa7a99349e7f4b5cb34d14bb61ba89cae38405ef2e5e022a1b74c11a7662cc0
+size 610640455

special_tokens_map.json

@@ -0,0 +1,15 @@
+{
+  "bos_token": "[CLS]",
+  "cls_token": "[CLS]",
+  "eos_token": "[SEP]",
+  "mask_token": "[MASK]",
+  "pad_token": "[PAD]",
+  "sep_token": "[SEP]",
+  "unk_token": {
+    "content": "[UNK]",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  }
+}

spm.model

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c679fbf93643d19aab7ee10c0b99e460bdbc02fedf34b92b05af343b4af586fd
+size 2464616

test_results.json

@@ -0,0 +1,7 @@
+{
+    "eval_loss": 700.858154296875,
+    "seqeval_accuracy": 0.9472953025961622,
+    "seqeval_f1": 0.75,
+    "seqeval_precision": 0.7077999404584698,
+    "seqeval_recall": 0.7975511573297551
+}

tokenizer_config.json

@@ -0,0 +1,83 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "[PAD]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "[CLS]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "[SEP]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "3": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "128000": {
+      "content": "[MASK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "128001": {
+      "content": "[FLERT]",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false,
+      "special": false
+    },
+    "128002": {
+      "content": "<<ENT>>",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false,
+      "special": false
+    },
+    "128003": {
+      "content": "<<SEP>>",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false,
+      "special": false
+    }
+  },
+  "bos_token": "[CLS]",
+  "clean_up_tokenization_spaces": false,
+  "cls_token": "[CLS]",
+  "do_lower_case": false,
+  "eos_token": "[SEP]",
+  "extra_special_tokens": {},
+  "mask_token": "[MASK]",
+  "model_max_length": 1000000000000000019884624838656,
+  "pad_token": "[PAD]",
+  "sep_token": "[SEP]",
+  "sp_model_kwargs": {},
+  "split_by_punct": false,
+  "tokenizer_class": "DebertaV2Tokenizer",
+  "unk_token": "[UNK]",
+  "vocab_type": "spm"
+}