ko-sbert-sts / README.md
jhgan's picture
added citations
c38a7ae
metadata
pipeline_tag: sentence-similarity
tags:
  - sentence-transformers
  - feature-extraction
  - sentence-similarity

ko-sbert-sts

This is a sentence-transformers model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.

Usage (Sentence-Transformers)

๋ชจ๋ธ์„ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ko-sentence-transformers ๋ฅผ ์„ค์น˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

pip install -U ko-sentence-transformers

Then you can use the model like this:

from sentence_transformers import SentenceTransformer
sentences = ["์•ˆ๋…•ํ•˜์„ธ์š”?", "ํ•œ๊ตญ์–ด ๋ฌธ์žฅ ์ž„๋ฒ ๋”ฉ์„ ์œ„ํ•œ ๋ฒ„ํŠธ ๋ชจ๋ธ์ž…๋‹ˆ๋‹ค."]

model = SentenceTransformer('ko-sbert-sts')
embeddings = model.encode(sentences)
print(embeddings)

Evaluation Results

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:

DataLoader:

torch.utils.data.dataloader.DataLoader of length 719 with parameters:

{'batch_size': 8, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}

Loss:

sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss

Parameters of the fit()-Method:

{
    "epochs": 4,
    "evaluation_steps": 1000,
    "evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'transformers.optimization.AdamW'>",
    "optimizer_params": {
        "lr": 2e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": null,
    "warmup_steps": 288,
    "weight_decay": 0.01
}

Full Model Architecture

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
  (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})
)

Citing & Authors

  • Ham, J., Choe, Y. J., Park, K., Choi, I., & Soh, H. (2020). Kornli and korsts: New benchmark datasets for korean natural language understanding. arXiv preprint arXiv:2004.03289
  • Reimers, Nils and Iryna Gurevych. โ€œSentence-BERT: Sentence Embeddings using Siamese BERT-Networks.โ€ ArXiv abs/1908.10084 (2019)
  • Ko-Sentence-BERT-SKTBERT
  • KoBERT