updated README.md

README.md

@@ -6,7 +6,7 @@ tags:
 - sentence-similarity
 ---
 
-# {MODEL_NAME}
+# ko-sbert-sts
 
 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,19 +14,19 @@ This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentence
 
 ## Usage (Sentence-Transformers)
 
-Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
+모델을 사용하기 위해서는 `ko-sentence-transformers` 를 설치해야 합니다.
 
 ```
-pip install -U sentence-transformers
+pip install -U ko-sentence-transformers
 ```
 
 Then you can use the model like this:
 
 ```python
 from sentence_transformers import SentenceTransformer
-sentences = ["This is an example sentence", "Each sentence is converted"]
+sentences = ["안녕하세요?", "한국어 문장 임베딩을 위한 버트 모델입니다."]
 
-model = SentenceTransformer('{MODEL_NAME}')
+model = SentenceTransformer('ko-sbert-sts')
 embeddings = model.encode(sentences)
 print(embeddings)
 ```
@@ -35,10 +35,16 @@ print(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={MODEL_NAME})
+KorSTS 학습 데이터셋으로 학습한 후 KorSTS 평가 데이터셋으로 평가한 결과입니다.
 
+- Cosine Pearson: 80.79
+- Cosine Spearman: 79.01
+- Euclidean Pearson: 78.03
+- Euclidean Spearman: 77.31
+- Manhattan Pearson: 78.08
+- Manhattan Spearman: 77.35
+- Dot Pearson: 75.96
+- Dot Spearman: 75.20
 
 ## Training
 The model was trained with the parameters:
@@ -83,4 +89,4 @@ SentenceTransformer(
 
 ## Citing & Authors
 
-<!--- Describe where people can find more information -->
+<!--- Describe where people can find more information -->