kornwtp commited on
Commit
98c18bb
1 Parent(s): 7cfb61f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -97
README.md CHANGED
@@ -1,18 +1,18 @@
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
 
@@ -26,101 +26,9 @@ 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
- def cls_pooling(model_output, attention_mask):
47
- return model_output[0][:,0]
48
-
49
-
50
- # Sentences we want sentence embeddings for
51
- sentences = ['This is an example sentence', 'Each sentence is converted']
52
-
53
- # Load model from HuggingFace Hub
54
- tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
55
- model = AutoModel.from_pretrained('{MODEL_NAME}')
56
-
57
- # Tokenize sentences
58
- encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
59
-
60
- # Compute token embeddings
61
- with torch.no_grad():
62
- model_output = model(**encoded_input)
63
-
64
- # Perform pooling. In this case, cls pooling.
65
- sentence_embeddings = cls_pooling(model_output, encoded_input['attention_mask'])
66
-
67
- print("Sentence embeddings:")
68
- print(sentence_embeddings)
69
- ```
70
-
71
-
72
-
73
- ## Evaluation Results
74
-
75
- <!--- Describe how your model was evaluated -->
76
-
77
- For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
78
-
79
-
80
- ## Training
81
- The model was trained with the parameters:
82
-
83
- **DataLoader**:
84
-
85
- `torch.utils.data.dataloader.DataLoader` of length 10250 with parameters:
86
- ```
87
- {'batch_size': 128, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
88
- ```
89
-
90
- **Loss**:
91
-
92
- `sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss` with parameters:
93
- ```
94
- {'scale': 20.0, 'similarity_fct': 'cos_sim'}
95
- ```
96
-
97
- Parameters of the fit()-Method:
98
- ```
99
- {
100
- "epochs": 1,
101
- "evaluation_steps": 1025,
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": 0.0001
107
- },
108
- "scheduler": "WarmupLinear",
109
- "steps_per_epoch": null,
110
- "warmup_steps": 1025,
111
- "weight_decay": 0.01
112
- }
113
- ```
114
-
115
-
116
- ## Full Model Architecture
117
- ```
118
- SentenceTransformer(
119
- (0): Transformer({'max_seq_length': 32, 'do_lower_case': False}) with Transformer model: CamembertModel
120
- (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False})
121
- )
122
- ```
123
-
124
- ## Citing & Authors
125
-
126
- <!--- Describe where people can find more information -->
 
1
  ---
2
+ license: apache-2.0
3
  pipeline_tag: sentence-similarity
4
  tags:
5
  - sentence-transformers
6
  - feature-extraction
7
  - sentence-similarity
8
  - transformers
 
9
  ---
10
+ # {kornwtp/simcse-model-phayathaibert}
 
11
 
12
  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.
13
 
14
  <!--- Describe your model here -->
15
+ We use SimCSE [here](https://arxiv.org/pdf/2104.08821.pdf) by using mBERT as the baseline model and training the model with Thai Wikipedia [here](https://github.com/PyThaiNLP/ThaiWiki-clean/releases/tag/20210620?fbclid=IwAR1YcmZkb-xd1ibTWCJOcu98_FQ5x3ioZaGW1ME-VHy9fAQLhEr5tXTJygA)
16
 
17
  ## Usage (Sentence-Transformers)
18
 
 
26
 
27
  ```python
28
  from sentence_transformers import SentenceTransformer
29
+ sentences = ["ฉันนะคือคนรักชาติยังไงละ!", "พวกสามกีบล้มเจ้า!"]
30
 
31
  model = SentenceTransformer('{MODEL_NAME}')
32
  embeddings = model.encode(sentences)
33
  print(embeddings)
34
+ ```