Upload 10 files

d617873 verified 5 months ago

14.3 kB

tags:
  - sentence-transformers
  - sentence-similarity
  - feature-extraction
  - dense
  - generated_from_trainer
  - dataset_size:1316
  - loss:CosineSimilarityLoss
base_model: sentence-transformers/all-MiniLM-L6-v2
widget:
  - source_sentence: The system's contact form must include a CAPTCHA to prevent spam.
    sentences:
      - >-
        As a Developer I want D Files generation requests to be managed and
        cached so that duplicate requests do not cause performance issues.
      - >-
        The Spacecraft in orbit shall automatically detect faults, failures or
        errors, which may adversely affect the mission
      - Identify energy-intensive appliances and peak demand periods.
  - source_sentence: "The App in the infotainment gets a certificate from\_Apple\_if all the preconditions mentioned in the Apple website are fulfilled by third-party Car Play devices (infotainment in this case)."
    sentences:
      - >-
        'System shall let administrator add/remove movies on the website in
        under 5 minutes. Entered movie information will be stored in the
        database and will now be available on the website.'
      - >-
        The baselined version 2 of the spreadsheet must be able to access
        information from the previous baselined version.
      - >-
        Establish (and implement as needed) procedures to restore any loss of
        data.
  - source_sentence: >-
      Service provider constructs strategies to prove that an information have
      been delivered to a service consumer.
    sentences:
      - the system recognize the appropriateness of the functionality
      - >-
        Only Claims Adjusters with authorized clearance may view employee claims
        against self‐insured employers.
      - >-
        All SmartMeter systems will provide a standard interface that can be
        used by meter operators for installation and maintenance purposes
        without disturbing any meter seals and reinstating any tamper detection
        covers.
  - source_sentence: >-
      The Disputes application shall interface with the Cardmember Information
      Database. The Cardmember Information Database provides detailed
      information with regard to a cardmember.
    sentences:
      - Smart city infrastructure should be resilient
      - >-
        The Medical System shall transmit patient records only when the patient
        has provided a written, signed release form authorizing the
        transmission.
      - System components can be separated and recombined
  - source_sentence: >-
      Service provider constructs strategies to prove that an information have
      been delivered to a service consumer.
    sentences:
      - >-
        'The website should have an African feel  but should not alienate
        non-Africans.  The website should use animation on pages which are
        describing the services  to grab the users attention and encourage them
        to sign up.'
      - >-
        mobile apps can be successfully installed and/or uninstalled in a
        specified environment.
      - >-
        The product shall be able to handle 10 000 concurrent users within 2
        years of the initial launch.
pipeline_tag: sentence-similarity
library_name: sentence-transformers

SentenceTransformer based on sentence-transformers/all-MiniLM-L6-v2

This is a sentence-transformers model finetuned from sentence-transformers/all-MiniLM-L6-v2. 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: sentence-transformers/all-MiniLM-L6-v2
Maximum Sequence Length: 256 tokens
Output Dimensionality: 384 dimensions
Similarity Function: Cosine Similarity

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': '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("sentence_transformers_model_id")
# Run inference
sentences = [
    'Service provider constructs strategies to prove that an information have been delivered to a service consumer.',
    'mobile apps can be successfully installed and/or uninstalled in a specified environment.',
    "'The website should have an African feel  but should not alienate non-Africans.  The website should use animation on pages which are describing the services  to grab the users attention and encourage them to sign up.'",
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 384]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[ 1.0000, -0.0760,  0.0720],
#         [-0.0760,  1.0000, -0.0468],
#         [ 0.0720, -0.0468,  1.0000]])

Training Details

Training Dataset

Unnamed Dataset

Size: 1,316 training samples
Columns: sentence_0, sentence_1, and label
Approximate statistics based on the first 1000 samples:
sentence_0 sentence_1 label
type string string int
details
min: 5 tokens
mean: 26.51 tokens
max: 64 tokens

min: 3 tokens
mean: 20.53 tokens
max: 59 tokens

0: ~49.70%
1: ~50.30%

	sentence_0	sentence_1	label
type	string	string	int
details	min: 5 tokens mean: 26.51 tokens max: 64 tokens	min: 3 tokens mean: 20.53 tokens max: 59 tokens	0: ~49.70% 1: ~50.30%

Samples:

sentence_0	sentence_1	label
`Can view all available products and can compare them and make a choice for purchasing products.`	`Can purchase any product through a valid credit card.`	`1`
`The website should follow the cybersecurity guidelines and comply with the World Wide Web in terms of accessibility.`	`' Customer shall be able to check the status of their prepaid card by entering in the PIN number in under 5 seconds.'`	`0`
`a data entered into the system is correctly calculated and used by the system and that the output is correct.`	`Encrypted data delivered over the Internet is transmitted via open protocols (e.g., SSL, XML encryption)`	`0`

Loss: CosineSimilarityLoss with these parameters:

{
    "loss_fct": "torch.nn.modules.loss.MSELoss"
}

Training Hyperparameters

Non-Default Hyperparameters

per_device_train_batch_size: 16
per_device_eval_batch_size: 16
multi_dataset_batch_sampler: round_robin

All Hyperparameters

Click to expand

overwrite_output_dir: False
do_predict: False
eval_strategy: no
prediction_loss_only: True
per_device_train_batch_size: 16
per_device_eval_batch_size: 16
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: 5e-05
weight_decay: 0.0
adam_beta1: 0.9
adam_beta2: 0.999
adam_epsilon: 1e-08
max_grad_norm: 1
num_train_epochs: 3
max_steps: -1
lr_scheduler_type: linear
lr_scheduler_kwargs: {}
warmup_ratio: 0.0
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: 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: 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}
parallelism_config: 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: batch_sampler
multi_dataset_batch_sampler: round_robin
router_mapping: {}
learning_rate_mapping: {}

Framework Versions

Python: 3.12.11
Sentence Transformers: 5.1.0
Transformers: 4.56.1
PyTorch: 2.8.0+cu126
Accelerate: 1.10.1
Datasets: 4.0.0
Tokenizers: 0.22.0

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",
}