Hierarchical E5-Math for exact chunk retrieval - 25/06/2025
Browse files- .gitattributes +1 -0
- 1_Pooling/config.json +7 -0
- README.md +70 -0
- config.json +28 -0
- config_sentence_transformers.json +7 -0
- modules.json +20 -0
- pytorch_model.bin +3 -0
- sentence_bert_config.json +4 -0
- sentencepiece.bpe.model +3 -0
- special_tokens_map.json +15 -0
- tokenizer.json +3 -0
- tokenizer_config.json +19 -0
- usage_example.py +28 -0
.gitattributes
CHANGED
|
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
+
tokenizer.json filter=lfs diff=lfs merge=lfs -text
|
1_Pooling/config.json
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"word_embedding_dimension": 768,
|
| 3 |
+
"pooling_mode_cls_token": false,
|
| 4 |
+
"pooling_mode_mean_tokens": true,
|
| 5 |
+
"pooling_mode_max_tokens": false,
|
| 6 |
+
"pooling_mode_mean_sqrt_len_tokens": false
|
| 7 |
+
}
|
README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- vi
|
| 4 |
+
- en
|
| 5 |
+
library_name: sentence-transformers
|
| 6 |
+
pipeline_tag: sentence-similarity
|
| 7 |
+
tags:
|
| 8 |
+
- sentence-transformers
|
| 9 |
+
- mathematics
|
| 10 |
+
- vietnamese
|
| 11 |
+
- exact-chunk-retrieval
|
| 12 |
+
- hierarchical-learning
|
| 13 |
+
- e5-base
|
| 14 |
+
base_model: intfloat/multilingual-e5-base
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
# E5-Math-Vietnamese: Hierarchical Exact Chunk Retrieval
|
| 18 |
+
|
| 19 |
+
## Model Overview
|
| 20 |
+
Fine-tuned E5-base model for **exact chunk retrieval** in Vietnamese mathematics with **hierarchical scoring**:
|
| 21 |
+
- **Correct chunks**: Score ~1.0 (exact answers)
|
| 22 |
+
- **Related chunks**: Score ~0.3 (supplementary info)
|
| 23 |
+
- **Irrelevant chunks**: Score ~0.0 (unrelated content)
|
| 24 |
+
|
| 25 |
+
## Training Results
|
| 26 |
+
- **Best Score**: 0.75
|
| 27 |
+
- **Epochs**: 5
|
| 28 |
+
- **Hierarchy Maintained**: True
|
| 29 |
+
- **Task**: Find 1 correct chunk in top 5 results
|
| 30 |
+
|
| 31 |
+
## Usage
|
| 32 |
+
```python
|
| 33 |
+
from sentence_transformers import SentenceTransformer
|
| 34 |
+
from sklearn.metrics.pairwise import cosine_similarity
|
| 35 |
+
|
| 36 |
+
# Load model
|
| 37 |
+
model = SentenceTransformer('ThanhLe0125/e5-math')
|
| 38 |
+
|
| 39 |
+
# ⚠️ CRITICAL: Must use E5 prefixes
|
| 40 |
+
query = "query: Định nghĩa hàm số đồng biến là gì?"
|
| 41 |
+
chunks = [
|
| 42 |
+
"passage: Hàm số đồng biến trên khoảng (a;b) là...", # CORRECT
|
| 43 |
+
"passage: Ví dụ bài tập về hàm đồng biến...", # RELATED
|
| 44 |
+
"passage: Phương trình bậc hai có dạng..." # IRRELEVANT
|
| 45 |
+
]
|
| 46 |
+
|
| 47 |
+
# Find exact chunk in top 5
|
| 48 |
+
query_emb = model.encode([query])
|
| 49 |
+
chunk_embs = model.encode(chunks)
|
| 50 |
+
similarities = cosine_similarity(query_emb, chunk_embs)[0]
|
| 51 |
+
top5_indices = similarities.argsort()[::-1][:5]
|
| 52 |
+
|
| 53 |
+
# Get exact answer (should be rank 1)
|
| 54 |
+
exact_answer = chunks[top5_indices[0]]
|
| 55 |
+
print(f"Exact answer: {exact_answer}")
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
## Key Features
|
| 59 |
+
- ✅ Finds exact answers in top 5 results
|
| 60 |
+
- ✅ Maintains hierarchy: Exact > Related > Irrelevant
|
| 61 |
+
- ✅ Optimized for Vietnamese mathematics
|
| 62 |
+
- ⚠️ Requires E5 prefixes for optimal performance
|
| 63 |
+
|
| 64 |
+
## Perfect For
|
| 65 |
+
- Educational Q&A systems
|
| 66 |
+
- Exact answer retrieval
|
| 67 |
+
- Vietnamese math tutoring
|
| 68 |
+
- Content recommendation with hierarchy
|
| 69 |
+
|
| 70 |
+
*Trained on 25/06/2025 with hierarchical contrastive learning.*
|
config.json
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"_name_or_path": "/root/.cache/torch/sentence_transformers/intfloat_multilingual-e5-base/",
|
| 3 |
+
"architectures": [
|
| 4 |
+
"XLMRobertaModel"
|
| 5 |
+
],
|
| 6 |
+
"attention_probs_dropout_prob": 0.1,
|
| 7 |
+
"bos_token_id": 0,
|
| 8 |
+
"classifier_dropout": null,
|
| 9 |
+
"eos_token_id": 2,
|
| 10 |
+
"hidden_act": "gelu",
|
| 11 |
+
"hidden_dropout_prob": 0.1,
|
| 12 |
+
"hidden_size": 768,
|
| 13 |
+
"initializer_range": 0.02,
|
| 14 |
+
"intermediate_size": 3072,
|
| 15 |
+
"layer_norm_eps": 1e-05,
|
| 16 |
+
"max_position_embeddings": 514,
|
| 17 |
+
"model_type": "xlm-roberta",
|
| 18 |
+
"num_attention_heads": 12,
|
| 19 |
+
"num_hidden_layers": 12,
|
| 20 |
+
"output_past": true,
|
| 21 |
+
"pad_token_id": 1,
|
| 22 |
+
"position_embedding_type": "absolute",
|
| 23 |
+
"torch_dtype": "float32",
|
| 24 |
+
"transformers_version": "4.32.0",
|
| 25 |
+
"type_vocab_size": 1,
|
| 26 |
+
"use_cache": true,
|
| 27 |
+
"vocab_size": 250002
|
| 28 |
+
}
|
config_sentence_transformers.json
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"__version__": {
|
| 3 |
+
"sentence_transformers": "2.2.2",
|
| 4 |
+
"transformers": "4.32.0",
|
| 5 |
+
"pytorch": "2.6.0+cu124"
|
| 6 |
+
}
|
| 7 |
+
}
|
modules.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[
|
| 2 |
+
{
|
| 3 |
+
"idx": 0,
|
| 4 |
+
"name": "0",
|
| 5 |
+
"path": "",
|
| 6 |
+
"type": "sentence_transformers.models.Transformer"
|
| 7 |
+
},
|
| 8 |
+
{
|
| 9 |
+
"idx": 1,
|
| 10 |
+
"name": "1",
|
| 11 |
+
"path": "1_Pooling",
|
| 12 |
+
"type": "sentence_transformers.models.Pooling"
|
| 13 |
+
},
|
| 14 |
+
{
|
| 15 |
+
"idx": 2,
|
| 16 |
+
"name": "2",
|
| 17 |
+
"path": "2_Normalize",
|
| 18 |
+
"type": "sentence_transformers.models.Normalize"
|
| 19 |
+
}
|
| 20 |
+
]
|
pytorch_model.bin
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:2f574db303fec96d1c21659f6acde3937d02de3744848f3c0a49bd3cd3023b18
|
| 3 |
+
size 1112241766
|
sentence_bert_config.json
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"max_seq_length": 256,
|
| 3 |
+
"do_lower_case": false
|
| 4 |
+
}
|
sentencepiece.bpe.model
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:cfc8146abe2a0488e9e2a0c56de7952f7c11ab059eca145a0a727afce0db2865
|
| 3 |
+
size 5069051
|
special_tokens_map.json
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"bos_token": "<s>",
|
| 3 |
+
"cls_token": "<s>",
|
| 4 |
+
"eos_token": "</s>",
|
| 5 |
+
"mask_token": {
|
| 6 |
+
"content": "<mask>",
|
| 7 |
+
"lstrip": true,
|
| 8 |
+
"normalized": false,
|
| 9 |
+
"rstrip": false,
|
| 10 |
+
"single_word": false
|
| 11 |
+
},
|
| 12 |
+
"pad_token": "<pad>",
|
| 13 |
+
"sep_token": "</s>",
|
| 14 |
+
"unk_token": "<unk>"
|
| 15 |
+
}
|
tokenizer.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:065854c334ebd3edacd11072e41985f97df74967657f2d6e4fb0be122e8d1613
|
| 3 |
+
size 17082913
|
tokenizer_config.json
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"bos_token": "<s>",
|
| 3 |
+
"clean_up_tokenization_spaces": true,
|
| 4 |
+
"cls_token": "<s>",
|
| 5 |
+
"eos_token": "</s>",
|
| 6 |
+
"mask_token": {
|
| 7 |
+
"__type": "AddedToken",
|
| 8 |
+
"content": "<mask>",
|
| 9 |
+
"lstrip": true,
|
| 10 |
+
"normalized": true,
|
| 11 |
+
"rstrip": false,
|
| 12 |
+
"single_word": false
|
| 13 |
+
},
|
| 14 |
+
"model_max_length": 512,
|
| 15 |
+
"pad_token": "<pad>",
|
| 16 |
+
"sep_token": "</s>",
|
| 17 |
+
"tokenizer_class": "XLMRobertaTokenizer",
|
| 18 |
+
"unk_token": "<unk>"
|
| 19 |
+
}
|
usage_example.py
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
from sentence_transformers import SentenceTransformer
|
| 3 |
+
from sklearn.metrics.pairwise import cosine_similarity
|
| 4 |
+
|
| 5 |
+
# Load hierarchical model
|
| 6 |
+
model = SentenceTransformer('ThanhLe0125/e5-math')
|
| 7 |
+
|
| 8 |
+
# Example: Find exact chunk among similar options
|
| 9 |
+
query = "query: Định nghĩa hàm số đồng biến"
|
| 10 |
+
chunks = [
|
| 11 |
+
"passage: Hàm số đồng biến trên khoảng (a;b) là hàm số mà với mọi x1 < x2 thì f(x1) < f(x2)",
|
| 12 |
+
"passage: Ví dụ: Tìm khoảng đồng biến của hàm số y = x^2 - 2x + 1",
|
| 13 |
+
"passage: Phương trình bậc hai ax^2 + bx + c = 0"
|
| 14 |
+
]
|
| 15 |
+
|
| 16 |
+
# Encode and rank
|
| 17 |
+
query_emb = model.encode([query])
|
| 18 |
+
chunk_embs = model.encode(chunks)
|
| 19 |
+
similarities = cosine_similarity(query_emb, chunk_embs)[0]
|
| 20 |
+
|
| 21 |
+
# Get top 5 results
|
| 22 |
+
top5_indices = similarities.argsort()[::-1][:5]
|
| 23 |
+
for rank, idx in enumerate(top5_indices, 1):
|
| 24 |
+
print(f"{rank}. Score: {similarities[idx]:.4f} - {chunks[idx][:50]}...")
|
| 25 |
+
|
| 26 |
+
# Expected: Exact definition gets highest score (~1.0)
|
| 27 |
+
# Related example gets medium score (~0.3)
|
| 28 |
+
# Irrelevant content gets low score (~0.0)
|