w11wo commited on
Commit
239ef03
1 Parent(s): ae16eb6

Add new SentenceTransformer model.

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": 384,
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
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,144 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: sentence-transformers
3
+ pipeline_tag: sentence-similarity
4
+ tags:
5
+ - sentence-transformers
6
+ - feature-extraction
7
+ - sentence-similarity
8
+ - transformers
9
+ datasets:
10
+ - indonli
11
+ - indolem/indo_story_cloze
12
+ - unicamp-dl/mmarco
13
+ - miracl/miracl
14
+ - nthakur/swim-ir-monolingual
15
+ - LazarusNLP/multilingual-NLI-26lang-2mil7-id
16
+ - SEACrowd/wrete
17
+ - SEACrowd/indolem_ntp
18
+ - khalidalt/tydiqa-goldp
19
+ - SEACrowd/facqa
20
+ - indonesian-nlp/lfqa_id
21
+ - jakartaresearch/indoqa
22
+ - jakartaresearch/id-paraphrase-detection
23
+ ---
24
+
25
+ # LazarusNLP/all-indo-e5-small-v4
26
+
27
+ This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 384 dimensional dense vector space and can be used for tasks like clustering or semantic search.
28
+
29
+ <!--- Describe your model here -->
30
+
31
+ ## Usage (Sentence-Transformers)
32
+
33
+ Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
34
+
35
+ ```
36
+ pip install -U sentence-transformers
37
+ ```
38
+
39
+ Then you can use the model like this:
40
+
41
+ ```python
42
+ from sentence_transformers import SentenceTransformer
43
+ sentences = ["This is an example sentence", "Each sentence is converted"]
44
+
45
+ model = SentenceTransformer('LazarusNLP/all-indo-e5-small-v4')
46
+ embeddings = model.encode(sentences)
47
+ print(embeddings)
48
+ ```
49
+
50
+
51
+
52
+ ## Usage (HuggingFace Transformers)
53
+ Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.
54
+
55
+ ```python
56
+ from transformers import AutoTokenizer, AutoModel
57
+ import torch
58
+
59
+
60
+ #Mean Pooling - Take attention mask into account for correct averaging
61
+ def mean_pooling(model_output, attention_mask):
62
+ token_embeddings = model_output[0] #First element of model_output contains all token embeddings
63
+ input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
64
+ return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
65
+
66
+
67
+ # Sentences we want sentence embeddings for
68
+ sentences = ['This is an example sentence', 'Each sentence is converted']
69
+
70
+ # Load model from HuggingFace Hub
71
+ tokenizer = AutoTokenizer.from_pretrained('LazarusNLP/all-indo-e5-small-v4')
72
+ model = AutoModel.from_pretrained('LazarusNLP/all-indo-e5-small-v4')
73
+
74
+ # Tokenize sentences
75
+ encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
76
+
77
+ # Compute token embeddings
78
+ with torch.no_grad():
79
+ model_output = model(**encoded_input)
80
+
81
+ # Perform pooling. In this case, mean pooling.
82
+ sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
83
+
84
+ print("Sentence embeddings:")
85
+ print(sentence_embeddings)
86
+ ```
87
+
88
+
89
+
90
+ ## Evaluation Results
91
+
92
+ <!--- Describe how your model was evaluated -->
93
+
94
+ For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=LazarusNLP/all-indo-e5-small-v4)
95
+
96
+
97
+ ## Training
98
+ The model was trained with the parameters:
99
+
100
+ **DataLoader**:
101
+
102
+ `MultiDatasetDataLoader.MultiDatasetDataLoader` of length 1669 with parameters:
103
+ ```
104
+ {'batch_size': 'unknown'}
105
+ ```
106
+
107
+ **Loss**:
108
+
109
+ `sentence_transformers.losses.CachedMultipleNegativesRankingLoss.CachedMultipleNegativesRankingLoss` with parameters:
110
+ ```
111
+ {'scale': 20.0, 'similarity_fct': 'cos_sim'}
112
+ ```
113
+
114
+ Parameters of the fit()-Method:
115
+ ```
116
+ {
117
+ "epochs": 5,
118
+ "evaluation_steps": 0,
119
+ "evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
120
+ "max_grad_norm": 1,
121
+ "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
122
+ "optimizer_params": {
123
+ "eps": 1e-06,
124
+ "lr": 2e-05
125
+ },
126
+ "scheduler": "WarmupLinear",
127
+ "steps_per_epoch": null,
128
+ "warmup_steps": 835,
129
+ "weight_decay": 0.01
130
+ }
131
+ ```
132
+
133
+
134
+ ## Full Model Architecture
135
+ ```
136
+ SentenceTransformer(
137
+ (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: BertModel
138
+ (1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
139
+ )
140
+ ```
141
+
142
+ ## Citing & Authors
143
+
144
+ <!--- Describe where people can find more information -->
config.json ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "intfloat/multilingual-e5-small",
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "classifier_dropout": null,
8
+ "hidden_act": "gelu",
9
+ "hidden_dropout_prob": 0.1,
10
+ "hidden_size": 384,
11
+ "initializer_range": 0.02,
12
+ "intermediate_size": 1536,
13
+ "layer_norm_eps": 1e-12,
14
+ "max_position_embeddings": 512,
15
+ "model_type": "bert",
16
+ "num_attention_heads": 12,
17
+ "num_hidden_layers": 12,
18
+ "pad_token_id": 0,
19
+ "position_embedding_type": "absolute",
20
+ "tokenizer_class": "XLMRobertaTokenizer",
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.40.1",
23
+ "type_vocab_size": 2,
24
+ "use_cache": true,
25
+ "vocab_size": 250037
26
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.8.0.dev0",
4
+ "transformers": "4.40.1",
5
+ "pytorch": "2.3.0+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:228f63c60a58b35959046f4a5e8cef7cda49a857f1912d0eb780e9a86b3e6caa
3
+ size 470637416
modules.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 128,
3
+ "do_lower_case": false
4
+ }
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": false,
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:6c2ccb33b55c4d157419a2105d6e033f7514c2baa6306471c56b86ab02787613
3
+ size 17083053
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": false,
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": 512,
50
+ "pad_token": "<pad>",
51
+ "sep_token": "</s>",
52
+ "sp_model_kwargs": {},
53
+ "tokenizer_class": "XLMRobertaTokenizer",
54
+ "unk_token": "<unk>"
55
+ }