Duplicate from zilliz/semantic-highlight-bilingual-v1

Co-authored-by: Cheney Zhang <zc277584121@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,36 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+tokenizer.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,234 @@
+---
+license: mit
+language:
+- zh
+- en
+metrics:
+- f1
+base_model:
+- BAAI/bge-reranker-v2-m3
+tags:
+- RAG
+- highlight
+- context-pruning
+- context-engineering
+- semantic-highlight
+datasets:
+- zilliz/msmarco-context-relevance-with-think
+- zilliz/natural_questions-context-relevance-with-think
+- zilliz/gooaq-context-relevance-130k-context-relevance-with-think
+- zilliz/wikipedia_zh_cn_500k-context-relevance-with-think
+- zilliz/mmarco_chinese_200k-context-relevance-with-think
+- zilliz/dureader-context-relevance-with-think
+pipeline_tag: token-classification
+---
+# Semantic Highlight Bilingual Model
+
+## What is Semantic Highlight?
+
+![Traditional Highlight vs Semantic Highlight](https://zc277584121.github.io/images/highlight-preview/traditional_vs_semantic_highlight.png)
+Traditional search highlighting works by matching keywords. When you search for "iPhone performance" on an e-commerce site, only the words "iPhone" and "performance" get highlighted in the results. But what if the product description says "Powered by A15 Bionic chip, scores over 1 million in benchmarks, smooth performance with no lag"? This clearly answers the performance question, yet nothing gets highlighted because it doesn't contain the exact word "performance".
+
+**Semantic Highlight** solves this problem by understanding meaning, not just matching words. It highlights text segments that are semantically relevant to your query, even if they don't contain the exact keywords. This is crucial in RAG (Retrieval-Augmented Generation) scenarios where users need to quickly identify relevant information in long retrieved documents.
+
+For more technical details, check out our blog here: https://huggingface.co/blog/zilliz/zilliz-semantic-highlight-model
+
+### Why a Lightweight Model?
+
+Highlighting happens on every search query - it needs to be fast and cost-effective. Large language models would be too slow and expensive for this real-time task. This model is designed to be:
+- **Small**: ~0.6B, deployable on standard servers
+- **Fast**: Millisecond-level inference
+- **Accurate**: Trained on context-relevance datasets
+
+## Model Details
+
+- **Base Model**: BAAI/bge-reranker-v2-m3
+- **Languages**: Chinese and English
+- **Task**: Context relevance prediction for semantic highlighting, almost the same as context pruning
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install transformers torch
+```
+
+### Usage
+
+#### English Example
+
+```python
+from transformers import AutoModel
+
+model = AutoModel.from_pretrained(
+    "zilliz/semantic-highlight-bilingual-v1",
+    trust_remote_code=True
+)
+
+question = "What are the symptoms of dehydration?"
+context = """
+Dehydration occurs when your body loses more fluid than you take in.
+Common signs include feeling thirsty and having a dry mouth.
+The human body is composed of about 60% water.
+Dark yellow urine and infrequent urination are warning signs.
+Water is essential for many bodily functions.
+Dizziness, fatigue, and headaches can indicate severe dehydration.
+Drinking 8 glasses of water daily is often recommended.
+"""
+
+result = model.process(
+    question=question,
+    context=context,
+    threshold=0.5,
+    # language="en",  # Language can be auto-detected, or explicitly specified
+    return_sentence_metrics=True,  # Enable sentence probabilities
+)
+
+highlighted = result["highlighted_sentences"]
+print(f"Highlighted {len(highlighted)} sentences:")
+for i, sent in enumerate(highlighted, 1):
+    print(f"  {i}. {sent}")
+print(f"\nTotal sentences in context: {len(context.strip().split('.')) - 1}")
+
+# Print sentence probabilities if available
+if "sentence_probabilities" in result:
+    probs = result["sentence_probabilities"]
+    print(f"\nSentence probabilities: {probs}")
+```
+
+```
+Highlighted 3 sentences:
+  1. Common signs include feeling thirsty and having a dry mouth.
+
+  2. Dark yellow urine and infrequent urination are warning signs.
+
+  3. Dizziness, fatigue, and headaches can indicate severe dehydration.
+
+
+Total sentences in context: 7
+
+Sentence probabilities: [0.01702437922358513, 0.9901671409606934, 0.002306025242432952, 0.9472107887268066, 0.0009636427275836468, 0.9724337458610535, 0.0009910146472975612]
+```
+
+#### Chinese Example
+
+```python
+from transformers import AutoModel
+
+model = AutoModel.from_pretrained(
+    "zilliz/semantic-highlight-bilingual-v1",
+    trust_remote_code=True
+)
+
+question = "北京有什么好吃的？"
+context = """
+北京烤鸭是北京最著名的特色美食，皮酥肉嫩，配上薄饼和甜面酱。
+故宫是明清两代的皇家宫殿，也是世界上现存规模最大的木质结构古建筑群。
+炸酱面是北京的传统面食，用黄酱配上黄瓜丝和豆芽菜。
+长城是中国古代的军事防御工程，绵延数千公里。
+老北京涮羊肉以铜锅为特色，羊肉鲜嫩，蘸料丰富。
+天坛是明清两代皇帝祭天的场所，建筑精美。
+豆汁儿是北京独特的传统小吃，口味特别，配上焦圈最地道。
+颐和园是清朝的皇家园林，以昆明湖和万寿山为主体。
+"""
+
+result = model.process(
+    question=question,
+    context=context,
+    threshold=0.5,
+    # language="zh",  # Language can be auto-detected, or explicitly specified
+    return_sentence_metrics=True,  # Enable sentence probabilities
+)
+
+highlighted = result["highlighted_sentences"]
+print(f"高亮了 {len(highlighted)} 个句子:")
+for i, sent in enumerate(highlighted, 1):
+    print(f"  {i}. {sent}")
+print(f"\n上下文总句子数: {len([s for s in context.strip().split('。') if s.strip()])}")
+
+# Print sentence probabilities if available
+if "sentence_probabilities" in result:
+    probs = result["sentence_probabilities"]
+    print(f"\n句子概率: {probs}")
+```
+
+```
+高亮了 4 个句子:
+  1. 北京烤鸭是北京最著名的特色美食，皮酥肉嫩，配上薄饼和甜面酱。
+  2. 炸酱面是北京的传统面食，用黄酱配上黄瓜丝和豆芽菜。
+  3. 老北京涮羊肉以铜锅为特色，羊肉鲜嫩，蘸料丰富。
+  4. 豆汁儿是北京独特的传统小吃，口味特别，配上焦圈最地道。
+
+上下文总句子数: 8
+
+句子概率: [0.9885324239730835, 0.2653350234031677, 0.9058853983879089, 0.13888002932071686, 0.9659912586212158, 0.39620667695999146, 0.968794584274292, 0.23973196744918823]
+```
+
+## Parameters
+
+- `question`: Query text
+- `context`: Document text to highlight
+- `threshold`: Relevance threshold (0-1), default 0.5. Lower values include more sentences.
+- `language`: Language code ("en", "zh", or "auto"). If not specified, language will be auto-detected.
+- `return_sentence_metrics`: Return per-sentence relevance scores
+
+## Output
+
+- `highlighted_sentences`: List of highlighted sentences (relevant sentences only)
+- `compression_rate`: Percentage of text removed
+- `sentence_probabilities`: Relevance score for each sentence (if `return_sentence_metrics=True`)
+
+## How does it work?
+![semantic-highlight-with-sentence-filter](https://zc277584121.github.io/images/semantic-highlight-released/semantic-highlight-with-sentence-filter.png)
+The input consists of a query and a text passage, and the output is a relevance score for each token position in the text. Token scores are then aggregated into sentence scores, and a threshold is applied to highlight or remove sentences accordingly.
+
+Specifically, the model concatenates inputs as `[BOS] + Query + Context`, scores each token in the context (between 0 and 1), averages token scores within each sentence to obtain sentence scores, and finally highlights sentences with high scores while removing those with low scores. The model essentially performs a single pass over the context, using scores to indicate which parts merit attention.
+
+## Evaluation
+![semantic-highlight-released/model-evaluation-results](https://zc277584121.github.io/images/semantic-highlight-released/model-evaluation-results.png)
+The model ranks SOTA across all four evaluation datasets. Notably, it’s the only model that demonstrates strong performance on both Chinese and English datasets. Other models either support only English or show significant performance degradation on Chinese text. 
+
+## Acknowledgments
+
+This work draws its core ideas and theoretical underpinnings from Provence (https://arxiv.org/abs/2501.16214), whose seminal research laid the essential groundwork for our exploration.
+
+For the practical implementation of code and training strategies, we build entirely upon the exceptional efforts of the Open Provence project (https://github.com/hotchpotch/open_provence). We extend our sincere gratitude to the Open Provence team for generously open-sourcing the complete framework—including the high-quality dataset and toolkit for model training—thus making this valuable resource accessible to the broader research community.
+
+This model stands firmly on the shoulders of these foundational contributions, while we have tailored it to better align with specific business needs: we enhanced data generation and training quality for bilingual datasets, and removed the rerank head to optimize its applicability to our use case. Our sincere thanks go to all the researchers and developers behind these remarkable works.
+
+## License
+
+MIT License
+
+## Citation
+
+```bibtex
+@misc{chirkova2025provenceefficientrobustcontext,
+      title={Provence: efficient and robust context pruning for retrieval-augmented generation}, 
+      author={Nadezhda Chirkova and Thibault Formal and Vassilina Nikoulina and Stéphane Clinchant},
+      year={2025},
+      eprint={2501.16214},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2501.16214}, 
+}
+
+@misc{yuichi-tateno-2025-open-provence,
+  url = {https://github.com/hotchpotch/open_provence},
+  title = {OpenProvence: An Open-Source Implementation of Efficient and Robust Context Pruning for Retrieval-Augmented Generation},
+  author = {Yuichi Tateno},
+  year = {2025}
+}
+
+@misc{chen2024bge,
+      title={BGE M3-Embedding: Multi-Lingual, Multi-Functionality, Multi-Granularity Text Embeddings Through Self-Knowledge Distillation}, 
+      author={Jianlv Chen and Shitao Xiao and Peitian Zhang and Kun Luo and Defu Lian and Zheng Liu},
+      year={2024},
+      eprint={2402.03216},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+
+For more information, check out the blog here: https://huggingface.co/blog/zilliz/zilliz-semantic-highlight-model

config.json

@@ -0,0 +1,179 @@
+{
+  "architectures": [
+    "OpenProvenceForSequenceClassification"
+  ],
+  "auto_map": {
+    "AutoConfig": "modeling_open_provence_standalone.OpenProvenceConfig",
+    "AutoModel": "modeling_open_provence_standalone.OpenProvenceForSequenceClassification",
+    "AutoModelForSequenceClassification": "modeling_open_provence_standalone.OpenProvenceForSequenceClassification",
+    "AutoModelForTokenClassification": "modeling_open_provence_standalone.OpenProvenceForTokenClassification"
+  },
+  "base_model_config": {
+    "_name_or_path": "BAAI/bge-reranker-v2-m3",
+    "add_cross_attention": false,
+    "architectures": [
+      "XLMRobertaForSequenceClassification"
+    ],
+    "attention_probs_dropout_prob": 0.1,
+    "bad_words_ids": null,
+    "begin_suppress_tokens": null,
+    "bos_token_id": 0,
+    "chunk_size_feed_forward": 0,
+    "classifier_dropout": null,
+    "cross_attention_hidden_size": null,
+    "decoder_start_token_id": null,
+    "diversity_penalty": 0.0,
+    "do_sample": false,
+    "dtype": "float32",
+    "early_stopping": false,
+    "encoder_no_repeat_ngram_size": 0,
+    "eos_token_id": 2,
+    "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": 1024,
+    "id2label": {
+      "0": "LABEL_0"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 4096,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "LABEL_0": 0
+    },
+    "layer_norm_eps": 1e-05,
+    "length_penalty": 1.0,
+    "max_length": 20,
+    "max_position_embeddings": 8194,
+    "min_length": 0,
+    "model_type": "xlm-roberta",
+    "no_repeat_ngram_size": 0,
+    "num_attention_heads": 16,
+    "num_beam_groups": 1,
+    "num_beams": 1,
+    "num_hidden_layers": 24,
+    "num_return_sequences": 1,
+    "output_attentions": false,
+    "output_hidden_states": false,
+    "output_past": true,
+    "output_scores": false,
+    "pad_token_id": 1,
+    "position_embedding_type": "absolute",
+    "prefix": null,
+    "problem_type": null,
+    "pruned_heads": {},
+    "remove_invalid_values": false,
+    "repetition_penalty": 1.0,
+    "return_dict": true,
+    "return_dict_in_generate": false,
+    "sep_token_id": null,
+    "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,
+    "torchscript": false,
+    "transformers_version": "4.57.1",
+    "type_vocab_size": 1,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_cache": true,
+    "vocab_size": 250002
+  },
+  "base_model_name_or_path": "BAAI/bge-reranker-v2-m3",
+  "default_threadshold": null,
+  "default_threshold": null,
+  "encoder_architecture": "xlm-roberta",
+  "hidden_size": 1024,
+  "id2label": {
+    "0": "LABEL_0"
+  },
+  "label2id": {
+    "LABEL_0": 0
+  },
+  "max_length": 512,
+  "mode": "reranking_pruning",
+  "model_type": "open_provence",
+  "num_pruning_labels": 2,
+  "pruning_config": {
+    "_name_or_path": "",
+    "add_cross_attention": false,
+    "architectures": null,
+    "bad_words_ids": null,
+    "begin_suppress_tokens": null,
+    "bos_token_id": null,
+    "chunk_size_feed_forward": 0,
+    "classifier_dropout": 0.1,
+    "cross_attention_hidden_size": null,
+    "decoder_start_token_id": null,
+    "diversity_penalty": 0.0,
+    "do_sample": false,
+    "dtype": null,
+    "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_size": 1024,
+    "id2label": {
+      "0": "LABEL_0",
+      "1": "LABEL_1"
+    },
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "LABEL_0": 0,
+      "LABEL_1": 1
+    },
+    "length_penalty": 1.0,
+    "max_length": 20,
+    "min_length": 0,
+    "model_type": "open_provence_head",
+    "no_repeat_ngram_size": 0,
+    "num_beam_groups": 1,
+    "num_beams": 1,
+    "num_return_sequences": 1,
+    "output_attentions": false,
+    "output_hidden_states": false,
+    "output_scores": false,
+    "pad_token_id": null,
+    "prefix": null,
+    "problem_type": null,
+    "pruned_heads": {},
+    "remove_invalid_values": false,
+    "repetition_penalty": 1.0,
+    "return_dict": true,
+    "return_dict_in_generate": false,
+    "sentence_pooling": "mean",
+    "sep_token_id": null,
+    "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,
+    "torchscript": false,
+    "transformers_version": "4.57.1",
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_weighted_pooling": false
+  },
+  "tokenizer_name_or_path": null,
+  "transformers_version": "4.57.1",
+  "vocab_size": 250002,
+  "_rerank_head_removed": true,
+  "_note": "Rerank head weights were removed as they were not trained (ranking_weight=0.0)"
+}

model.safetensors

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

special_tokens_map.json

@@ -0,0 +1,51 @@
+{
+  "bos_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "cls_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "<mask>",
+    "lstrip": true,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<pad>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "<unk>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer.json

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

tokenizer_config.json

@@ -0,0 +1,56 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "</s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "3": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "250001": {
+      "content": "<mask>",
+      "lstrip": true,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "bos_token": "<s>",
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "<s>",
+  "eos_token": "</s>",
+  "extra_special_tokens": {},
+  "mask_token": "<mask>",
+  "model_max_length": 8192,
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "sp_model_kwargs": {},
+  "tokenizer_class": "XLMRobertaTokenizer",
+  "unk_token": "<unk>"
+}