mrp commited on
Commit
86fe48b
1 Parent(s): 75d2706

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -104
README.md CHANGED
@@ -1,17 +1,9 @@
1
- ---
2
- pipeline_tag: sentence-similarity
3
- tags:
4
- - sentence-transformers
5
- - feature-extraction
6
- - sentence-similarity
7
- - transformers
8
- ---
9
-
10
- # {MODEL_NAME}
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
 
16
  ## Usage (Sentence-Transformers)
17
 
@@ -25,101 +17,9 @@ Then you can use the model like this:
25
 
26
  ```python
27
  from sentence_transformers import SentenceTransformer
28
- sentences = ["This is an example sentence", "Each sentence is converted"]
29
 
30
  model = SentenceTransformer('{MODEL_NAME}')
31
  embeddings = model.encode(sentences)
32
  print(embeddings)
33
- ```
34
-
35
-
36
-
37
- ## Usage (HuggingFace Transformers)
38
- 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.
39
-
40
- ```python
41
- from transformers import AutoTokenizer, AutoModel
42
- import torch
43
-
44
-
45
- def cls_pooling(model_output, attention_mask):
46
- return model_output[0][:,0]
47
-
48
-
49
- # Sentences we want sentence embeddings for
50
- sentences = ['This is an example sentence', 'Each sentence is converted']
51
-
52
- # Load model from HuggingFace Hub
53
- tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
54
- model = AutoModel.from_pretrained('{MODEL_NAME}')
55
-
56
- # Tokenize sentences
57
- encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
58
-
59
- # Compute token embeddings
60
- with torch.no_grad():
61
- model_output = model(**encoded_input)
62
-
63
- # Perform pooling. In this case, cls pooling.
64
- sentence_embeddings = cls_pooling(model_output, encoded_input['attention_mask'])
65
-
66
- print("Sentence embeddings:")
67
- print(sentence_embeddings)
68
- ```
69
-
70
-
71
-
72
- ## Evaluation Results
73
-
74
- <!--- Describe how your model was evaluated -->
75
-
76
- For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
77
-
78
-
79
- ## Training
80
- The model was trained with the parameters:
81
-
82
- **DataLoader**:
83
-
84
- `torch.utils.data.dataloader.DataLoader` of length 20500 with parameters:
85
- ```
86
- {'batch_size': 64, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
87
- ```
88
-
89
- **Loss**:
90
-
91
- `sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss` with parameters:
92
- ```
93
- {'scale': 20.0, 'similarity_fct': 'cos_sim'}
94
- ```
95
-
96
- Parameters of the fit()-Method:
97
- ```
98
- {
99
- "epochs": 1,
100
- "evaluation_steps": 0,
101
- "evaluator": "NoneType",
102
- "max_grad_norm": 1,
103
- "optimizer_class": "<class 'transformers.optimization.AdamW'>",
104
- "optimizer_params": {
105
- "lr": 3e-05
106
- },
107
- "scheduler": "WarmupLinear",
108
- "steps_per_epoch": null,
109
- "warmup_steps": 10000,
110
- "weight_decay": 0.01
111
- }
112
- ```
113
-
114
-
115
- ## Full Model Architecture
116
- ```
117
- SentenceTransformer(
118
- (0): Transformer({'max_seq_length': 32, 'do_lower_case': False}) with Transformer model: CamembertModel
119
- (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})
120
- )
121
- ```
122
-
123
- ## Citing & Authors
124
-
125
- <!--- Describe where people can find more information -->
1
+ # {mrp/simcse-model-wangchanberta}
 
 
 
 
 
 
 
 
 
2
 
3
  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.
4
 
5
  <!--- Describe your model here -->
6
+ 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)
7
 
8
  ## Usage (Sentence-Transformers)
9
 
17
 
18
  ```python
19
  from sentence_transformers import SentenceTransformer
20
+ sentences = ["ฉันนะคือคนรักชาติยังไงละ!", "พวกสามกีบล้มเจ้า!"]
21
 
22
  model = SentenceTransformer('{MODEL_NAME}')
23
  embeddings = model.encode(sentences)
24
  print(embeddings)
25
+ ```