Upload 12 files
Browse files- 1_Pooling/config.json +7 -0
- README.md +126 -0
- config.json +25 -0
- config_sentence_transformers.json +7 -0
- eval/similarity_evaluation_sts-dev_results.csv +26 -0
- modules.json +14 -0
- pytorch_model.bin +3 -0
- sentence_bert_config.json +4 -0
- special_tokens_map.json +7 -0
- tokenizer.json +0 -0
- tokenizer_config.json +15 -0
- vocab.txt +0 -0
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,126 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
pipeline_tag: sentence-similarity
|
| 3 |
+
tags:
|
| 4 |
+
- sentence-transformers
|
| 5 |
+
- feature-extraction
|
| 6 |
+
- sentence-similarity
|
| 7 |
+
- transformers
|
| 8 |
+
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# {MODEL_NAME}
|
| 12 |
+
|
| 13 |
+
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.
|
| 14 |
+
|
| 15 |
+
<!--- Describe your model here -->
|
| 16 |
+
|
| 17 |
+
## Usage (Sentence-Transformers)
|
| 18 |
+
|
| 19 |
+
Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
|
| 20 |
+
|
| 21 |
+
```
|
| 22 |
+
pip install -U sentence-transformers
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
Then you can use the model like this:
|
| 26 |
+
|
| 27 |
+
```python
|
| 28 |
+
from sentence_transformers import SentenceTransformer
|
| 29 |
+
sentences = ["This is an example sentence", "Each sentence is converted"]
|
| 30 |
+
|
| 31 |
+
model = SentenceTransformer('{MODEL_NAME}')
|
| 32 |
+
embeddings = model.encode(sentences)
|
| 33 |
+
print(embeddings)
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
## Usage (HuggingFace Transformers)
|
| 39 |
+
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.
|
| 40 |
+
|
| 41 |
+
```python
|
| 42 |
+
from transformers import AutoTokenizer, AutoModel
|
| 43 |
+
import torch
|
| 44 |
+
|
| 45 |
+
|
| 46 |
+
#Mean Pooling - Take attention mask into account for correct averaging
|
| 47 |
+
def mean_pooling(model_output, attention_mask):
|
| 48 |
+
token_embeddings = model_output[0] #First element of model_output contains all token embeddings
|
| 49 |
+
input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
|
| 50 |
+
return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
# Sentences we want sentence embeddings for
|
| 54 |
+
sentences = ['This is an example sentence', 'Each sentence is converted']
|
| 55 |
+
|
| 56 |
+
# Load model from HuggingFace Hub
|
| 57 |
+
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
|
| 58 |
+
model = AutoModel.from_pretrained('{MODEL_NAME}')
|
| 59 |
+
|
| 60 |
+
# Tokenize sentences
|
| 61 |
+
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
|
| 62 |
+
|
| 63 |
+
# Compute token embeddings
|
| 64 |
+
with torch.no_grad():
|
| 65 |
+
model_output = model(**encoded_input)
|
| 66 |
+
|
| 67 |
+
# Perform pooling. In this case, mean pooling.
|
| 68 |
+
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
|
| 69 |
+
|
| 70 |
+
print("Sentence embeddings:")
|
| 71 |
+
print(sentence_embeddings)
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
|
| 75 |
+
|
| 76 |
+
## Evaluation Results
|
| 77 |
+
|
| 78 |
+
<!--- Describe how your model was evaluated -->
|
| 79 |
+
|
| 80 |
+
For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
|
| 81 |
+
|
| 82 |
+
|
| 83 |
+
## Training
|
| 84 |
+
The model was trained with the parameters:
|
| 85 |
+
|
| 86 |
+
**DataLoader**:
|
| 87 |
+
|
| 88 |
+
`torch.utils.data.dataloader.DataLoader` of length 4299 with parameters:
|
| 89 |
+
```
|
| 90 |
+
{'batch_size': 128, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
**Loss**:
|
| 94 |
+
|
| 95 |
+
`sentence_transformers.losses.SoftmaxLoss.SoftmaxLoss`
|
| 96 |
+
|
| 97 |
+
Parameters of the fit()-Method:
|
| 98 |
+
```
|
| 99 |
+
{
|
| 100 |
+
"epochs": 5,
|
| 101 |
+
"evaluation_steps": 1000,
|
| 102 |
+
"evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
|
| 103 |
+
"max_grad_norm": 1,
|
| 104 |
+
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
|
| 105 |
+
"optimizer_params": {
|
| 106 |
+
"lr": 2e-05
|
| 107 |
+
},
|
| 108 |
+
"scheduler": "WarmupLinear",
|
| 109 |
+
"steps_per_epoch": null,
|
| 110 |
+
"warmup_steps": 2150,
|
| 111 |
+
"weight_decay": 0.01
|
| 112 |
+
}
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
|
| 116 |
+
## Full Model Architecture
|
| 117 |
+
```
|
| 118 |
+
SentenceTransformer(
|
| 119 |
+
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel
|
| 120 |
+
(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})
|
| 121 |
+
)
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
## Citing & Authors
|
| 125 |
+
|
| 126 |
+
<!--- Describe where people can find more information -->
|
config.json
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"_name_or_path": "klue/bert-base",
|
| 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": 768,
|
| 11 |
+
"initializer_range": 0.02,
|
| 12 |
+
"intermediate_size": 3072,
|
| 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 |
+
"torch_dtype": "float32",
|
| 21 |
+
"transformers_version": "4.27.1",
|
| 22 |
+
"type_vocab_size": 2,
|
| 23 |
+
"use_cache": true,
|
| 24 |
+
"vocab_size": 32000
|
| 25 |
+
}
|
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": "2.0.0+cu117"
|
| 6 |
+
}
|
| 7 |
+
}
|
eval/similarity_evaluation_sts-dev_results.csv
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
epoch,steps,cosine_pearson,cosine_spearman,euclidean_pearson,euclidean_spearman,manhattan_pearson,manhattan_spearman,dot_pearson,dot_spearman
|
| 2 |
+
0,1000,0.6659445577398593,0.6725674704728215,0.6723452888988094,0.6822943404791594,0.6734938259336746,0.6821095244744039,0.3542827688117064,0.375129710282081
|
| 3 |
+
0,2000,0.7445418679821378,0.7582711568781528,0.7445695278411221,0.7491769678535929,0.7475482682410554,0.7505806033926292,0.6516841702963634,0.644625132585104
|
| 4 |
+
0,3000,0.7611784379058513,0.7753377401337672,0.7624915976151901,0.7632756985425497,0.7652650662972923,0.7652178046176139,0.7098410157266418,0.7011994433368494
|
| 5 |
+
0,4000,0.7664600822011544,0.7779506682370195,0.7650158186547508,0.7654782418404968,0.7667586961684713,0.7666540418535448,0.727029545107196,0.7192756402575862
|
| 6 |
+
0,-1,0.7588258721580844,0.7711649812292414,0.7601431094101754,0.7596844164327338,0.7621491474434782,0.760718430958818,0.7313404813612134,0.72580007132318
|
| 7 |
+
1,1000,0.7681415905613104,0.777508008176866,0.7682184877759901,0.7668035939752597,0.769902357010777,0.7680304845071181,0.7356156982138174,0.7283572995579198
|
| 8 |
+
1,2000,0.7742120345102455,0.7860305900388165,0.7759786697854631,0.7749660088971759,0.7773815931917177,0.7761238737801722,0.7512480467845594,0.7458176276860289
|
| 9 |
+
1,3000,0.7647251199713558,0.7771782972876436,0.7665557513521478,0.765477140678158,0.7676985718948486,0.7663204782455075,0.7376264851464495,0.7317939353845909
|
| 10 |
+
1,4000,0.7668508603746315,0.7790608424134365,0.7701015147433578,0.7689631339375641,0.770994674550495,0.7695494001528361,0.7456712056866467,0.7405603180080812
|
| 11 |
+
1,-1,0.7760705299905457,0.7865357437398377,0.7780168812553343,0.7771877811960934,0.7792550113966342,0.7779340379441579,0.7491237807112845,0.7426565371966939
|
| 12 |
+
2,1000,0.7660973752800285,0.7762150485839853,0.7688767895910371,0.7677178084012513,0.7689664980913219,0.7676394568627904,0.7415639545225098,0.7360860159879333
|
| 13 |
+
2,2000,0.7700804712898738,0.7788857557932253,0.771832930736482,0.7710945591804985,0.7720733512196799,0.771066148814079,0.7434970099554319,0.7377385108546101
|
| 14 |
+
2,3000,0.7702978801686402,0.7778519973483153,0.7708395189129182,0.7697618760736129,0.771446051956762,0.7702827141041502,0.7453960977637094,0.7399275204183559
|
| 15 |
+
2,4000,0.7752618062959603,0.7842447684883692,0.7752988490279625,0.7749458002964081,0.7765941762394749,0.7759540095833968,0.7522018583387206,0.746806940632618
|
| 16 |
+
2,-1,0.7769924633068857,0.7853148326056885,0.7767178530645548,0.7761386300181663,0.7778289365232416,0.7771303993893972,0.7502759132840352,0.7443259887337296
|
| 17 |
+
3,1000,0.7707249689780824,0.7778895006387035,0.7708852962346351,0.7701954497389991,0.7711964157647142,0.770465342070147,0.7485131409970578,0.7435443349631866
|
| 18 |
+
3,2000,0.765345392865508,0.7731846481447531,0.7670651163456563,0.7658387065033504,0.7665886261301962,0.7659464699232981,0.7466526408746222,0.7426952109404683
|
| 19 |
+
3,3000,0.770412475126673,0.777182000430369,0.7706925644799741,0.770204956042818,0.7707740381323195,0.7701862496240816,0.7486840138355021,0.7437404056119462
|
| 20 |
+
3,4000,0.769441727952264,0.7762049685056753,0.7691023986611366,0.7687227127459159,0.7690761360339188,0.7689583893373857,0.745167440673268,0.7409386483057541
|
| 21 |
+
3,-1,0.7708295482636287,0.7781358477883977,0.7718077788542748,0.7710027136441666,0.7717687967013193,0.7712107447231016,0.7491866506658181,0.7451200193260054
|
| 22 |
+
4,1000,0.7691328551057761,0.7752461688945677,0.7695093852796154,0.7687449240924131,0.7693905324881671,0.7688976659206208,0.7484561215714696,0.7441252526243871
|
| 23 |
+
4,2000,0.7695307937731882,0.7754710373811518,0.7692735938071544,0.7688034903820917,0.7691593254608746,0.7692798728634921,0.7461848158566525,0.7414715626070804
|
| 24 |
+
4,3000,0.7690492243658177,0.7753930913959958,0.770085621692888,0.7694832559787814,0.7700100236708824,0.7698577832028968,0.7469965841675125,0.7425053620550033
|
| 25 |
+
4,4000,0.7680466132561923,0.7742937251598457,0.768606388499023,0.7679242559927304,0.7684488738824462,0.768282112112849,0.7459098688242687,0.7414001691214792
|
| 26 |
+
4,-1,0.7679647659540607,0.7742325596361201,0.768522572235958,0.7678292114428155,0.7683798142983765,0.7681453415553424,0.7460022278231219,0.7415731592238808
|
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 |
+
]
|
pytorch_model.bin
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:765e6d6553116c144ddfeb890861d235ed5d48a044e953fcddf356a2bc5a153e
|
| 3 |
+
size 442540589
|
sentence_bert_config.json
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"max_seq_length": 512,
|
| 3 |
+
"do_lower_case": false
|
| 4 |
+
}
|
special_tokens_map.json
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"cls_token": "[CLS]",
|
| 3 |
+
"mask_token": "[MASK]",
|
| 4 |
+
"pad_token": "[PAD]",
|
| 5 |
+
"sep_token": "[SEP]",
|
| 6 |
+
"unk_token": "[UNK]"
|
| 7 |
+
}
|
tokenizer.json
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
tokenizer_config.json
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"cls_token": "[CLS]",
|
| 3 |
+
"do_basic_tokenize": true,
|
| 4 |
+
"do_lower_case": false,
|
| 5 |
+
"mask_token": "[MASK]",
|
| 6 |
+
"model_max_length": 512,
|
| 7 |
+
"never_split": null,
|
| 8 |
+
"pad_token": "[PAD]",
|
| 9 |
+
"sep_token": "[SEP]",
|
| 10 |
+
"special_tokens_map_file": "/home/yyoo/.cache/huggingface/hub/models--klue--bert-base/snapshots/34b965303f98bc5214daca7f76b7fb82d2dc6183/special_tokens_map.json",
|
| 11 |
+
"strip_accents": null,
|
| 12 |
+
"tokenize_chinese_chars": true,
|
| 13 |
+
"tokenizer_class": "BertTokenizer",
|
| 14 |
+
"unk_token": "[UNK]"
|
| 15 |
+
}
|
vocab.txt
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|