Update README.md
Browse files
README.md
CHANGED
@@ -3,11 +3,12 @@
|
|
3 |
1. [Introduction](#introduction)
|
4 |
2. [Pretrain model](#models)
|
5 |
3. [Using SimeCSE_Vietnamese with `sentences-transformers`](#sentences-transformers)
|
6 |
-
|
7 |
-
|
8 |
4. [Using SimeCSE_Vietnamese with `transformers`](#transformers)
|
9 |
-
|
10 |
-
|
|
|
11 |
# <a name="introduction"></a> SimeCSE_Vietnamese: Simple Contrastive Learning of Sentence Embeddings with Vietnamese
|
12 |
|
13 |
Pre-trained SimeCSE_Vietnamese models are the state-of-the-art of Sentence Embeddings with Vietnamese :
|
@@ -19,7 +20,7 @@ Pre-trained SimeCSE_Vietnamese models are the state-of-the-art of Sentence Embed
|
|
19 |
## Pre-trained models <a name="models"></a>
|
20 |
|
21 |
|
22 |
-
Model | #params | Arch
|
23 |
---|---|---
|
24 |
[`VoVanPhuc/sup-SimCSE-VietNamese-phobert-base`](https://huggingface.co/VoVanPhuc/sup-SimCSE-VietNamese-phobert-base) | 135M | base
|
25 |
[`VoVanPhuc/unsup-SimCSE-VietNamese-phobert-base`](https://huggingface.co/VoVanPhuc/unsup-SimCSE-VietNamese-phobert-base) | 135M | base
|
@@ -30,8 +31,8 @@ Model | #params | Arch.
|
|
30 |
|
31 |
### Installation <a name="install1"></a>
|
32 |
- Install `sentence-transformers`:
|
33 |
-
|
34 |
-
|
35 |
|
36 |
### Example usage <a name="usage1"></a>
|
37 |
|
@@ -58,8 +59,8 @@ embeddings = model.encode(sentences)
|
|
58 |
|
59 |
### Installation <a name="install2"></a>
|
60 |
- Install `transformers`:
|
61 |
-
|
62 |
-
|
63 |
|
64 |
### Example usage <a name="usage2"></a>
|
65 |
|
@@ -93,12 +94,12 @@ with torch.no_grad():
|
|
93 |
## Citation
|
94 |
|
95 |
|
96 |
-
|
97 |
-
|
98 |
-
|
99 |
-
|
100 |
-
|
101 |
-
|
102 |
|
103 |
@inproceedings{phobert,
|
104 |
title = {{PhoBERT: Pre-trained language models for Vietnamese}},
|
|
|
3 |
1. [Introduction](#introduction)
|
4 |
2. [Pretrain model](#models)
|
5 |
3. [Using SimeCSE_Vietnamese with `sentences-transformers`](#sentences-transformers)
|
6 |
+
\t- [Installation](#install1)
|
7 |
+
\t- [Example usage](#usage1)
|
8 |
4. [Using SimeCSE_Vietnamese with `transformers`](#transformers)
|
9 |
+
\t- [Installation](#install2)
|
10 |
+
|
11 |
+
\t- [Example usage](#usage2)
|
12 |
# <a name="introduction"></a> SimeCSE_Vietnamese: Simple Contrastive Learning of Sentence Embeddings with Vietnamese
|
13 |
|
14 |
Pre-trained SimeCSE_Vietnamese models are the state-of-the-art of Sentence Embeddings with Vietnamese :
|
|
|
20 |
## Pre-trained models <a name="models"></a>
|
21 |
|
22 |
|
23 |
+
Model | #params | Arch.\t
|
24 |
---|---|---
|
25 |
[`VoVanPhuc/sup-SimCSE-VietNamese-phobert-base`](https://huggingface.co/VoVanPhuc/sup-SimCSE-VietNamese-phobert-base) | 135M | base
|
26 |
[`VoVanPhuc/unsup-SimCSE-VietNamese-phobert-base`](https://huggingface.co/VoVanPhuc/unsup-SimCSE-VietNamese-phobert-base) | 135M | base
|
|
|
31 |
|
32 |
### Installation <a name="install1"></a>
|
33 |
- Install `sentence-transformers`:
|
34 |
+
\t- `pip install -U sentence-transformers`
|
35 |
+
\t
|
36 |
|
37 |
### Example usage <a name="usage1"></a>
|
38 |
|
|
|
59 |
|
60 |
### Installation <a name="install2"></a>
|
61 |
- Install `transformers`:
|
62 |
+
\t- `pip install -U transformers`
|
63 |
+
\t
|
64 |
|
65 |
### Example usage <a name="usage2"></a>
|
66 |
|
|
|
94 |
## Citation
|
95 |
|
96 |
|
97 |
+
\t@article{gao2021simcse,
|
98 |
+
\t title={{SimCSE}: Simple Contrastive Learning of Sentence Embeddings},
|
99 |
+
\t author={Gao, Tianyu and Yao, Xingcheng and Chen, Danqi},
|
100 |
+
\t journal={arXiv preprint arXiv:2104.08821},
|
101 |
+
\t year={2021}
|
102 |
+
\t}
|
103 |
|
104 |
@inproceedings{phobert,
|
105 |
title = {{PhoBERT: Pre-trained language models for Vietnamese}},
|