ByoungYoon/bge-m3-poi-retrieval-ko

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 <!-- at revision f5e22522a1aff83e3f5ac8d0e2090e5fcfb5bdae -->
• —Maximum Sequence Length: 256 tokens
• —Output Dimensionality: 1024 dimensions
• —Similarity Function: Cosine Similarity
• —Training Datasets:
• —pairs
• —triplets <!-- - Language: Unknown --> <!-- - License: Unknown -->

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]])

<!--

Direct Usage (Transformers)

<details><summary>Click to see the direct usage in Transformers</summary>

</details> -->

<!--

Downstream Usage (Sentence Transformers)

You can finetune this model on your own dataset.

<details><summary>Click to expand</summary>

</details> -->

<!--

Out-of-Scope Use

List how the model may foreseeably be misused and address what users ought not to do with the model. -->

Evaluation

Metrics

Information Retrieval

• —Dataset: poi-val
• —Evaluated with <code>InformationRetrievalEvaluator</code>

<!--

Bias, Risks and Limitations

What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model. -->

<!--

Recommendations

What are recommendations with respect to the foreseeable issues? For example, filtering explicit content. -->

Training Details

Training Datasets

pairs

• —Dataset: pairs
• —Size: 70,044 training samples
• —Columns: <code>anchor</code> and <code>positive</code>
• —Approximate statistics based on the first 1000 samples: | | anchor | positive | |:--------|:---------------------------------------------------------------------------------|:------------------------------------------------------------------------------------| | type | string | string | | details | <ul><li>min: 5 tokens</li><li>mean: 9.72 tokens</li><li>max: 20 tokens</li></ul> | <ul><li>min: 23 tokens</li><li>mean: 45.23 tokens</li><li>max: 103 tokens</li></ul> |
• —Samples: | anchor | positive | |:-------------------------|:-----------------------------------------------------------------------------------------| | <code>와우리공영주차장</code> | <code>경기 화성시 봉담읍 와우리 봉담와우공영주차장 \| 화성시 봉담와우공영주차장 \| 봉담읍 봉담와우공영주차장 \| 와우리 봉담와우공영주차장</code> | | <code>역삼YK빌디</code> | <code>서울 강남구 역삼동 YK빌딩 \| 강남구 YK빌딩 \| 역삼동 YK빌딩</code> | | <code>대구레이지모닝동대구점</code> | <code>대구 동구 신천동 레이지모닝 동대구점 \| 동구 레이지모닝 동대구점 \| 신천동 레이지모닝 동대구점</code> |
• —Loss: <code>CachedMultipleNegativesRankingLoss</code> 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: <code>anchor</code>, <code>positive</code>, and <code>negative</code>
• —Approximate statistics based on the first 1000 samples: | | anchor | positive | negative | |:--------|:---------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------| | type | string | string | string | | details | <ul><li>min: 5 tokens</li><li>mean: 9.85 tokens</li><li>max: 20 tokens</li></ul> | <ul><li>min: 23 tokens</li><li>mean: 45.97 tokens</li><li>max: 103 tokens</li></ul> | <ul><li>min: 21 tokens</li><li>mean: 45.59 tokens</li><li>max: 103 tokens</li></ul> |
• —Samples: | anchor | positive | negative | |:----------------------|:-----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------| | <code>와우리공영주차장</code> | <code>경기 화성시 봉담읍 와우리 봉담와우공영주차장 \| 화성시 봉담와우공영주차장 \| 봉담읍 봉담와우공영주차장 \| 와우리 봉담와우공영주차장</code> | <code>충남 아산시 영인면 와우리 와우리마을회관 \| 아산시 와우리마을회관 \| 영인면 와우리마을회관 \| 와우리 와우리마을회관</code> | | <code>와우리공영주차장</code> | <code>경기 화성시 봉담읍 와우리 봉담와우공영주차장 \| 화성시 봉담와우공영주차장 \| 봉담읍 봉담와우공영주차장 \| 와우리 봉담와우공영주차장</code> | <code>서울 양천구 목동 우리공영주차장 \| 양천구 우리공영주차장 \| 목동 우리공영주차장</code> | | <code>역삼YK빌디</code> | <code>서울 강남구 역삼동 YK빌딩 \| 강남구 YK빌딩 \| 역삼동 YK빌딩</code> | <code>서울 강남구 역삼동 카이트타워 \| 강남구 카이트타워 \| 역삼동 카이트타워</code> |
• —Loss: <code>CachedMultipleNegativesRankingLoss</code> 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: steps
• —per_device_train_batch_size: 512
• —per_device_eval_batch_size: 512
• —learning_rate: 1e-05
• —num_train_epochs: 2
• —warmup_ratio: 0.1
• —bf16: True
• —load_best_model_at_end: True
• —batch_sampler: no_duplicates

