Upload with huggingface_hub

README.md

@@ -4,17 +4,17 @@ tags:
 - sentence-transformers
 - sentence-similarity
 - transformers
-lan: Korean
+language: ko
 ---
 
 # TAACO_Similarity
 
-본 모델은 Sentence-transformers[sentence-transformers](https://www.SBERT.net)를 기반으로 하며 KLUE의 STS(Sentence Textual Similarity) 데이터셋을 통해 훈련을 진행한 모델입니다. 필자가 제작하고 있는 한국어 문장간 결속성
+본 모델은 [ㄴentence-transformers](https://www.SBERT.net)를 기반으로 하며 KLUE의 STS(Sentence Textual Similarity) 데이터셋을 통해 훈련을 진행한 모델입니다. 필자가 제작하고 있는 한국어 문장간 결속성
 측정 도구인 K-TAACO(가제)의 지표 중 하나인 문장 간 의미적 결속성을 측정하기 위해 제작하였습니다. 또한 모두의 말뭉치의 문장간 유사도 데이터셋을 통해서도 훈련을 진행할 예정입니다.
 
 ## Usage (Sentence-Transformers)
 
-본 모델을 사용하기 위해서는 Sentence-Transformer [sentence-transformers](https://www.SBERT.net)를 설치하여야 합니다.
+본 모델을 사용하기 위해서는 [Sentence-transformers](https://www.SBERT.net)를 설치하여야 합니다.
 
 ```
 pip install -U sentence-transformers
@@ -33,7 +33,7 @@ print(embeddings)
 
 
 ## Usage (실제 문장 간 유사도 비교)
-Sentence-transformers [sentence-transformers](https://www.SBERT.net) 를 설치한 후 아래 내용과 같이 문장 간 유사도를 비교할 수 있습니다.
+[Sentence-transformers](https://www.SBERT.net) 를 설치한 후 아래 내용과 같이 문장 간 유사도를 비교할 수 있습니다.
 query 변수는 비교 기준이 되는 문장(Source Sentence)이고 비교를 진행할 문장은 docs에 list 형식으로 구성하시면 됩니다.
 
 ```python
@@ -65,11 +65,33 @@ for i, (score, idx) in enumerate(zip(top_results[0], top_results[1])):
 
 ## Evaluation Results
 
-<!--- Describe how your model was evaluated -->
+위 예시(Usage)를 실행하게 되면 아래와 같은 결과가 도출됩니다. 1에 가까울수록 유사한 문장입니다.
 
-For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
+'''python
+입력 문장: 생일을 맞이하여 아침을 준비하겠다고 오전 8시 30분부터 음식을 준비하였다
 
-문장 간 유사도는 1이 최댓값이며, 0에 가까울수록 의미적으로 유사하지 않은 문장입니다.
+<입력 문장과 유사한 10 개의 문장>
+
+1: 생일을 맞이하여 아침을 준비하겠다고 오전 8시 30분부터 음식을 준비하였다. 주된 메뉴는 스테이크와 낙지볶음, 미역국, 잡채, 소야 등이었다 (유사도: 0.6687)
+
+2: 매년 아내의 생일에 맞이하면 아침마다 생일을 차려야겠다. 오늘도 즐거운 하루가 되었으면 좋겠다 (유사도: 0.6468)
+
+3: 40번째를 맞이하는 아내의 생일은 성공적으로 준비가 되었다 (유사도: 0.4647)
+
+4: 아내의 생일이라 맛있게 구워보고 싶었는데 어처구니없는 상황이 발생한 것이다 (유사도: 0.4469)
+
+5: 생일이니까~ (유사도: 0.4218)
+
+6: 어제는 아내의 생일이었다 (유사도: 0.4192)
+
+7: 아침 일찍 아내가 좋아하는 스테이크를 준비하고 그것을 맛있게 먹는 아내의 모습을 보고 싶었는데 전혀 생각지도 못한 상황이 발생해서... 하지만 정신을 추스르고 바로 다른 메뉴로 변경했다 (유사도: 0.4156)
+
+8: 맛있게 먹어 준 아내에게도 감사했다 (유사도: 0.3093)
+
+9: 아내가 좋아하는지 모르겠지만 냉장고 안에 있는 후랑크소세지를 보니 바로 소야를 해야겠다는 생각이 들었다. 음식은 성공적으로 완성이 되었다 (유사도: 0.2259)
+
+10: 아내도 그런 스테이크를 좋아한다. 그런데 상상도 못한 일이 벌이지고 말았다 (유사도: 0.1967)
+'''
 
 ## Training
 The model was trained with the parameters: