marigold334 commited on
Commit
ad32fce
1 Parent(s): ebc84b4

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
+ pytorch_model.bin 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,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pipeline_tag: sentence-similarity
3
+ tags:
4
+ - sentence-transformers
5
+ - feature-extraction
6
+ - sentence-similarity
7
+ - transformers
8
+ language:
9
+ - ko
10
+ widget:
11
+ - source_sentence: "그 식당은 파리를 날린다"
12
+ sentences:
13
+ - "그 식당에는 손님이 없다"
14
+ - "그 식당에서는 드론을 날린다"
15
+ - "파리가 식당에 날아다닌다"
16
+ example_title: "Restaurant"
17
+ - source_sentence: "잠이 옵니다"
18
+ sentences:
19
+ - "잠이 안 옵니다"
20
+ - "졸음이 옵니다"
21
+ - "기차가 옵니다"
22
+ example_title: "Sleepy"
23
+ ---
24
+
25
+ # snunlp/KR-SBERT-V40K-klueNLI-augSTS
26
+
27
+ 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.
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('snunlp/KR-SBERT-V40K-klueNLI-augSTS')
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('snunlp/KR-SBERT-V40K-klueNLI-augSTS')
72
+ model = AutoModel.from_pretrained('snunlp/KR-SBERT-V40K-klueNLI-augSTS')
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=snunlp/KR-SBERT-V40K-klueNLI-augSTS)
95
+
96
+
97
+
98
+ ## Full Model Architecture
99
+ ```
100
+ SentenceTransformer(
101
+ (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: BertModel
102
+ (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})
103
+ )
104
+ ```
105
+
106
+ ## Application for document classification
107
+
108
+ Tutorial in Google Colab: https://colab.research.google.com/drive/1S6WSjOx9h6Wh_rX1Z2UXwx9i_uHLlOiM
109
+
110
+
111
+ |Model|Accuracy|
112
+ |-|-|
113
+ |KR-SBERT-Medium-NLI-STS|0.8400|
114
+ |KR-SBERT-V40K-NLI-STS|0.8400|
115
+ |KR-SBERT-V40K-NLI-augSTS|0.8511|
116
+ |KR-SBERT-V40K-klueNLI-augSTS|**0.8628**|
117
+
118
+
119
+ ## Citation
120
+
121
+ ```bibtex
122
+ @misc{kr-sbert,
123
+ author = {Park, Suzi and Hyopil Shin},
124
+ title = {KR-SBERT: A Pre-trained Korean-specific Sentence-BERT model},
125
+ year = {2021},
126
+ publisher = {GitHub},
127
+ journal = {GitHub repository},
128
+ howpublished = {\url{https://github.com/snunlp/KR-SBERT}}
129
+ }
130
+ ```
config.json ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "C:\\Users\\eunsi/.cache\\torch\\sentence_transformers\\snunlp_KR-SBERT-V40K-klueNLI-augSTS\\",
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "classifier_dropout": null,
8
+ "gradient_checkpointing": false,
9
+ "hidden_act": "gelu",
10
+ "hidden_dropout_prob": 0.1,
11
+ "hidden_size": 768,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 3072,
14
+ "layer_norm_eps": 1e-12,
15
+ "max_position_embeddings": 512,
16
+ "model_type": "bert",
17
+ "num_attention_heads": 12,
18
+ "num_hidden_layers": 12,
19
+ "pad_token_id": 0,
20
+ "position_embedding_type": "absolute",
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.31.0",
23
+ "type_vocab_size": 2,
24
+ "use_cache": true,
25
+ "vocab_size": 40000
26
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.2.0",
4
+ "transformers": "4.18.0",
5
+ "pytorch": "1.11.0+cu102"
6
+ }
7
+ }
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:0c1849284257ee90d32d68269e88a5966166de51dddc3d42b58cf75d7c3a9d63
3
+ size 467109353
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,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
+ "clean_up_tokenization_spaces": true,
3
+ "cls_token": "[CLS]",
4
+ "do_basic_tokenize": true,
5
+ "do_lower_case": false,
6
+ "mask_token": "[MASK]",
7
+ "model_max_length": 1000000000000000019884624838656,
8
+ "never_split": null,
9
+ "pad_token": "[PAD]",
10
+ "sep_token": "[SEP]",
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