| | --- |
| | tags: |
| | - sentence-transformers |
| | - sentence-similarity |
| | - feature-extraction |
| | - generated_from_trainer |
| | - dataset_size:5315 |
| | - loss:MultipleNegativesRankingLoss |
| | base_model: shihab17/bangla-sentence-transformer |
| | widget: |
| | - source_sentence: নির্মাতারা রাহুলের বিপরীতে দীপিকা বা ঐশ্বর্য রায়কে বেছে নিতে আগ্রহী। |
| | sentences: |
| | - চলচ্চিত্র নির্মাতারা সালমানের বিপরীতে অনুষ্কা বা সোনাক্ষী সিনহাকে বেছে নিতে আগ্রহী। |
| | - এরপর ঢাকা বিশ্ববিদ্যালয়ের উপাচার্য প্রফেসর এ.এ.এম. স. আরেফিন সিদ্দিকের নেতৃত্বে |
| | ফুলটি |
| | - বৃহস্পতিবার বিকেলে মুন্না বিবিসি নিউজকে জানায় যে আমি ম্যাচ রেফারির রিপোর্ট পেয়েছি। |
| | - source_sentence: ঢাকার ধামরাইতে নভেম্বর ডেইলিবাংলা ডটকমের প্রতিনিধি ধামরাইতে অবৈধ |
| | ডিভিডি তৈরির সরঞ্জামসহ পাঁচ ব্যবসায়ীকে গ্রেপ্তার করেছে পুলিশ। |
| | sentences: |
| | - চলচ্চিত্রটি পরিচালনা করেছেন ইসরাত জাহান কাদের এবং প্রযোজনা করেছেন মাহফুজ আহমেদ। |
| | - আওয়ামী লীগ শুধু জানে ক্ষমতা আছে। |
| | - অক্টোবরের ১০ তারিখে র্যাব ঢাকার সাভারে পর্ণো সিডি কম্পিউটার ডিস্ক তৈরির সরঞ্জামসহ |
| | ছয় ব্যবসায়ীকে গ্রেফতার করে |
| | - source_sentence: চলচ্চিত্রটি পরিচালনা করেছেন রাহুল আহমেদ মিথুন। |
| | sentences: |
| | - জানুয়ারি মাসে রাজধানী ওয়ার্ড যুব দলের সভাপতি শহীদ মোল্লাকে সন্ত্রাসীরা গুলি |
| | করে হত্যা করে। |
| | - চলচ্চিত্রটি পরিচালনা করেছেন শাহাদাত হোসেন লিটন। |
| | - তাই তাঁর বিভিন্ন ছড়ায় পদ্ম দিঘি ঝুমকো লতা পক্ষিরাজ দুধ সাগরের ঢেউ জোনাকি পোকা |
| | কাজল বিল পাখি |
| | - source_sentence: মোবাইল ফোনটি গুগল পিক্সেল প্রোগ্রামের মাধ্যমে বাজারে উন্মোচিত হয়েছে। |
| | sentences: |
| | - মিশুক মুনির ক্যামেরার পেছনে ছিলেন। |
| | - অ্যান্ড্রয়েড ওয়ান প্রকল্পের মাধ্যমে স্মার্টফোনটি বাজারে আনা হয়েছে। |
| | - ঢাকা জুনবিডিনিউজ.কম নিশাত বানু হত্যার মামলায় গ্রেফতার হওয়া দু'জনকে জিজ্ঞাসাবাদের |
| | জন্য তিন দিনের পুলিশ |
| | - source_sentence: রাজশাহী ফেব্রুয়ারি প্রাইমনিউজ টোয়েন্টিফোর ডটকম বাংলাদেশে নিযুক্ত |
| | কাতারের রাষ্ট্রদূত ড. আহমেদ বিন সাদ আল থানি বুধবার সন্ধ্যায় আওয়ামী লীগের সভাপতি |
| | শেখ হাসিনার সঙ্গে সৌজন্য সাক্ষাৎ করেছেন। |
| | sentences: |
| | - ঢাকা জানুয়ারি বিবিসি.কম-এ সৌদি আরবের রাষ্ট্রদূত ড. আবদুল্লাহ বিন নাসের আল-বুসাই |
| | - গানটি গেয়েছেন লিলি ইসলাম সাজেদ আকবর, সালমা আকবর চঞ্চল খান, রোকিয়া হাসিনা ছায়া |
| | রানী কর্মকার, |
| | - পাকিস্তান আমলে হোসেন শহীদ সোহরাওয়ার্দীর নেতৃত্বে যুক্তফ্রন্টের মন্ত্রিসভার সদস্য |
| | ছিলেন বঙ্গবন্ধু। |
| | pipeline_tag: sentence-similarity |
| | library_name: sentence-transformers |
| | metrics: |
| | - negative_mse |
| | - pearson_cosine |
| | - spearman_cosine |
| | model-index: |
| | - name: SentenceTransformer based on shihab17/bangla-sentence-transformer |
| | results: |
| | - task: |
| | type: knowledge-distillation |
| | name: Knowledge Distillation |
| | dataset: |
| | name: stsb dev |
| | type: stsb-dev |
| | metrics: |
| | - type: negative_mse |
| | value: -14.638463020324707 |
| | name: Negative Mse |
| | - task: |
| | type: semantic-similarity |
| | name: Semantic Similarity |
| | dataset: |
| | name: sts test |
| | type: sts-test |
| | metrics: |
| | - type: pearson_cosine |
| | value: 0.9430020144485936 |
| | name: Pearson Cosine |
| | - type: spearman_cosine |
| | value: 0.8633309737532144 |
| | name: Spearman Cosine |
| | --- |
| | |
| | # SentenceTransformer based on shihab17/bangla-sentence-transformer |
| |
|
| | This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [shihab17/bangla-sentence-transformer](https://huggingface.co/shihab17/bangla-sentence-transformer). It maps sentences & paragraphs to a 768-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:** [shihab17/bangla-sentence-transformer](https://huggingface.co/shihab17/bangla-sentence-transformer) <!-- at revision ab250a2c767638562cd3caa8c0017b106a481755 --> |
| | - **Maximum Sequence Length:** 128 tokens |
| | - **Output Dimensionality:** 768 dimensions |
| | - **Similarity Function:** Cosine Similarity |
| | <!-- - **Training Dataset:** Unknown --> |
| | <!-- - **Language:** Unknown --> |
| | <!-- - **License:** Unknown --> |
| |
|
| | ### Model Sources |
| |
|
| | - **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) |
| |
|
| | ### Full Model Architecture |
| |
|
| | ``` |
| | SentenceTransformer( |
| | (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: XLMRobertaModel |
| | (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, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True}) |
| | ) |
| | ``` |
| |
|
| | ## Usage |
| |
|
| | ### 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("farihashifa/s-bn-bert_new_data-vf") |
| | # Run inference |
| | sentences = [ |
| | 'রাজশাহী ফেব্রুয়ারি প্রাইমনিউজ টোয়েন্টিফোর ডটকম বাংলাদেশে নিযুক্ত কাতারের রাষ্ট্রদূত ড. আহমেদ বিন সাদ আল থানি বুধবার সন্ধ্যায় আওয়ামী লীগের সভাপতি শেখ হাসিনার সঙ্গে সৌজন্য সাক্ষাৎ করেছেন।', |
| | 'ঢাকা জানুয়ারি বিবিসি.কম-এ সৌদি আরবের রাষ্ট্রদূত ড. আবদুল্লাহ বিন নাসের আল-বুসাই', |
| | 'গানটি গেয়েছেন লিলি ইসলাম সাজেদ আকবর, সালমা আকবর চঞ্চল খান, রোকিয়া হাসিনা ছায়া রানী কর্মকার,', |
| | ] |
| | embeddings = model.encode(sentences) |
| | print(embeddings.shape) |
| | # [3, 768] |
| | |
| | # 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 |
| |
|
| | #### Knowledge Distillation |
| |
|
| | * Dataset: `stsb-dev` |
| | * Evaluated with [<code>MSEEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.MSEEvaluator) |
| |
|
| | | Metric | Value | |
| | |:-----------------|:-------------| |
| | | **negative_mse** | **-14.6385** | |
| | |
| | #### Semantic Similarity |
| | |
| | * Dataset: `sts-test` |
| | * Evaluated with [<code>EmbeddingSimilarityEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.EmbeddingSimilarityEvaluator) |
| | |
| | | Metric | Value | |
| | |:--------------------|:-----------| |
| | | pearson_cosine | 0.943 | |
| | | **spearman_cosine** | **0.8633** | |
| | |
| | <!-- |
| | ## 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: 5,315 training samples |
| | * Columns: <code>text1</code>, <code>text2</code>, and <code>label</code> |
| | * Approximate statistics based on the first 1000 samples: |
| | | | text1 | text2 | label | |
| | |:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:-----------------------------| |
| | | type | string | string | int | |
| | | details | <ul><li>min: 6 tokens</li><li>mean: 32.48 tokens</li><li>max: 128 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 27.36 tokens</li><li>max: 54 tokens</li></ul> | <ul><li>1: 100.00%</li></ul> | |
| | * Samples: |
| | | text1 | text2 | label | |
| | |:--------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------|:---------------| |
| | | <code>সেখানে ডিসেম্বর থেকে ফেব্রুয়ারি মাসে বৃষ্টি হয়।</code> | <code>নভেম্বর থেকে জানুয়ারি মাস পর্যন্ত এখানে বৃষ্টি হয়।</code> | <code>1</code> | |
| | | <code>গতকাল যশোর ও খুলনার বিভিন্ন পথসভায় বক্তব্য দেন রফিক।</code> | <code>গতকাল কাদের কুমিল্লা ও ফেনীর বিভিন্ন জনসভায় বক্তব্য রাখেন।</code> | <code>1</code> | |
| | | <code>আমাজন প্রাইম ইনস্টাগ্রাম অ্যাপল আইক্লাউড টুইটার ওয়ার্কস্পেস জিমেইল এ সবই ক্লাউড সেবা</code> | <code>ড্রপবক্স নেটফ্লিক্স ফ্লিকার গুগল ড্রাইভ মাইক্রোসফট অফিস ৩৬৫ ইয়াহু মেইল সব ক্লাউড সার্ভিস।</code> | <code>1</code> | |
| | * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters: |
| | ```json |
| | { |
| | "scale": 20.0, |
| | "similarity_fct": "cos_sim" |
| | } |
| | ``` |
| | |
| | ### Evaluation Dataset |
| | |
| | #### Unnamed Dataset |
| | |
| | * Size: 500 evaluation samples |
| | * Columns: <code>text1</code>, <code>text2</code>, and <code>label</code> |
| | * Approximate statistics based on the first 500 samples: |
| | | | text1 | text2 | label | |
| | |:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:-----------------------------| |
| | | type | string | string | int | |
| | | details | <ul><li>min: 4 tokens</li><li>mean: 31.52 tokens</li><li>max: 128 tokens</li></ul> | <ul><li>min: 6 tokens</li><li>mean: 26.27 tokens</li><li>max: 48 tokens</li></ul> | <ul><li>1: 100.00%</li></ul> | |
| | * Samples: |
| | | text1 | text2 | label | |
| | |:-------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------|:---------------| |
| | | <code>গত মার্চে চট্টগ্রামে নিজের বাড়িতে খুন হন রিয়াদ ও মোনা।</code> | <code>ফেব্রুয়ারি মাসে রাজধানীতে নিজ বাড়িতে সাগর ও রুনিকে হত্যা করা হয়।</code> | <code>1</code> | |
| | | <code>পহেলা বৈশাখের বিশেষ আকর্ষণ হলো</code> | <code>বৈসু উৎসবের অন্যতম প্রধান আকর্ষণ হচ্ছে উৎসব।</code> | <code>1</code> | |
| | | <code>আরো বক্তব্য রাখেন জাসদের সদস্য রুমানা আহমেদ নেওয়াজ অধ্যক্ষ এম বি রহমান চৌধুরী ও অধ্যাপক মাহমুদ হাসান।</code> | <code>এ ছাড়া সমিতির সদস্য শ্যামলী নাসরিন চৌধুরী, অধ্যক্ষ এম.এ. আউয়াল সিদ্দিকী এবং অধ্যাপক সাজেদুল ইসলাম</code> | <code>1</code> | |
| | * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters: |
| | ```json |
| | { |
| | "scale": 20.0, |
| | "similarity_fct": "cos_sim" |
| | } |
| | ``` |
| | |
| | ### Training Hyperparameters |
| | #### Non-Default Hyperparameters |
| | |
| | - `eval_strategy`: steps |
| | - `per_device_train_batch_size`: 64 |
| | - `per_device_eval_batch_size`: 64 |
| | - `learning_rate`: 2e-05 |
| | - `warmup_ratio`: 0.1 |
| | - `fp16`: 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`: 64 |
| | - `per_device_eval_batch_size`: 64 |
| | - `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`: 2e-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`: 3 |
| | - `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`: False |
| | - `fp16`: True |
| | - `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`: False |
| | - `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`: None |
| | - `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 |
| | - `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`: no_duplicates |
| | - `multi_dataset_batch_sampler`: proportional |
| |
|
| | </details> |
| |
|
| | ### Training Logs |
| | | Epoch | Step | Training Loss | Validation Loss | stsb-dev_negative_mse | sts-test_spearman_cosine | |
| | |:------:|:----:|:-------------:|:---------------:|:---------------------:|:------------------------:| |
| | | -1 | -1 | - | - | -4.2338 | - | |
| | | 0.5952 | 50 | 0.4719 | 0.1734 | -12.8190 | - | |
| | | 1.1905 | 100 | 0.0867 | 0.1156 | -12.8387 | - | |
| | | 1.7857 | 150 | 0.0411 | 0.1182 | -14.0452 | - | |
| | | 2.3810 | 200 | 0.0339 | 0.1039 | -14.3007 | - | |
| | | 2.9762 | 250 | 0.0221 | 0.1009 | -14.6385 | - | |
| | | -1 | -1 | - | - | - | 0.8633 | |
| |
|
| |
|
| | ### Framework Versions |
| | - Python: 3.11.12 |
| | - Sentence Transformers: 4.1.0 |
| | - Transformers: 4.52.2 |
| | - PyTorch: 2.6.0+cu124 |
| | - Accelerate: 1.7.0 |
| | - Datasets: 2.14.4 |
| | - Tokenizers: 0.21.1 |
| |
|
| | ## 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", |
| | } |
| | ``` |
| |
|
| | #### MultipleNegativesRankingLoss |
| | ```bibtex |
| | @misc{henderson2017efficient, |
| | title={Efficient Natural Language Response Suggestion for Smart Reply}, |
| | author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil}, |
| | year={2017}, |
| | eprint={1705.00652}, |
| | archivePrefix={arXiv}, |
| | primaryClass={cs.CL} |
| | } |
| | ``` |
| |
|
| | <!-- |
| | ## 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.* |
| | --> |
