R3iwan commited on
Commit
eddc9bd
·
verified ·
1 Parent(s): 06bf2a1

Upload folder using huggingface_hub

Browse files
.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,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 1024,
3
+ "pooling_mode_cls_token": true,
4
+ "pooling_mode_mean_tokens": false,
5
+ "pooling_mode_max_tokens": false,
6
+ "pooling_mode_mean_sqrt_len_tokens": false,
7
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,161 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - kk
4
+ - ru
5
+ - en
6
+ license: apache-2.0
7
+ tags:
8
+ - feature-extraction
9
+ - sentence-similarity
10
+ - multilingual
11
+ pipeline_tag: sentence-similarity
12
+ base_model: BAAI/bge-m3
13
+ model-index:
14
+ - name: darmm-embedding-multilingual
15
+ results:
16
+ - task:
17
+ type: retrieval
18
+ name: Retrieval
19
+ metrics:
20
+ - type: recall_at_1
21
+ value: 0.9444
22
+ - type: recall_at_3
23
+ value: 1.0
24
+ - type: recall_at_5
25
+ value: 1.0
26
+ - type: recall_at_10
27
+ value: 1.0
28
+ ---
29
+
30
+ # Darmm Multilingual Embedding
31
+
32
+ Multilingual embedding model (Kazakh/Russian/English) fine-tuned from `BAAI/bge-m3` for Darmm FAQ and product content retrieval.
33
+
34
+ ## Usage
35
+
36
+ Local model usage:
37
+ ```python
38
+ from sentence_transformers import SentenceTransformer
39
+
40
+ model = SentenceTransformer("./outputs/embedding-model")
41
+ sentences = ["Darmm қызметтері қандай?", "What services does Darmm provide?"]
42
+ embeddings = model.encode(sentences)
43
+ print(embeddings.shape)
44
+ ```
45
+
46
+ If published to Hugging Face, replace the path with your repo id.
47
+
48
+ ## Training data (verified)
49
+ - Darmm landing, academy, and mentor site text extracted from local sources.
50
+ Local model usage:
51
+
52
+ ## Training setup
53
+ - Base model: `BAAI/bge-m3`.
54
+ - Loss: `MultipleNegativesRankingLoss` (default in `scripts/train_embeddings.py`).
55
+ - Typical training params in this repo: `epochs=3`, `batch_size=2`, `max_seq_length=128`.
56
+
57
+ ## Evaluation
58
+ Evaluation uses paraphrased FAQ questions mapped to the FAQ corpus:
59
+ - Corpus: `data/faq_chunks.jsonl` (369 chunks)
60
+ - Queries: `data/eval_questions.jsonl` (90 questions)
61
+
62
+ ## Paper & Documentation
63
+
64
+ <details>
65
+ <summary>🇬🇧 English</summary>
66
+
67
+ # Darmm: Multilingual Embeddings for FAQ Retrieval
68
+
69
+ ## Abstract
70
+ We present a multilingual embedding model fine‑tuned for Darmm FAQ and product knowledge retrieval in Kazakh, Russian, and English. The model is based on `BAAI/bge-m3` and trained on Darmm website content and a handcrafted FAQ corpus. We evaluate on paraphrased FAQ questions mapped to the FAQ corpus.
71
+
72
+ ## 1. Dataset
73
+ - **Sources**: Darmm landing, academy, and mentor site content (local sources) plus handcrafted FAQ data.
74
+ - **FAQ corpus**: 150 topics × 3 languages = 450 Q/A documents.
75
+ - **Chunked corpus**: 369 chunks in `data/faq_chunks.jsonl`.
76
+
77
+ ## 2. Training
78
+ - **Base model**: `BAAI/bge-m3`
79
+ - **Loss**: `MultipleNegativesRankingLoss`
80
+ - **Params**: `epochs=3`, `batch_size=2`, `max_seq_length=128`
81
+
82
+ ## 3. Results
83
+ Evaluation on `data/eval_questions.jsonl` (90 paraphrased queries) against the FAQ corpus:
84
+ - Recall@1 = 0.9444
85
+ - Recall@3/5/10 = 1.0
86
+
87
+ ## 4. Limitations
88
+ - Performance depends on query style and corpus quality.
89
+ - Short UI strings can reduce relevance; prefer richer FAQ or docs.
90
+ - Validate with real user questions and a held‑out test set.
91
+
92
+ </details>
93
+
94
+ <details>
95
+ <summary>🇰🇿 Қазақша</summary>
96
+
97
+ # Darmm: FAQ іздеуге арналған көптілді эмбеддингтер
98
+
99
+ ## Аңдатпа
100
+ Бұл модель Darmm‑ның FAQ және өнім білім базасын қазақ, орыс және ағылшын тілдерінде іздеуге арналған. Негізі `BAAI/bge-m3`, оқыту Darmm сайт контенті мен қолмен жасалған FAQ жиынына жүргізілді. Бағалау парафраз сұрақтар арқылы жасалды.
101
+
102
+ ## 1. Деректер
103
+ - **Көздер**: Darmm landing/academy/mentor сайттарының локал контенті және FAQ жиыны.
104
+ - **FAQ корпусы**: 150 тақырып × 3 тіл = 450 Q/A құжаты.
105
+ - **Чанкталған корпус**: `data/faq_chunks.jsonl` ішінде 369 чанк.
106
+
107
+ ## 2. Оқыту
108
+ - **Негізгі модель**: `BAAI/bge-m3`
109
+ - **Loss**: `MultipleNegativesRankingLoss`
110
+ - **Параметрлер**: `epochs=3`, `batch_size=2`, `max_seq_length=128`
111
+
112
+ ## 3. Нәтижелер
113
+ `data/eval_questions.jsonl` (90 парафраз сұрақ) арқылы бағалау:
114
+ - Recall@1 = 0.9444
115
+ - Recall@3/5/10 = 1.0
116
+
117
+ ## 4. Шектеулер
118
+ - Нәтиже сұрақ стилі мен корпус сапасына тәуелді.
119
+ - Қысқа UI мәтіндері релевантты төмендетуі мүмкін.
120
+ - Нақты пайдаланушы сұрақтарымен міндетті түрде тексеріңіз.
121
+
122
+ </details>
123
+
124
+ <details>
125
+ <summary>🇷🇺 Русский</summary>
126
+
127
+ # Darmm: Мультиязычные эмбеддинги для FAQ‑поиска
128
+
129
+ ## Аннотация
130
+ Модель предназначена для поиска по FAQ и базе знаний Darmm на казахском, русском и английском. Основана на `BAAI/bge-m3` и дообучена на локальном контенте сайтов Darmm и ручном FAQ‑корпусе. Оценка проводится на перефразированных вопросах.
131
+
132
+ ## 1. Данные
133
+ - **Источ��ики**: локальный контент сайтов Darmm и FAQ‑корпус.
134
+ - **FAQ корпус**: 150 тем × 3 языка = 450 Q/A документов.
135
+ - **Чанкованный корпус**: 369 чанков в `data/faq_chunks.jsonl`.
136
+
137
+ ## 2. Обучение
138
+ - **Базовая модель**: `BAAI/bge-m3`
139
+ - **Loss**: `MultipleNegativesRankingLoss`
140
+ - **Параметры**: `epochs=3`, `batch_size=2`, `max_seq_length=128`
141
+
142
+ ## 3. Результаты
143
+ Оценка на `data/eval_questions.jsonl` (90 перефразированных запросов):
144
+ - Recall@1 = 0.9444
145
+ - Recall@3/5/10 = 1.0
146
+
147
+ ## 4. Ограничения
148
+ - Результаты зависят от стиля запросов и качества корпуса.
149
+ - Короткие UI‑строки снижают релевантность.
150
+ - Проверяйте на реальных пользовательских вопросах.
151
+
152
+ </details>
153
+
154
+ ## Intended use
155
+ - FAQ search and internal knowledge retrieval across kk/ru/en.
156
+ - RAG pipelines for Darmm services.
157
+
158
+ ## Limitations
159
+ - Results depend on corpus quality and query style.
160
+ - Short UI strings reduce relevance; prefer fuller FAQ or documentation.
161
+ - For real-world validation, use actual user queries and a held‑out test set.
config.json ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "BAAI/bge-m3",
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": 1024,
13
+ "initializer_range": 0.02,
14
+ "intermediate_size": 4096,
15
+ "layer_norm_eps": 1e-05,
16
+ "max_position_embeddings": 8194,
17
+ "model_type": "xlm-roberta",
18
+ "num_attention_heads": 16,
19
+ "num_hidden_layers": 24,
20
+ "output_past": true,
21
+ "pad_token_id": 1,
22
+ "position_embedding_type": "absolute",
23
+ "torch_dtype": "float32",
24
+ "transformers_version": "4.45.2",
25
+ "type_vocab_size": 1,
26
+ "use_cache": true,
27
+ "vocab_size": 250002
28
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.2.2",
4
+ "transformers": "4.33.0",
5
+ "pytorch": "2.1.2+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null
9
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:59bfcf156b258c3f94a39d494357f8259f38eccf5158d1ebe3a1eecd3a019af1
3
+ size 2271064456
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
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 128,
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,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token": {
3
+ "content": "<s>",
4
+ "lstrip": false,
5
+ "normalized": false,
6
+ "rstrip": false,
7
+ "single_word": false
8
+ },
9
+ "cls_token": {
10
+ "content": "<s>",
11
+ "lstrip": false,
12
+ "normalized": false,
13
+ "rstrip": false,
14
+ "single_word": false
15
+ },
16
+ "eos_token": {
17
+ "content": "</s>",
18
+ "lstrip": false,
19
+ "normalized": false,
20
+ "rstrip": false,
21
+ "single_word": false
22
+ },
23
+ "mask_token": {
24
+ "content": "<mask>",
25
+ "lstrip": true,
26
+ "normalized": false,
27
+ "rstrip": false,
28
+ "single_word": false
29
+ },
30
+ "pad_token": {
31
+ "content": "<pad>",
32
+ "lstrip": false,
33
+ "normalized": false,
34
+ "rstrip": false,
35
+ "single_word": false
36
+ },
37
+ "sep_token": {
38
+ "content": "</s>",
39
+ "lstrip": false,
40
+ "normalized": false,
41
+ "rstrip": false,
42
+ "single_word": false
43
+ },
44
+ "unk_token": {
45
+ "content": "<unk>",
46
+ "lstrip": false,
47
+ "normalized": false,
48
+ "rstrip": false,
49
+ "single_word": false
50
+ }
51
+ }
tokenizer.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c119aa9bc83a5d76efbbc831b23e5790727c12fde474f6519dd96cde6550ffd7
3
+ size 17083052
tokenizer_config.json ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "<s>",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "1": {
12
+ "content": "<pad>",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "2": {
20
+ "content": "</s>",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "3": {
28
+ "content": "<unk>",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "250001": {
36
+ "content": "<mask>",
37
+ "lstrip": true,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "bos_token": "<s>",
45
+ "clean_up_tokenization_spaces": true,
46
+ "cls_token": "<s>",
47
+ "eos_token": "</s>",
48
+ "mask_token": "<mask>",
49
+ "model_max_length": 8192,
50
+ "pad_token": "<pad>",
51
+ "sep_token": "</s>",
52
+ "sp_model_kwargs": {},
53
+ "tokenizer_class": "XLMRobertaTokenizer",
54
+ "unk_token": "<unk>"
55
+ }
train_args.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "pairs": "data/faq_pairs_train.jsonl",
3
+ "base_model": "BAAI/bge-m3",
4
+ "output": "outputs/embedding-model",
5
+ "batch_size": 2,
6
+ "epochs": 3,
7
+ "learning_rate": 2e-05,
8
+ "max_seq_length": 128,
9
+ "use_hard_negatives": false
10
+ }