Update README.md

README.md

@@ -1,21 +1,25 @@
 ---
 pipeline_tag: sentence-similarity
 tags:
-  - sentence-transformers
-  - feature-extraction
-  - sentence-similarity
-  - transformers
+- sentence-transformers
+- feature-extraction
+- sentence-similarity
+- transformers
 library_name: generic
 language:
-  - vi
-  - en
+- vi
 widget:
-  - source_sentence: 'Làm thế nào Đại học Bách khoa Hà Nội thu hút sinh viên quốc tế?'
-    sentences:
-      - 'Đại học Bách khoa Hà Nội đã phát triển các chương trình đào tạo bằng tiếng Anh để làm cho việc học tại đây dễ dàng hơn cho sinh viên quốc tế.'
-      - 'Môi trường học tập đa dạng và sự hỗ trợ đầy đủ cho sinh viên quốc tế tại Đại học Bách khoa Hà Nội giúp họ thích nghi nhanh chóng.'
-      - 'Hà Nội có khí hậu mát mẻ vào mùa thu.'
-      - 'Các món ăn ở Hà Nội rất ngon và đa dạng.'
+- source_sentence: Làm thế nào Đại học Bách khoa Hà Nội thu hút sinh viên quốc tế?
+  sentences:
+  - >-
+    Đại học Bách khoa Hà Nội đã phát triển các chương trình đào tạo bằng tiếng
+    Anh để làm cho việc học tại đây dễ dàng hơn cho sinh viên quốc tế.
+  - >-
+    Môi trường học tập đa dạng và sự hỗ trợ đầy đủ cho sinh viên quốc tế tại Đại
+    học Bách khoa Hà Nội giúp họ thích nghi nhanh chóng.
+  - Hà Nội có khí hậu mát mẻ vào mùa thu.
+  - Các món ăn ở Hà Nội rất ngon và đa dạng.
+license: apache-2.0
 ---
 
 # bkai-foundation-models/vietnamese-bi-encoder
@@ -26,7 +30,7 @@ We train the model on a merged training dataset that consists of:
   - Squadv2 (translated in Vietnamese)
   - 80% of the training set from the Legal Text Retrieval Zalo 2021 challenge
 
-We use phobert-base-v2 as the pre-trained backbone.
+We use [phobert-base-v2](https://github.com/VinAIResearch/PhoBERT) as the pre-trained backbone.
 
 Here are the results on the remaining 20% of the training set from the Legal Text Retrieval Zalo 2021 challenge:
 
@@ -52,7 +56,9 @@ Then you can use the model like this:
 
 ```python
 from sentence_transformers import SentenceTransformer
-sentences = ["Cô ấy là một người vui tính", "Cô ấy cười nói suốt cả ngày"]
+
+# INPUT TEXT MUST BE ALREADY WORD-SEGMENTED! 
+sentences = ["Cô ấy là một người vui_tính .", "Cô ấy cười nói suốt cả ngày ."]
 
 model = SentenceTransformer('bkai-foundation-models/vietnamese-bi-encoder')
 embeddings = model.encode(sentences)
@@ -75,8 +81,8 @@ def mean_pooling(model_output, attention_mask):
     return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
 
 
-# Sentences we want sentence embeddings for
-sentences = ['This is an example sentence', 'Each sentence is converted']
+# Sentences we want sentence embeddings, we could use pyvi, underthesea, RDRSegment to segment words
+sentences = ['Cô ấy là một người vui_tính .', 'Cô ấy cười nói suốt cả ngày .']
 
 # Load model from HuggingFace Hub
 tokenizer = AutoTokenizer.from_pretrained('bkai-foundation-models/vietnamese-bi-encoder')
@@ -96,12 +102,6 @@ print("Sentence embeddings:")
 print(sentence_embeddings)
 ```
 
-## Evaluation Results
-
-<!--- Describe how your model was evaluated -->
-
-For an automated evaluation of this model, see the _Sentence Embeddings Benchmark_: [https://seb.sbert.net](https://seb.sbert.net?model_name=bkai-foundation-models/vietnamese-bi-encoder)
-
 ## Training
 
 The model was trained with the parameters:
@@ -148,8 +148,4 @@ SentenceTransformer(
   (0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: RobertaModel
   (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, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False})
 )
-```
-
-## Citing & Authors
-
-<!--- Describe where people can find more information -->
+```