All Hyperparameters

<details><summary>Click to expand</summary>

• —overwrite_output_dir: False
• —do_predict: False
• —eval_strategy: steps
• —prediction_loss_only: True
• —per_device_train_batch_size: 512
• —per_device_eval_batch_size: 512
• —per_gpu_train_batch_size: None
• —per_gpu_eval_batch_size: None
• —gradient_accumulation_steps: 1
• —eval_accumulation_steps: None
• —torch_empty_cache_steps: None
• —learning_rate: 1e-05
• —weight_decay: 0.0
• —adam_beta1: 0.9
• —adam_beta2: 0.999
• —adam_epsilon: 1e-08
• —max_grad_norm: 1.0
• —num_train_epochs: 2
• —max_steps: -1
• —lr_scheduler_type: linear
• —lr_scheduler_kwargs: None
• —warmup_ratio: 0.1
• —warmup_steps: 0
• —log_level: passive
• —log_level_replica: warning
• —log_on_each_node: True
• —logging_nan_inf_filter: True
• —save_safetensors: True
• —save_on_each_node: False
• —save_only_model: False
• —restore_callback_states_from_checkpoint: False
• —no_cuda: False
• —use_cpu: False
• —use_mps_device: False
• —seed: 42
• —data_seed: None
• —jit_mode_eval: False
• —bf16: True
• —fp16: False
• —fp16_opt_level: O1
• —half_precision_backend: auto
• —bf16_full_eval: False
• —fp16_full_eval: False
• —tf32: None
• —local_rank: 0
• —ddp_backend: None
• —tpu_num_cores: None
• —tpu_metrics_debug: False
• —debug: []
• —dataloader_drop_last: False
• —dataloader_num_workers: 0
• —dataloader_prefetch_factor: None
• —past_index: -1
• —disable_tqdm: False
• —remove_unused_columns: True
• —label_names: None
• —load_best_model_at_end: True
• —ignore_data_skip: False
• —fsdp: []
• —fsdp_min_num_params: 0
• —fsdp_config: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}
• —fsdp_transformer_layer_cls_to_wrap: None
• —accelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': None}
• —parallelism_config: None
• —deepspeed: None
• —label_smoothing_factor: 0.0
• —optim: adamw_torch
• —optim_args: None
• —adafactor: False
• —group_by_length: False
• —length_column_name: length
• —project: huggingface
• —trackio_space_id: trackio
• —ddp_find_unused_parameters: None
• —ddp_bucket_cap_mb: None
• —ddp_broadcast_buffers: False
• —dataloader_pin_memory: True
• —dataloader_persistent_workers: False
• —skip_memory_metrics: True
• —use_legacy_prediction_loop: False
• —push_to_hub: False
• —resume_from_checkpoint: None
• —hub_model_id: None
• —hub_strategy: every_save
• —hub_private_repo: None
• —hub_always_push: False
• —hub_revision: None
• —gradient_checkpointing: False
• —gradient_checkpointing_kwargs: None
• —include_inputs_for_metrics: False
• —include_for_metrics: []
• —eval_do_concat_batches: True
• —fp16_backend: auto
• —push_to_hub_model_id: None
• —push_to_hub_organization: None
• —mp_parameters:
• —auto_find_batch_size: False
• —full_determinism: False
• —torchdynamo: None
• —ray_scope: last
• —ddp_timeout: 1800
• —torch_compile: False
• —torch_compile_backend: None
• —torch_compile_mode: None
• —include_tokens_per_second: False
• —include_num_input_tokens_seen: no
• —neftune_noise_alpha: None
• —optim_target_modules: None
• —batch_eval_metrics: False
• —eval_on_start: False
• —use_liger_kernel: False
• —liger_kernel_config: None
• —eval_use_gather_object: False
• —average_tokens_across_devices: True
• —prompts: None
• —batch_sampler: no_duplicates
• —multi_dataset_batch_sampler: proportional
• —router_mapping: {}
• —learning_rate_mapping: {}

</details>

Training Logs

• —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}
}

<!--

Glossary

Clearly define terms in order to be accessible across audiences. -->

<!--

Model Card Authors

Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction. -->

<!--

Model Card Contact

Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors. -->