aipib commited on
Commit
54b68c2
1 Parent(s): d05867d

Upload 13 files

Browse files
.gitattributes ADDED
@@ -0,0 +1 @@
 
 
1
+ model.safetensors filter=lfs diff=lfs merge=lfs -text
1_Pooling/config.json ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
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
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false
9
+ }
README.md ADDED
@@ -0,0 +1,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+
10
+ ---
11
+
12
+ # {MODEL_NAME}
13
+
14
+ This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.
15
+
16
+ <!--- Describe your model here -->
17
+
18
+ ## Usage (Sentence-Transformers)
19
+
20
+ Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
21
+
22
+ ```
23
+ pip install -U sentence-transformers
24
+ ```
25
+
26
+ Then you can use the model like this:
27
+
28
+ ```python
29
+ from sentence_transformers import SentenceTransformer
30
+ sentences = ["This is an example sentence", "Each sentence is converted"]
31
+
32
+ model = SentenceTransformer('{MODEL_NAME}')
33
+ embeddings = model.encode(sentences)
34
+ print(embeddings)
35
+ ```
36
+
37
+
38
+
39
+ ## Usage (HuggingFace Transformers)
40
+ 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.
41
+
42
+ ```python
43
+ from transformers import AutoTokenizer, AutoModel
44
+ import torch
45
+
46
+
47
+ #Mean Pooling - Take attention mask into account for correct averaging
48
+ def mean_pooling(model_output, attention_mask):
49
+ token_embeddings = model_output[0] #First element of model_output contains all token embeddings
50
+ input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
51
+ return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
52
+
53
+
54
+ # Sentences we want sentence embeddings for
55
+ sentences = ['This is an example sentence', 'Each sentence is converted']
56
+
57
+ # Load model from HuggingFace Hub
58
+ tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
59
+ model = AutoModel.from_pretrained('{MODEL_NAME}')
60
+
61
+ # Tokenize sentences
62
+ encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
63
+
64
+ # Compute token embeddings
65
+ with torch.no_grad():
66
+ model_output = model(**encoded_input)
67
+
68
+ # Perform pooling. In this case, mean pooling.
69
+ sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
70
+
71
+ print("Sentence embeddings:")
72
+ print(sentence_embeddings)
73
+ ```
74
+
75
+
76
+
77
+ ## Evaluation Results
78
+
79
+ <!--- Describe how your model was evaluated -->
80
+
81
+ For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
82
+
83
+
84
+ ## Training
85
+ The model was trained with the parameters:
86
+
87
+ **DataLoader**:
88
+
89
+ `torch.utils.data.dataloader.DataLoader` of length 4 with parameters:
90
+ ```
91
+ {'batch_size': 1, 'sampler': 'torch.utils.data.sampler.SequentialSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
92
+ ```
93
+
94
+ **Loss**:
95
+
96
+ `sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss` with parameters:
97
+ ```
98
+ {'scale': 20.0, 'similarity_fct': 'cos_sim'}
99
+ ```
100
+
101
+ Parameters of the fit()-Method:
102
+ ```
103
+ {
104
+ "epochs": 10,
105
+ "evaluation_steps": 5,
106
+ "evaluator": "sentence_transformers.evaluation.InformationRetrievalEvaluator.InformationRetrievalEvaluator",
107
+ "max_grad_norm": 1,
108
+ "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
109
+ "optimizer_params": {
110
+ "lr": 2e-05
111
+ },
112
+ "scheduler": "WarmupLinear",
113
+ "steps_per_epoch": null,
114
+ "warmup_steps": 4,
115
+ "weight_decay": 0.01
116
+ }
117
+ ```
118
+
119
+
120
+ ## Full Model Architecture
121
+ ```
122
+ SentenceTransformer(
123
+ (0): Transformer({'max_seq_length': 80, 'do_lower_case': True}) with Transformer model: LukeModel
124
+ (1): Pooling({'word_embedding_dimension': 768, '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})
125
+ )
126
+ ```
127
+
128
+ ## Citing & Authors
129
+
130
+ <!--- Describe where people can find more information -->
added_tokens.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "<ent2>": 32771,
3
+ "<ent>": 32770
4
+ }
config.json ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "cheonboy/sentence_embedding_japanese",
3
+ "architectures": [
4
+ "LukeModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bert_model_name": "models/luke-japanese/hf_xlm_roberta",
8
+ "bos_token_id": 0,
9
+ "classifier_dropout": null,
10
+ "cls_entity_prediction": false,
11
+ "entity_emb_size": 256,
12
+ "entity_vocab_size": 4,
13
+ "eos_token_id": 2,
14
+ "hidden_act": "gelu",
15
+ "hidden_dropout_prob": 0.1,
16
+ "hidden_size": 768,
17
+ "initializer_range": 0.02,
18
+ "intermediate_size": 3072,
19
+ "layer_norm_eps": 1e-05,
20
+ "max_position_embeddings": 514,
21
+ "model_type": "luke",
22
+ "num_attention_heads": 12,
23
+ "num_hidden_layers": 12,
24
+ "pad_token_id": 1,
25
+ "position_embedding_type": "absolute",
26
+ "torch_dtype": "float32",
27
+ "transformers_version": "4.41.2",
28
+ "type_vocab_size": 1,
29
+ "use_cache": true,
30
+ "use_entity_aware_attention": true,
31
+ "vocab_size": 32772
32
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.2.2",
4
+ "transformers": "4.27.1",
5
+ "pytorch": "1.13.1+cu116"
6
+ }
7
+ }
entity_vocab.json ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ {
2
+ "[MASK2]": 3,
3
+ "[MASK]": 0,
4
+ "[PAD]": 2,
5
+ "[UNK]": 1
6
+ }
eval/Information-Retrieval_evaluation_results.csv ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ epoch,steps,cos_sim-Accuracy@1,cos_sim-Accuracy@3,cos_sim-Accuracy@5,cos_sim-Accuracy@10,cos_sim-Precision@1,cos_sim-Recall@1,cos_sim-Precision@3,cos_sim-Recall@3,cos_sim-Precision@5,cos_sim-Recall@5,cos_sim-Precision@10,cos_sim-Recall@10,cos_sim-MRR@10,cos_sim-NDCG@10,cos_sim-MAP@100,dot_score-Accuracy@1,dot_score-Accuracy@3,dot_score-Accuracy@5,dot_score-Accuracy@10,dot_score-Precision@1,dot_score-Recall@1,dot_score-Precision@3,dot_score-Recall@3,dot_score-Precision@5,dot_score-Recall@5,dot_score-Precision@10,dot_score-Recall@10,dot_score-MRR@10,dot_score-NDCG@10,dot_score-MAP@100
2
+ 0,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
3
+ 1,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
4
+ 2,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
5
+ 3,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
6
+ 4,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
7
+ 5,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
8
+ 6,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
9
+ 7,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
10
+ 8,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
11
+ 9,-1,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5555555555555556,0.6623789802264932,0.5555555555555556,0.3333333333333333,0.6666666666666666,0.6666666666666666,1.0,0.3333333333333333,0.3333333333333333,0.2222222222222222,0.6666666666666666,0.13333333333333333,0.6666666666666666,0.10000000000000002,1.0,0.5,0.6187357290360074,0.5
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:aff24172a4f45dd782c759b1b48b952638de986fd0330a37f73302822eb77650
3
+ size 532299592
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": 80,
3
+ "do_lower_case": true
4
+ }
sentencepiece.bpe.model ADDED
Binary file (842 kB). View file
 
