Spaces:
Runtime error
Runtime error
Commit
·
73df029
1
Parent(s):
59f93f7
Upload folder using huggingface_hub
Browse files- src/cache/keepitreal_vietnamese-sbert/.gitattributes +27 -0
- src/cache/keepitreal_vietnamese-sbert/1_Pooling/config.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/README.md +126 -0
- src/cache/keepitreal_vietnamese-sbert/added_tokens.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/bpe.codes +0 -0
- src/cache/keepitreal_vietnamese-sbert/config.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/config_sentence_transformers.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/eval/similarity_evaluation_results.csv +5 -0
- src/cache/keepitreal_vietnamese-sbert/modules.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/pytorch_model.bin +3 -0
- src/cache/keepitreal_vietnamese-sbert/sentence_bert_config.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/special_tokens_map.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/tokenizer_config.json +3 -0
- src/cache/keepitreal_vietnamese-sbert/vocab.txt +0 -0
src/cache/keepitreal_vietnamese-sbert/.gitattributes
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
*.7z filter=lfs diff=lfs merge=lfs -text
|
| 2 |
+
*.arrow filter=lfs diff=lfs merge=lfs -text
|
| 3 |
+
*.bin filter=lfs diff=lfs merge=lfs -text
|
| 4 |
+
*.bin.* filter=lfs diff=lfs merge=lfs -text
|
| 5 |
+
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
| 6 |
+
*.ftz filter=lfs diff=lfs merge=lfs -text
|
| 7 |
+
*.gz filter=lfs diff=lfs merge=lfs -text
|
| 8 |
+
*.h5 filter=lfs diff=lfs merge=lfs -text
|
| 9 |
+
*.joblib filter=lfs diff=lfs merge=lfs -text
|
| 10 |
+
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
| 11 |
+
*.model filter=lfs diff=lfs merge=lfs -text
|
| 12 |
+
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
| 13 |
+
*.onnx filter=lfs diff=lfs merge=lfs -text
|
| 14 |
+
*.ot filter=lfs diff=lfs merge=lfs -text
|
| 15 |
+
*.parquet filter=lfs diff=lfs merge=lfs -text
|
| 16 |
+
*.pb filter=lfs diff=lfs merge=lfs -text
|
| 17 |
+
*.pt filter=lfs diff=lfs merge=lfs -text
|
| 18 |
+
*.pth filter=lfs diff=lfs merge=lfs -text
|
| 19 |
+
*.rar filter=lfs diff=lfs merge=lfs -text
|
| 20 |
+
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 21 |
+
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 22 |
+
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 23 |
+
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 24 |
+
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 25 |
+
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 26 |
+
*.zstandard filter=lfs diff=lfs merge=lfs -text
|
| 27 |
+
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
src/cache/keepitreal_vietnamese-sbert/1_Pooling/config.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:a37f83ada23e7887be6b88f4998927dbeac0038af301553c7cd5461413bf1a56
|
| 3 |
+
size 190
|
src/cache/keepitreal_vietnamese-sbert/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 |
+
- vietnamese
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# {vietnamese-sbert}
|
| 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 on Vietnamese language.
|
| 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 = ["Cô giáo đang ăn kem", "Chị gái đang thử món thịt dê"]
|
| 30 |
+
|
| 31 |
+
model = SentenceTransformer('keepitreal/vietnamese-sbert')
|
| 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 = ['Cô giáo đang ăn kem', 'Chị gái đang thử món thịt dê']
|
| 55 |
+
|
| 56 |
+
# Load model from HuggingFace Hub
|
| 57 |
+
tokenizer = AutoTokenizer.from_pretrained(''keepitreal/vietnamese-sbert')
|
| 58 |
+
model = AutoModel.from_pretrained('keepitreal/vietnamese-sbert')
|
| 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 360 with parameters:
|
| 89 |
+
```
|
| 90 |
+
{'batch_size': 16, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
**Loss**:
|
| 94 |
+
|
| 95 |
+
`sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss`
|
| 96 |
+
|
| 97 |
+
Parameters of the fit()-Method:
|
| 98 |
+
```
|
| 99 |
+
{
|
| 100 |
+
"epochs": 4,
|
| 101 |
+
"evaluation_steps": 1000,
|
| 102 |
+
"evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
|
| 103 |
+
"max_grad_norm": 1,
|
| 104 |
+
"optimizer_class": "<class 'transformers.optimization.AdamW'>",
|
| 105 |
+
"optimizer_params": {
|
| 106 |
+
"lr": 2e-05
|
| 107 |
+
},
|
| 108 |
+
"scheduler": "WarmupLinear",
|
| 109 |
+
"steps_per_epoch": null,
|
| 110 |
+
"warmup_steps": 144,
|
| 111 |
+
"weight_decay": 0.01
|
| 112 |
+
}
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
|
| 116 |
+
## Full Model Architecture
|
| 117 |
+
```
|
| 118 |
+
SentenceTransformer(
|
| 119 |
+
(0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: RobertaModel
|
| 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 -->
|
src/cache/keepitreal_vietnamese-sbert/added_tokens.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:895678a80ea84920b4240c0616a1b0b086368c7ca3cbacb80996a2b30b4f2b67
|
| 3 |
+
size 17
|
src/cache/keepitreal_vietnamese-sbert/bpe.codes
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
src/cache/keepitreal_vietnamese-sbert/config.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:0110b89c9597ad6a13174b632a40268a3441243d4273e23a60882ec7ec0181f4
|
| 3 |
+
size 752
|
src/cache/keepitreal_vietnamese-sbert/config_sentence_transformers.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:cba3a65b9a44b8047a542d6cf47ab5d530f5cc2ff509b4fea7d6cc26d3f5270b
|
| 3 |
+
size 122
|
src/cache/keepitreal_vietnamese-sbert/eval/similarity_evaluation_results.csv
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
epoch,steps,cosine_pearson,cosine_spearman,euclidean_pearson,euclidean_spearman,manhattan_pearson,manhattan_spearman,dot_pearson,dot_spearman
|
| 2 |
+
0,-1,0.8078286933987654,0.8068675782136558,0.7826592675151728,0.7868028226819643,0.7807693868686497,0.7844094389688113,0.750560538312266,0.7567512236263219
|
| 3 |
+
1,-1,0.8141910092889064,0.8132247090159028,0.7927358135349715,0.7967180091229377,0.7912690373690494,0.7950951810589162,0.7629149612065824,0.7688506534784273
|
| 4 |
+
2,-1,0.8213888261354507,0.8200802249399388,0.8014694226634118,0.8063164716361716,0.8002064148053362,0.8046039741807846,0.7731418158158698,0.7791783534950835
|
| 5 |
+
3,-1,0.8230233654608273,0.821893616196692,0.8035552172896905,0.8082517954348161,0.8024512539715857,0.806933904809289,0.7800862039068843,0.7844405198389021
|
src/cache/keepitreal_vietnamese-sbert/modules.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:8f4b264b80206c830bebbdcae377e137925650a433b689343a63bdc9b3145460
|
| 3 |
+
size 229
|
src/cache/keepitreal_vietnamese-sbert/pytorch_model.bin
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:f442320a1ae3cd68748245e47ca504703bb182f661af0e9acfd3e438aafeb104
|
| 3 |
+
size 540069681
|
src/cache/keepitreal_vietnamese-sbert/sentence_bert_config.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:fc1993fde0a95c24ec6c022539d41cf6e2f7c9721e5415d6fb6897472a9cd4b7
|
| 3 |
+
size 53
|
src/cache/keepitreal_vietnamese-sbert/special_tokens_map.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:7638f5bbbe86ef6d604ef28ad3647dc690d6d117c81c0d63e885416be8da1150
|
| 3 |
+
size 150
|
src/cache/keepitreal_vietnamese-sbert/tokenizer_config.json
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:81937c9c8c8587639fd8a42ebf19d51eed0bd1e1ed17601b31348b0c79019e46
|
| 3 |
+
size 313
|
src/cache/keepitreal_vietnamese-sbert/vocab.txt
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|