Add Matryoshka family table (64/128/256/512)

README.md

@@ -1,455 +1,75 @@
 ---
+language:
+- ko
+license: apache-2.0
+library_name: sentence-transformers
+pipeline_tag: sentence-similarity
 tags:
 - sentence-transformers
 - sentence-similarity
 - feature-extraction
-- generated_from_trainer
-- dataset_size:277826
-- loss:MultipleNegativesRankingLoss
-- loss:MatryoshkaLoss
-- loss:CosineSimilarityLoss
-widget:
-- source_sentence: 아무도 일어나 앉을 필요가 없다.
-  sentences:
-  - 앉으세요.
-  - 푸아로는 신시아가 일하는 병원에 있는 약국을 방문하고 싶었다.
-  - 일어나 앉지 마세요.
-- source_sentence: 내 말은, 그게 네가 아는 사람들이 그녀가 간직하고 있는 그런 종류의 것들이야. 그리고 이것이 시간낭비라는 것을
-    보여주는 거야. 그건 종이 낭비였어. 네가 아는 그런 것을 바꾸는 건 낭비였어.
-  sentences:
-  - 그녀는 시간과 종이를 낭비했다.
-  - 돈은 계산을 통해 시간이 지남에 따라 성장할 수 있다.
-  - 그녀가 한 모든 일은 생산적이고 가치 있는 일이었다.
-- source_sentence: 그리고, 아마 아시겠지만, 우체국은 미래의 필요에 대한 추정치를 제시할 때 1998 회계연도의 금융 및 운영 데이터를
-    벤치마크로 사용했다.
-  sentences:
-  - 우체국은 재정 및 운영 데이터를 찾을 수 없었다.
-  - 나는 차가 기다리고 있을 때 차를 몰고 돌아왔다.
-  - 1998 회계연도는 우체국의 미래 요구를 제시하기 위한 벤치마크로 사용되었다.
-- source_sentence: 이 회사에 따르면 유권자들은 생년월일과 디지털 서명을 통해 자신의 신원을 확인할 수 있을 것이라고 한다.
-  sentences:
-  - 나는 부럽다.
-  - 유권자들은 그들의 정체성을 확인할 필요가 없다.
-  - 유권자들은 생일과 디지털 서명으로 자신의 신원을 확인할 수 있을 것이다.
-- source_sentence: 내 워커가 고장나서 지금 화가 났어. 스테레오를 정말 크게 틀어야 해.
-  sentences:
-  - 내 워크맨은 여전히 항상 그랬던 것처럼 잘 작동한다.
-  - 나는 내 워크맨이 고장나서 화가 나서 이제 스테레오를 정말 크게 틀어야 한다.
-  - 농업에 미치는 두 가지 영향은 우리의 분석에서 정량적으로 추정된다.
-pipeline_tag: sentence-similarity
-library_name: sentence-transformers
-metrics:
-- pearson_cosine
-- spearman_cosine
-model-index:
-- name: SentenceTransformer
-  results:
-  - task:
-      type: semantic-similarity
-      name: Semantic Similarity
-    dataset:
-      name: korsts valid
-      type: korsts-valid
-    metrics:
-    - type: pearson_cosine
-      value: 0.8325143434234821
-      name: Pearson Cosine
-    - type: spearman_cosine
-      value: 0.833013169247792
-      name: Spearman Cosine
+- static-embedding
+- model2vec
+- korean
+- ko
+- matryoshka
+datasets:
+- kakaobrain/kor_nli
+- mteb/KorSTS
+- klue/klue
+- Helsinki-NLP/opus-100
+base_model: klue/roberta-base
 ---
 
-# SentenceTransformer
-
-This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps sentences & paragraphs to a 512-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
-
-## Model Details
+# kor-static-embedding-512
 