special_tokens_map.json ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "additional_special_tokens": [
3
+ {
4
+ "content": "<ent>",
5
+ "lstrip": false,
6
+ "normalized": true,
7
+ "rstrip": false,
8
+ "single_word": false
9
+ },
10
+ {
11
+ "content": "<ent2>",
12
+ "lstrip": false,
13
+ "normalized": true,
14
+ "rstrip": false,
15
+ "single_word": false
16
+ },
17
+ {
18
+ "content": "<ent>",
19
+ "lstrip": false,
20
+ "normalized": true,
21
+ "rstrip": false,
22
+ "single_word": false
23
+ },
24
+ {
25
+ "content": "<ent2>",
26
+ "lstrip": false,
27
+ "normalized": true,
28
+ "rstrip": false,
29
+ "single_word": false
30
+ },
31
+ {
32
+ "content": "<ent>",
33
+ "lstrip": false,
34
+ "normalized": true,
35
+ "rstrip": false,
36
+ "single_word": false
37
+ },
38
+ {
39
+ "content": "<ent2>",
40
+ "lstrip": false,
41
+ "normalized": true,
42
+ "rstrip": false,
43
+ "single_word": false
44
+ },
45
+ {
46
+ "content": "<ent>",
47
+ "lstrip": false,
48
+ "normalized": false,
49
+ "rstrip": false,
50
+ "single_word": false
51
+ },
52
+ {
53
+ "content": "<ent2>",
54
+ "lstrip": false,
55
+ "normalized": false,
56
+ "rstrip": false,
57
+ "single_word": false
58
+ },
59
+ {
60
+ "content": "<ent>",
61
+ "lstrip": false,
62
+ "normalized": true,
63
+ "rstrip": false,
64
+ "single_word": false
65
+ },
66
+ {
67
+ "content": "<ent2>",
68
+ "lstrip": false,
69
+ "normalized": true,
70
+ "rstrip": false,
71
+ "single_word": false
72
+ }
73
+ ],
74
+ "bos_token": "<s>",
75
+ "cls_token": "<s>",
76
+ "eos_token": "</s>",
77
+ "mask_token": {
78
+ "content": "<mask>",
79
+ "lstrip": true,
80
+ "normalized": true,
81
+ "rstrip": false,
82
+ "single_word": false
83
+ },
84
+ "pad_token": "<pad>",
85
+ "sep_token": "</s>",
86
+ "unk_token": "<unk>"
87
+ }
tokenizer_config.json ADDED
@@ -0,0 +1,108 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "32769": {
36
+ "content": "<mask>",
37
+ "lstrip": true,
38
+ "normalized": true,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ },
43
+ "32770": {
44
+ "content": "<ent>",
45
+ "lstrip": false,
46
+ "normalized": true,
47
+ "rstrip": false,
48
+ "single_word": false,
49
+ "special": true
50
+ },
51
+ "32771": {
52
+ "content": "<ent2>",
53
+ "lstrip": false,
54
+ "normalized": true,
55
+ "rstrip": false,
56
+ "single_word": false,
57
+ "special": true
58
+ }
59
+ },
60
+ "additional_special_tokens": [
61
+ "<ent>",
62
+ "<ent2>",
63
+ "<ent>",
64
+ "<ent2>",
65
+ "<ent>",
66
+ "<ent2>",
67
+ "<ent>",
68
+ "<ent2>",
69
+ "<ent>",
70
+ "<ent2>"
71
+ ],
72
+ "bos_token": "<s>",
73
+ "clean_up_tokenization_spaces": true,
74
+ "cls_token": "<s>",
75
+ "entity_mask2_token": "[MASK2]",
76
+ "entity_mask_token": "[MASK]",
77
+ "entity_pad_token": "[PAD]",
78
+ "entity_token_1": {
79
+ "__type": "AddedToken",
80
+ "content": "<ent>",
81
+ "lstrip": false,
82
+ "normalized": true,
83
+ "rstrip": false,
84
+ "single_word": false,
85
+ "special": false
86
+ },
87
+ "entity_token_2": {
88
+ "__type": "AddedToken",
89
+ "content": "<ent2>",
90
+ "lstrip": false,
91
+ "normalized": true,
92
+ "rstrip": false,
93
+ "single_word": false,
94
+ "special": false
95
+ },
96
+ "entity_unk_token": "[UNK]",
97
+ "eos_token": "</s>",
98
+ "mask_token": "<mask>",
99
+ "max_entity_length": 32,
100
+ "max_mention_length": 30,
101
+ "model_max_length": 512,
102
+ "pad_token": "<pad>",
103
+ "sep_token": "</s>",
104
+ "sp_model_kwargs": {},
105
+ "task": null,
106
+ "tokenizer_class": "MLukeTokenizer",
107
+ "unk_token": "<unk>"
108
+ }