Private fine-tuned E5-base model for smart home commands

2b7e20a verified 8 months ago

15.4 kB

tags:
  - sentence-transformers
  - sentence-similarity
  - feature-extraction
  - dense
  - generated_from_trainer
  - dataset_size:358
  - loss:MultipleNegativesRankingLoss
  - dataset_size:322
base_model: intfloat/e5-base
widget:
  - source_sentence: Turn off all thermostats in the house
    sentences:
      - >-
        All thermostats in the house include device_1: Thermostat in bedroom and
        device_16: Thermostat in 1st Floor Hallway.
      - >-
        The study plug is device_7: SmartPlug, Wifi Smart Plug Study, currently
        off.
      - >-
        The front door lock is device_15: SmartLock, Door Lock, currently
        disconnected.
  - source_sentence: Turn on the Philips Light in the Bed Room
    sentences:
      - 'The Philips Light in the Bed Room is device_29: Light, Philips Light.'
      - >-
        Guest room (Evangeline Room) preparation uses device_5: SmartPlug, Wifi
        Smart Plug for amenities.
      - >-
        All entertainment devices include device_21: Television in family room,
        device_28: Television in living room, device_32: Television in living
        room, and device_10: SmartMonitor in study.
  - source_sentence: Switch on the Kasa plug in the study
    sentences:
      - >-
        The family room sofa outlet is device_19: SmartPlug, Family Room Sofa
        Outlet.
      - 'The Kasa plug in the study is device_13: Switch, Kasa Study Plug.'
      - >-
        Guest preparation includes device_28 and device_32: Televisions for
        entertainment, device_30 and device_31: SmartPlugs for amenities,
        device_35: AirConditioner for comfort, and device_34: Camera for
        security.
  - source_sentence: Turn on the SmartThings Outlet in the Living room
    sentences:
      - >-
        The SmartThings Outlet in the Living room is device_31: SmartPlug,
        SmartThings Outlet.
      - >-
        The specific eWeLink mirror outlet is device_2: Switch, eWeLink Outlet
        Mirror in Bed Room.
      - >-
        All SmartPlugs in the Family room include device_19: SmartPlug Family
        Room Sofa Outlet, device_20: SmartPlug SmartThings Outlet, and
        device_23: SmartPlug SmartThings Outlet.
  - source_sentence: Living room TV group
    sentences:
      - 'The Trinity room wifi plug is device_26: SmartPlug, Wifi Smart Plug 1.'
      - >-
        Living room TV group is device_47: Television (all Televisions in Living
        room) including device_28 and device_32.
      - >-
        All Televisions in the Living room include device_47: Television (all
        Televisions in Living room), device_28: Television TV, and device_32:
        Television Samsung QN90AA 65 TV.
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
  - pearson_cosine
  - spearman_cosine
model-index:
  - name: SentenceTransformer based on intfloat/e5-base
    results:
      - task:
          type: semantic-similarity
          name: Semantic Similarity
        dataset:
          name: smart home eval
          type: smart_home_eval
        metrics:
          - type: pearson_cosine
            value: .nan
            name: Pearson Cosine
          - type: spearman_cosine
            value: .nan
            name: Spearman Cosine
          - type: pearson_cosine
            value: 0.9005859430666894
            name: Pearson Cosine
          - type: spearman_cosine
            value: 0.8492077756084468
            name: Spearman Cosine

SentenceTransformer based on intfloat/e5-base

This is a sentence-transformers model finetuned from intfloat/e5-base. 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: intfloat/e5-base
Maximum Sequence Length: 512 tokens
Output Dimensionality: 768 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': 512, 'do_lower_case': False, 'architecture': 'BertModel'})
  (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})
  (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("RahulMeganathan/e5-smart-home-private")
# Run inference
sentences = [
    'Living room TV group',
    'Living room TV group is device_47: Television (all Televisions in Living room) including device_28 and device_32.',
    'The Trinity room wifi plug is device_26: SmartPlug, Wifi Smart Plug 1.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.9348, 0.2095],
#         [0.9348, 1.0000, 0.1903],
#         [0.2095, 0.1903, 1.0000]])

Evaluation

Metrics

Semantic Similarity

Dataset: smart_home_eval
Evaluated with EmbeddingSimilarityEvaluator

Metric	Value
pearson_cosine	nan
spearman_cosine	nan

Semantic Similarity

Dataset: smart_home_eval
Evaluated with EmbeddingSimilarityEvaluator

Metric	Value
pearson_cosine	0.9006
spearman_cosine	0.8492

Training Details

Training Dataset

Unnamed Dataset

Size: 322 training samples
Columns: sentence_0, sentence_1, and label
Approximate statistics based on the first 322 samples:
sentence_0 sentence_1 label
type string string float
details
min: 4 tokens
mean: 7.81 tokens
max: 16 tokens

min: 15 tokens
mean: 32.61 tokens
max: 131 tokens

min: 1.0
mean: 1.0
max: 1.0

	sentence_0	sentence_1	label
type	string	string	float
details	min: 4 tokens mean: 7.81 tokens max: 16 tokens	min: 15 tokens mean: 32.61 tokens max: 131 tokens	min: 1.0 mean: 1.0 max: 1.0

Samples:

sentence_0	sentence_1	label
`Bedroom device list`	`Bedroom devices include device_1: Thermostat, device_2: Switch, device_11: AirConditioner, and device_29: Light.`	`1.0`
`Turn off the Water Leak Sensor in the Laundry room`	`The Water Leak Sensor in the Laundry room is device_3: LeakSensor, Water Leak Sensor.`	`1.0`
`Turn on the SmartThings Outlet in the Living room`	`The SmartThings Outlet in the Living room is device_31: SmartPlug, SmartThings Outlet.`	`1.0`

Loss: MultipleNegativesRankingLoss with these parameters:

{
    "scale": 20.0,
    "similarity_fct": "cos_sim"
}

Training Hyperparameters

Non-Default Hyperparameters

eval_strategy: steps
num_train_epochs: 6
multi_dataset_batch_sampler: round_robin

All Hyperparameters

Click to expand

overwrite_output_dir: False
do_predict: False
eval_strategy: steps
prediction_loss_only: True
per_device_train_batch_size: 8
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: 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: 6
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}
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
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: {}

Training Logs

Epoch	Step	smart_home_eval_spearman_cosine
1.0	41	nan
1.2195	50	nan
2.0	82	nan
2.4390	100	nan
1.0	41	0.8492

Framework Versions

Python: 3.11.13
Sentence Transformers: 5.0.0
Transformers: 4.55.0
PyTorch: 2.6.0+cu124
Accelerate: 1.9.0
Datasets: 4.0.0
Tokenizers: 0.21.4

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

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