nepali_sentence_embedding_v1_m1

sentenceTransformer_nepali_embedding

This is a sentence-transformers model finetuned from jangedoo/all-MiniLM-L6-v2-nepali on the json dataset. It maps sentences & paragraphs to a 384-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: jangedoo/all-MiniLM-L6-v2-nepali <!-- at revision 418f7cf08ecbbc2ff0e8460bb6eb6457291102df -->
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 384 dimensions
• Similarity Function: Cosine Similarity
• Training Dataset:
  • json
• Language: nep
• License: apache-2.0

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}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 384, '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})
  (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("ritesh-07/nepali_sentence_embedding_v1_m1")
# Run inference
sentences = [
    'हराएको, चोरी भएको वा विवरण नबुझिने गरी झुत्रो भएको कारण हालको राहदानीको विवरण उपलब्ध नभएमा के गर्ने?',
    'हराएको, चोरी भएको अवस्थामा प्रतिलिपि नभएको वा भएतापनि विवरण नबुझिने भइ स्पष्ट नभएमा आवेदकले राहदानी विभाग वा दर्ता केन्द्रमा सम्पर्क गरी उपस्थित भइ उक्त राहदानीको विवरण लिन सकिन्छ । राहदानी हरायो वा चोरी भयो, पत्रपत्रिकामा सूचना दिनु पर्दछ? राहदानी हराएमा वा चोरी भएमा पत्रपत्रिकामा सूचना ननिकाले तापनि वा प्रहरी प्रतिवेदन नभएता पनि राहदानीका लागि आवेदन दिन सकिन्छ। विभागले हराएको राहदानीलार्इ रद्द गरेको जानकारी Interpol लार्इ दिने व्यवस्था छ।',
    'राहदानी तयार भइसकेपछि त्रुटि भएको जानकारी भयो भने नयाँ राहदानी बनाउँदा गरिने सम्पूर्ण प्रक्रियाहरू पुन गर्नुपर्दछ। र नयाँ राहदानी पुन जारी हुन्छ। तर तयार भइसकेको राहदानीमा विवरण सच्याउन भने मिल्दैन',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 384]

# 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

Information Retrieval

• Dataset: dim_384
• Evaluated with <code>InformationRetrievalEvaluator</code> with these parameters:

  {
      "truncate_dim": 384
  }
  

Information Retrieval

• Dataset: dim_256
• Evaluated with <code>InformationRetrievalEvaluator</code> with these parameters:

  {
      "truncate_dim": 256
  }
  

Information Retrieval

• Dataset: dim_128
• Evaluated with <code>InformationRetrievalEvaluator</code> with these parameters:

  {
      "truncate_dim": 128
  }
  

Information Retrieval

• Dataset: dim_64
• Evaluated with <code>InformationRetrievalEvaluator</code> with these parameters:

  {
      "truncate_dim": 64
  }
  

<!-- ## 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

json

• Dataset: json
• Size: 73 training samples
• Columns: <code>anchor</code> and <code>positive</code>
• Approximate statistics based on the first 73 samples:

  	anchor	positive
  type	string	string
  details	<ul><li>min: 18 tokens</li><li>mean: 40.88 tokens</li><li>max: 79 tokens</li></ul>	<ul><li>min: 2 tokens</li><li>mean: 216.23 tokens</li><li>max: 256 tokens</li></ul>

• Samples:

  anchor	positive
  <code>के बालबच्चा बुढाबुढी अशक्त लाई राहदानी दिँदा छुट्टै प्रक्रिया छ यसको लागि दस्तुर समान हो। कि होइन</code>	<code>बालबच्चा बुढाबुढी अशक्त वा अपाङ्गलाई कार्यालयहरुले सहज रुपमा राहदानी आवेदन दिन सक्ने व्यवस्था मिलाएका छन् । १० वर्ष मुनिका बालबालिकाका लागि राहदानी दस्तुरमा केही छुट हुन्छ। अन्य व्यक्तिहरूको हकमा समान दस्तुर लागू गरिएको छ।</code>
  <code>३४ पेज वा ६६ पेज कुन राहदानीका लागि आवेदन दिने? के सबैले ६६ पृष्ठको राहदानीका लागि आवेदन दिन सकिन्छ ?</code>	<code>यदि तपाईंलाई बारम्बार यात्रा गरिरहनुपर्छ र राहदानीको पाना अपर्याप्त हुन सक्छन् भन्ने लागेमा ६६ पेजको राहदानीका लागि आवेदन दिनुपर्दछ अन्यथा ३४ पेजको लागि राहदानी आवेदन दिन सकिने</code>
  <code>वंशजको नाताले नेपाली नागरिकताको प्रमाणपत्र प्राप्त गर्न के कस्तो कार्यविधि पुरा गर्नुपर्दछ ?</code>	<code>नेपाल नागरिकता नियमावली, २०६३ को नियम ३ मा वंशजको नाताले नेपाली नागरिकताको प्रमाणपत्र प्राप्त गर्न देहायबमजिमको व्यवस्था गरिएको छः (१) वंशजको नाताले नेपाली नागरिकताको प्रमाणपत्र लिन चाहने सोह्र बर्ष उमेर पूरा भएको नेपाली नागरिकले सम्बन्धित प्रमुख जिल्ला अधिकारीसमक्ष देहायका कागजात संलग्न राखी अनुसूची-१ बमोजिमको ढाँचामा निवेदन दिनुपर्नेछ । (क) बाबु वा आमा वा आफ्ना वंशतर्फका तीन पुस्ताभित्रको नातेदारको नेपाली नागरिकताको प्रमाणपत्र, (ख) जन्मस्थान र नाता खुल्ने गरी सम्बन्धित स्थानीय निकायले गरिदिएको सिफारिस वा जन्मदर्ता प्रमाणपत्र, (ग) खण्ड (क) बमोजिम तीन पुस्ताभित्रको नातेदारको नागरिकताको प्रमाणपत्र पेश गरेको अवस्थामा उक्त नातेदारसँगको नाता खुल्ने नाता प्रमाणित पत्र (२) उपनियम (१) बमोजिमका प्रमाण निवेदनसाथ पेश गर्न नसक्ने नेपाली नागरिकलाई देहायका कागजातका आधारमा नेपाली नागरिकताको प्रमाणपत्र दिन सकिनेछः (क) निवेदकका बाबु वा आमा नेपाली नागरिक भएकोले निज वंशजको नाताले नेपालको नागरिक भएको र नेपालमा जन्म भई निरन्तर रूपमा नेपाल सरहदभित्र स्थायी रुपमा बसोबास गरी आएको व्यहोरा खुल्ने गरी स्थानीय न...</code>

• Loss: <code>MatryoshkaLoss</code> with these parameters:

  {
      "loss": "MultipleNegativesRankingLoss",
      "matryoshka_dims": [
          384,
          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: 32
• per_device_eval_batch_size: 16
• gradient_accumulation_steps: 16
• learning_rate: 2e-05
• num_train_epochs: 4
• lr_scheduler_type: cosine
• warmup_ratio: 0.1
• bf16: True
• tf32: False
• load_best_model_at_end: True
• optim: adamw_torch_fused
• batch_sampler: no_duplicates

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: 32
• per_device_eval_batch_size: 16
• per_gpu_train_batch_size: None
• per_gpu_eval_batch_size: None
• gradient_accumulation_steps: 16
• 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: 4
• max_steps: -1
• lr_scheduler_type: cosine
• 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: False
• 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_fused
• 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
• 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: False
• 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: False
• prompts: None
• batch_sampler: no_duplicates
• multi_dataset_batch_sampler: proportional

</details>

Training Logs

• The bold row denotes the saved checkpoint.

Framework Versions

• Python: 3.11.13
• Sentence Transformers: 4.1.0
• Transformers: 4.53.2
• PyTorch: 2.6.0+cu124
• Accelerate: 1.8.1
• Datasets: 4.0.0
• Tokenizers: 0.21.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",
}

MatryoshkaLoss

@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}
}

MultipleNegativesRankingLoss

@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.* -->