-### Model Description
-- **Model Type:** Sentence Transformer
-<!-- - **Base model:** [Unknown](https://huggingface.co/unknown) -->
-- **Maximum Sequence Length:** inf tokens
-- **Output Dimensionality:** 512 dimensions
-- **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
+한국어 특화 **초경량 Static Embedding** 모델 — **68MB**, **512차원**.
 
-### Model Sources
+[kekeappa/kor-static-embedding-512](https://huggingface.co/kekeappa/kor-static-embedding-512)를 Matryoshka 학습으로 만들고 **512차원으로 잘라낸 변종**입니다. 같은 모델 패밀리에 4개 차원 존재 — 용도에 맞게 선택:
 
-- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
-- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
-- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
+| 차원 | 크기 | 용도 |
+|---:|---:|---|
+| **[64](https://huggingface.co/kekeappa/kor-static-embedding-64)** | 9MB | 🌐 브라우저 · 모바일 · 엣지 |
+| **[128](https://huggingface.co/kekeappa/kor-static-embedding-128)** | 17MB | ⚡ 가벼운 검색·분류 |
+| **[256](https://huggingface.co/kekeappa/kor-static-embedding-256)** | 34MB | ⚖️ 가성비 |
+| **[512](https://huggingface.co/kekeappa/kor-static-embedding-512)** | 68MB | 🎯 최고 정확도 |
 
-### Full Model Architecture
+## 성능 (KorSTS / KLUE-STS)
 
-```
-SentenceTransformer(
-  (0): StaticEmbedding(
-    (embedding): EmbeddingBag(32000, 512, mode='mean')
-  )
-)
-```
-
-## Usage
+| 벤치마크 | Pearson | **Spearman** |
+|---|---:|---:|
+| KorSTS-test | 0.7760 | **0.7718** |
+| KorSTS-valid | — | **0.8330** |
+| KLUE-STS-val | — | **0.7033** |
 
-### Direct Usage (Sentence Transformers)
-
-First install the Sentence Transformers library:
-
-```bash
-pip install -U sentence-transformers
-```
+## 사용
 
-Then you can load this model and run inference.
 ```python
 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, 512]
-
-# Get the similarity scores for the embeddings
-similarities = model.similarity(embeddings, embeddings)
-print(similarities.shape)
-# [3, 3]
-```
-
-<!--
-### 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
-
-#### Semantic Similarity
-
-* Dataset: `korsts-valid`
-* Evaluated with [<code>EmbeddingSimilarityEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.EmbeddingSimilarityEvaluator)
-
-| Metric              | Value     |
-|:--------------------|:----------|
-| pearson_cosine      | 0.8325    |
-| **spearman_cosine** | **0.833** |
-
-<!--
-## 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 Dataset
-
-#### Unnamed Dataset
-
-* Size: 277,826 training samples
-* Columns: <code>sentence1</code>, <code>sentence2</code>, and <code>score</code>
-* Approximate statistics based on the first 1000 samples:
-  |         | sentence1                                                                                     | sentence2                                                                                     | score                                                          |
-  |:--------|:----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------|:---------------------------------------------------------------|
-  | type    | string                                                                                        | string                                                                                        | float                                                          |
-  | details | <ul><li>min: 9 characters</li><li>mean: 18.19 characters</li><li>max: 53 characters</li></ul> | <ul><li>min: 9 characters</li><li>mean: 17.97 characters</li><li>max: 44 characters</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.45</li><li>max: 1.0</li></ul> |
-* Samples:
-  | sentence1                           | sentence2                                 | score             |
-  |:------------------------------------|:------------------------------------------|:------------------|
-  | <code>비행기가 이륙하고 있다.</code>          | <code>비행기가 이륙하고 있다.</code>                | <code>1.0</code>  |
-  | <code>한 남자가 큰 플루트를 연주하고 있다.</code>  | <code>남자가 플루트를 연주하고 있다.</code>            | <code>0.76</code> |
-  | <code>한 남자가 피자에 치즈를 뿌려놓고 있다.</code> | <code>한 남자가 구운 피자에 치즈 조각을 뿌려놓고 있다.</code> | <code>0.76</code> |
-* Loss: [<code>MatryoshkaLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#matryoshkaloss) with these parameters:
-  ```json
-  {
-      "loss": "CosineSimilarityLoss",
-      "matryoshka_dims": [
-          512,
-          256,
-          128,
-          64
-      ],
-      "matryoshka_weights": [
-          1,
-          1,
-          1,
-          1
-      ],
-      "n_dims_per_step": -1
-  }
-  ```
-
-### Training Hyperparameters
-#### Non-Default Hyperparameters
-
-- `eval_strategy`: epoch
-- `per_device_train_batch_size`: 64
-- `learning_rate`: 0.02
-- `num_train_epochs`: 5
-- `warmup_ratio`: 0.1
-- `bf16`: True
-- `load_best_model_at_end`: True
-
-#### All Hyperparameters
-<details><summary>Click to expand</summary>
-
-- `overwrite_output_dir`: False
-- `do_predict`: False
-- `eval_strategy`: epoch
-- `prediction_loss_only`: True
-- `per_device_train_batch_size`: 64
-- `per_device_eval_batch_size`: 8
-- `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`: 0.02
-- `weight_decay`: 0.0
-- `adam_beta1`: 0.9
-- `adam_beta2`: 0.999
-- `adam_epsilon`: 1e-08
-- `max_grad_norm`: 1.0
-- `num_train_epochs`: 5
-- `max_steps`: -1
-- `lr_scheduler_type`: linear
-- `lr_scheduler_kwargs`: {}
-- `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
-- `use_ipex`: 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`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
-- `fsdp_transformer_layer_cls_to_wrap`: None
-- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
-- `deepspeed`: None
-- `label_smoothing_factor`: 0.0
-- `optim`: adamw_torch
-- `optim_args`: None
-- `adafactor`: False
-- `group_by_length`: False
-- `length_column_name`: length
-- `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`: False
-- `hub_always_push`: False
-- `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
-- `dispatch_batches`: None
-- `split_batches`: None
-- `include_tokens_per_second`: False
-- `include_num_input_tokens_seen`: False
-- `neftune_noise_alpha`: None
-- `optim_target_modules`: None
-- `batch_eval_metrics`: False
-- `eval_on_start`: False
-- `use_liger_kernel`: False
-- `eval_use_gather_object`: False
-- `average_tokens_across_devices`: False
-- `prompts`: None
-- `batch_sampler`: batch_sampler
-- `multi_dataset_batch_sampler`: proportional
-
-</details>
-
-### Training Logs
-| Epoch  | Step | Training Loss | korsts-valid_spearman_cosine |
-|:------:|:----:|:-------------:|:----------------------------:|
-| -1     | -1   | -             | 0.5714                       |
-| 0.3676 | 50   | 2.6082        | -                            |
-| 0.7353 | 100  | 1.9692        | -                            |
-| -1     | -1   | -             | 0.8077                       |
-| 0.2604 | 50   | 5.0909        | -                            |
-| 0.5208 | 100  | 3.4769        | -                            |
-| 0.7812 | 150  | 3.0821        | -                            |
-| -1     | -1   | -             | 0.7796                       |
-| 0.1381 | 50   | 0.1676        | -                            |
-| 0.2762 | 100  | 0.1483        | -                            |
-| 0.4144 | 150  | 0.1283        | -                            |
-| 0.5525 | 200  | 0.1186        | -                            |
-| 0.6906 | 250  | 0.1183        | -                            |
-| 0.8287 | 300  | 0.1019        | -                            |
-| 0.9669 | 350  | 0.0938        | -                            |
-| 1.0    | 362  | -             | 0.8262                       |
-| 1.1050 | 400  | 0.0593        | -                            |
-| 1.2431 | 450  | 0.0463        | -                            |
-| 1.3812 | 500  | 0.0443        | -                            |
-| 1.5193 | 550  | 0.0419        | -                            |
-| 1.6575 | 600  | 0.0419        | -                            |
-| 1.7956 | 650  | 0.0436        | -                            |
-| 1.9337 | 700  | 0.0406        | -                            |
-| 2.0    | 724  | -             | 0.8307                       |
-| 2.0718 | 750  | 0.0331        | -                            |
-| 2.2099 | 800  | 0.0229        | -                            |
-| 2.3481 | 850  | 0.0249        | -                            |
-| 2.4862 | 900  | 0.0231        | -                            |
-| 2.6243 | 950  | 0.0225        | -                            |
-| 2.7624 | 1000 | 0.023         | -                            |
-| 2.9006 | 1050 | 0.0241        | -                            |
-| 3.0    | 1086 | -             | 0.8325                       |
-| 3.0387 | 1100 | 0.0197        | -                            |
-| 3.1768 | 1150 | 0.012         | -                            |
-| 3.3149 | 1200 | 0.0115        | -                            |
-| 3.4530 | 1250 | 0.0117        | -                            |
-| 3.5912 | 1300 | 0.012         | -                            |
-| 3.7293 | 1350 | 0.0107        | -                            |
-| 3.8674 | 1400 | 0.011         | -                            |
-| 4.0    | 1448 | -             | 0.8335                       |
-| 4.0055 | 1450 | 0.0118        | -                            |
-| 4.1436 | 1500 | 0.0056        | -                            |
-| 4.2818 | 1550 | 0.0069        | -                            |
-| 4.4199 | 1600 | 0.006         | -                            |
-| 4.5580 | 1650 | 0.0057        | -                            |
-| 4.6961 | 1700 | 0.0055        | -                            |
-| 4.8343 | 1750 | 0.0078        | -                            |
-| 4.9724 | 1800 | 0.0072        | -                            |
-| 5.0    | 1810 | -             | 0.8330                       |
-
-
-### Framework Versions
-- Python: 3.11.10
-- Sentence Transformers: 3.4.1
-- Transformers: 4.46.3
-- PyTorch: 2.4.1+cu124
-- Accelerate: 1.13.0
-- Datasets: 4.8.5
-- Tokenizers: 0.20.3
-
-## Citation
-
-### BibTeX
-
-#### Sentence Transformers
-```bibtex
-@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",
-}
+model = SentenceTransformer("kekeappa/kor-static-embedding-512")
+emb = model.encode(["한국어 문장", "임베딩 테스트"], normalize_embeddings=True)
+print(emb.shape)  # (2, 512)
 ```
 
-#### MatryoshkaLoss
-```bibtex
-@misc{kusupati2024matryoshka,
-    title={Matryoshka Representation Learning},
-    author={Aditya Kusupati and Gantavya Bhatt and Aniket Rege and Matthew Wallingford and Aditya Sinha and Vivek Ramanujan and William Howard-Snyder and Kaifeng Chen and Sham Kakade and Prateek Jain and Ali Farhadi},
-    year={2024},
-    eprint={2205.13147},
-    archivePrefix={arXiv},
-    primaryClass={cs.LG}
-}
-```
+## 특징
 
-<!--
-## Glossary
+- **아키텍처**: StaticEmbedding (model2vec 계열) — 트랜스포머 attention 없음
+- **추론**: CPU 최적, GPU 불필요
+- **속도**: 단일 쿼리 < 1ms (브라우저에서도 빠름)
+- **한영 호환**: cross-lingual 학습됨 — 한국어 쿼리로 영어 문서 검색 가능
 
-*Clearly define terms in order to be accessible across audiences.*
--->
+## 학습 방법
 
-<!--
-## Model Card Authors
+4-stage 학습:
+1. **Distillation 초기화**: `BM-K/KoSimCSE-roberta-multitask` teacher의 vocab 임베딩 → PCA + Zipf weighting
+2. **KorNLI MNRL**: `kakaobrain/kor_nli` (multi_nli + snli) 277K triplet
+3. **Cross-lingual MNRL**: OPUS-100 ko-en parallel 200K pair
+4. **Matryoshka regression**: KorSTS + KLUE-STS + NLLB로 번역한 영어 STS-B
+   - 64/128/256/512 차원 동시 최적화 (`MatryoshkaLoss`)
 
-*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
--->
+학습 코드: https://github.com/johunsang/kor-static-embedding-512
 
-<!--
-## Model Card Contact
+## 라이선스
 
-*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--->
+Apache 2.0