SentenceTransformer based on ByoungYoon/bge-m3-poi-retrieval-ko
This is a sentence-transformers model finetuned from ByoungYoon/bge-m3-poi-retrieval-ko on the pairs and triplets datasets. It maps sentences & paragraphs to a 1024-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
Model Details
Model Description
- Model Type: Sentence Transformer
- Base model: ByoungYoon/bge-m3-poi-retrieval-ko
- Maximum Sequence Length: 256 tokens
- Output Dimensionality: 1024 dimensions
- Similarity Function: Cosine Similarity
- Training Datasets:
- pairs
- triplets
Model Sources
- Documentation: Sentence Transformers Documentation
- Repository: Sentence Transformers on GitHub
- Hugging Face: Sentence Transformers on Hugging Face
Full Model Architecture
SentenceTransformer(
(0): Transformer({'max_seq_length': 256, 'do_lower_case': False, 'architecture': 'XLMRobertaModel'})
(1): Pooling({'word_embedding_dimension': 1024, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
(2): Normalize()
)
Usage
Direct Usage (Sentence Transformers)
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("sentence_transformers_model_id")
# Run inference
sentences = [
'공주초가집',
'충남 공주시 중동 초가집 | 공주시 초가집 | 중동 초가집',
'경기 성남시 분당구 이매동 청구아파트 | 성남시 청구아파트 | 분당구 청구아파트 | 이매동 청구아파트',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.8220, 0.0135],
# [0.8220, 1.0000, 0.0453],
# [0.0135, 0.0453, 1.0000]])
Evaluation
Metrics
Information Retrieval
- Dataset:
poi-val - Evaluated with InformationRetrievalEvaluator
| Metric | Value |
|---|---|
| cosine_accuracy@1 | 0.734 |
| cosine_accuracy@5 | 0.976 |
| cosine_accuracy@10 | 0.994 |
| cosine_precision@1 | 0.734 |
| cosine_precision@5 | 0.1952 |
| cosine_precision@10 | 0.0994 |
| cosine_recall@1 | 0.734 |
| cosine_recall@5 | 0.976 |
| cosine_recall@10 | 0.994 |
| cosine_ndcg@10 | 0.877 |
| cosine_mrr@10 | 0.8379 |
| cosine_map@10 | 0.8379 |
Training Details
Training Datasets
pairs
- Dataset: pairs
- Size: 70,044 training samples
- Columns: anchor and positive
- Approximate statistics based on the first 1000 samples:
anchor positive type string string details min: 5 tokensmean: 9.72 tokensmax: 20 tokens min: 23 tokensmean: 45.23 tokensmax: 103 tokens - Samples:
anchor positive 와우리공영주차장 경기 화성시 봉담읍 와우리 봉담와우공영주차장 | 화성시 봉담와우공영주차장 | 봉담읍 봉담와우공영주차장 | 와우리 봉담와우공영주차장 역삼YK빌디 서울 강남구 역삼동 YK빌딩 | 강남구 YK빌딩 | 역삼동 YK빌딩 대구레이지모닝동대구점 대구 동구 신천동 레이지모닝 동대구점 | 동구 레이지모닝 동대구점 | 신천동 레이지모닝 동대구점 - Loss: CachedMultipleNegativesRankingLoss with these parameters:
{ "scale": 20.0, "similarity_fct": "cos_sim", "mini_batch_size": 32, "gather_across_devices": false }
triplets
- Dataset: triplets
- Size: 139,540 training samples
- Columns: anchor, positive, and negative
- Approximate statistics based on the first 1000 samples:
anchor positive negative type string string string details min: 5 tokensmean: 9.85 tokensmax: 20 tokens min: 23 tokensmean: 45.97 tokensmax: 103 tokens min: 21 tokensmean: 45.59 tokensmax: 103 tokens - Samples:
anchor positive negative 와우리공영주차장 경기 화성시 봉담읍 와우리 봉담와우공영주차장 | 화성시 봉담와우공영주차장 | 봉담읍 봉담와우공영주차장 | 와우리 봉담와우공영주차장 충남 아산시 영인면 와우리 와우리마을회관 | 아산시 와우리마을회관 | 영인면 와우리마을회관 | 와우리 와우리마을회관 와우리공영주차장 경기 화성시 봉담읍 와우리 봉담와우공영주차장 | 화성시 봉담와우공영주차장 | 봉담읍 봉담와우공영주차장 | 와우리 봉담와우공영주차장 서울 양천구 목동 우리공영주차장 | 양천구 우리공영주차장 | 목동 우리공영주차장 역삼YK빌디 서울 강남구 역삼동 YK빌딩 | 강남구 YK빌딩 | 역삼동 YK빌딩 서울 강남구 역삼동 카이트타워 | 강남구 카이트타워 | 역삼동 카이트타워 - Loss: CachedMultipleNegativesRankingLoss with these parameters:
{ "scale": 20.0, "similarity_fct": "cos_sim", "mini_batch_size": 32, "gather_across_devices": false }
Training Hyperparameters
Non-Default Hyperparameters
eval_strategy: stepsper_device_train_batch_size: 512per_device_eval_batch_size: 512learning_rate: 1e-05num_train_epochs: 2warmup_ratio: 0.1bf16: Trueload_best_model_at_end: Truebatch_sampler: no_duplicates
All Hyperparameters
overwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 512per_device_eval_batch_size: 512per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 1e-05weight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 2max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_ratio: 0.1warmup_steps: 0log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Truesave_safetensors: Truesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseno_cuda: Falseuse_cpu: Falseuse_mps_device: Falseseed: 42data_seed: Nonejit_mode_eval: Falsebf16: Truefp16: Falsefp16_opt_level: O1half_precision_backend: autobf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonepast_index: -1disable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Trueignore_data_skip: Falsefsdp: []fsdp_min_num_params: 0fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}fsdp_transformer_layer_cls_to_wrap: Noneaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedeepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torchoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthproject: huggingfacetrackio_space_id: trackioddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Truedataloader_persistent_workers: Falseskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Falseresume_from_checkpoint: Nonehub_model_id: Nonehub_strategy: every_savehub_private_repo: Nonehub_always_push: Falsehub_revision: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseinclude_for_metrics: []eval_do_concat_batches: Truefp16_backend: autopush_to_hub_model_id: Nonepush_to_hub_organization: Nonemp_parameters:auto_find_batch_size: Falsefull_determinism: Falsetorchdynamo: Noneray_scope: lastddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: noneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseliger_kernel_config: Noneeval_use_gather_object: Falseaverage_tokens_across_devices: Trueprompts: Nonebatch_sampler: no_duplicatesmulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}
Training Logs
| Epoch | Step | Training Loss | poi-val_cosine_ndcg@10 |
|---|---|---|---|
| 0.1220 | 50 | 0.0399 | - |
| 0.2439 | 100 | 0.0386 | 0.8747 |
| 0.3659 | 150 | 0.0393 | - |
| 0.4878 | 200 | 0.0367 | 0.8681 |
| 0.6098 | 250 | 0.0323 | - |
| 0.7317 | 300 | 0.0347 | 0.8722 |
| 0.8537 | 350 | 0.0319 | - |
| 0.9756 | 400 | 0.0297 | 0.8724 |
| 1.0976 | 450 | 0.0263 | - |
| 1.2195 | 500 | 0.0267 | 0.8718 |
| 1.3415 | 550 | 0.0234 | - |
| 1.4634 | 600 | 0.0252 | 0.8711 |
| 1.5854 | 650 | 0.0227 | - |
| 1.7073 | 700 | 0.0273 | 0.8717 |
| 1.8293 | 750 | 0.0247 | - |
| 1.9512 | 800 | 0.0219 | 0.8770 |
- The bold row denotes the saved checkpoint.
Framework Versions
- Python: 3.10.18
- Sentence Transformers: 5.2.2
- Transformers: 4.57.6
- PyTorch: 2.7.1+cu126
- Accelerate: 1.12.0
- Datasets: 4.5.0
- Tokenizers: 0.22.2
Citation
BibTeX
Sentence Transformers
@inproceedings{reimers-2019-sentence-bert,
title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
author = "Reimers, Nils and Gurevych, Iryna",
booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
month = "11",
year = "2019",
publisher = "Association for Computational Linguistics",
url = "https://arxiv.org/abs/1908.10084",
}
CachedMultipleNegativesRankingLoss
@misc{gao2021scaling,
title={Scaling Deep Contrastive Learning Batch Size under Memory Limited Setup},
author={Luyu Gao and Yunyi Zhang and Jiawei Han and Jamie Callan},
year={2021},
eprint={2101.06983},
archivePrefix={arXiv},
primaryClass={cs.LG}
}