Views
No views yet
pip install -U sentence-transformers1from sentence_transformers import CrossEncoder
2
3# Download from the 🤗 Hub
4model = CrossEncoder("pujithapsx/address-crossencoder-stsb-roberta-large-finetuned")
5# Get scores for pairs of texts
6pairs = [
7 ['C/O Rakesh Tower C Sector 137 Gurgaon', 'C Tower Sec-137 Gurugram'],
8 ['Tellapur Hyderabad', 'Telapur Hyderabad'],
9 ['Flat 703 Electronic City Bangalore', 'Flat 703 Electronic City Mumbai'],
10 ['B-12 Malviya Nagar Delhi', 'B-22 Malviya Nagar Delhi'],
11 ['Flat 1203 Lower Parel Mumbai', 'Flat 1203 Lower Parel Chennai'],
12]
13scores = model.predict(pairs)
14print(scores.shape)
15# (5,)
16
17# Or rank different texts based on similarity to a single text
18ranks = model.rank(
19 'C/O Rakesh Tower C Sector 137 Gurgaon',
20 [
21 'C Tower Sec-137 Gurugram',
22 'Telapur Hyderabad',
23 'Flat 703 Electronic City Mumbai',
24 'B-22 Malviya Nagar Delhi',
25 'Flat 1203 Lower Parel Chennai',
26 ]
27)
28# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]validationCrossEncoderClassificationEvaluator| Metric | Value |
|---|---|
| accuracy | 0.95 |
| accuracy_threshold | 0.4996 |
| f1 | 0.9517 |
| f1_threshold | 0.3665 |
| precision | 0.9452 |
| recall | 0.9583 |
| average_precision | 0.9753 |
sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
Eighty Eight 8th Cross HSR Layout Bengaluru | 52 Fifty Two D Second Lane Marathahalli Bengaluru | 0.0 |
Flat 301 C/O Sharma Kondapur Near Hitech City Hyderabad | Flat 301 C/O Sharma Kondapoor Near Hi Tech City Hyd | 1.0 |
Anna Nagar 12B Chennai 600040 | 12B Anna Nagar Chennai | 1.0 |
BinaryCrossEntropyLoss with these parameters:
1{
2 "activation_fn": "torch.nn.modules.linear.Identity",
3 "pos_weight": null
4}sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
C/O Rakesh Tower C Sector 137 Gurgaon | C Tower Sec-137 Gurugram | 1.0 |
Tellapur Hyderabad | Telapur Hyderabad | 1.0 |
Flat 703 Electronic City Bangalore | Flat 703 Electronic City Mumbai | 0.0 |
BinaryCrossEntropyLoss with these parameters:
1{
2 "activation_fn": "torch.nn.modules.linear.Identity",
3 "pos_weight": null
4}num_train_epochs: 6learning_rate: 1.5e-05warmup_steps: 0.1weight_decay: 0.01gradient_accumulation_steps: 4disable_tqdm: Trueeval_strategy: epochper_device_eval_batch_size: 16load_best_model_at_end: Trueper_device_train_batch_size: 8num_train_epochs: 6max_steps: -1learning_rate: 1.5e-05lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_steps: 0.1optim: adamw_torch_fusedoptim_args: Noneweight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08optim_target_modules: Nonegradient_accumulation_steps: 4average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Falsefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Nonetorch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneuse_liger_kernel: Falseliger_kernel_config: Noneuse_cache: Falseneftune_noise_alpha: Nonetorch_empty_cache_steps: Noneauto_find_batch_size: Falselog_on_each_node: Truelogging_nan_inf_filter: Trueinclude_num_input_tokens_seen: nolog_level: passivelog_level_replica: warningdisable_tqdm: Trueproject: huggingfacetrackio_space_id: trackioeval_strategy: epochper_device_eval_batch_size: 16prediction_loss_only: Trueeval_on_start: Falseeval_do_concat_batches: Trueeval_use_gather_object: Falseeval_accumulation_steps: Noneinclude_for_metrics: []batch_eval_metrics: Falsesave_only_model: Falsesave_on_each_node: Falseenable_jit_checkpoint: Falsepush_to_hub: Falsehub_private_repo: Nonehub_model_id: Nonehub_strategy: every_savehub_always_push: Falsehub_revision: Noneload_best_model_at_end: Trueignore_data_skip: Falserestore_callback_states_from_checkpoint: Falsefull_determinism: Falseseed: 42data_seed: Noneuse_cpu: Falseaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedataloader_drop_last: Falsedataloader_num_workers: 0dataloader_pin_memory: Truedataloader_persistent_workers: Falsedataloader_prefetch_factor: Noneremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_backend: Noneddp_timeout: 1800fsdp: []fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}deepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonewarmup_ratio: Nonelocal_rank: -1prompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | Validation Loss | validation_average_precision |
|---|---|---|---|---|
| 0.2837 | 10 | 0.4552 | - | - |
| 0.5674 | 20 | 0.4294 | - | - |
| 0.8511 | 30 | 0.4078 | - | - |
| 1.0 | 36 | - | 0.2787 | 0.9570 |
| 1.1135 | 40 | 0.3982 | - | - |
| 1.3972 | 50 | 0.3678 | - | - |
| 1.6809 | 60 | 0.3367 | - | - |
| 1.9645 | 70 | 0.4198 | - | - |
| 2.0 | 72 | - | 0.2252 | 0.9702 |
| 2.2270 | 80 | 0.3148 | - | - |
| 2.5106 | 90 | 0.3862 | - | - |
| 2.7943 | 100 | 0.3374 | - | - |
| 3.0 | 108 | - | 0.1974 | 0.9725 |
| 3.0567 | 110 | 0.3272 | - | - |
| 3.3404 | 120 | 0.2932 | - | - |
| 3.6241 | 130 | 0.3010 | - | - |
| 3.9078 | 140 | 0.3119 | - | - |
| 4.0 | 144 | - | 0.1829 | 0.9736 |
| 4.1702 | 150 | 0.3005 | - | - |
| 4.4539 | 160 | 0.3292 | - | - |
| 4.7376 | 170 | 0.2207 | - | - |
| 5.0 | 180 | 0.2954 | 0.1745 | 0.9750 |
| 5.2837 | 190 | 0.2853 | - | - |
| 5.5674 | 200 | 0.2969 | - | - |
| 5.8511 | 210 | 0.2600 | - | - |
| 6.0 | 216 | - | 0.1719 | 0.9753 |
1@inproceedings{reimers-2019-sentence-bert,
2 title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
3 author = "Reimers, Nils and Gurevych, Iryna",
4 booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
5 month = "11",
6 year = "2019",
7 publisher = "Association for Computational Linguistics",
8 url = "https://arxiv.org/abs/1908.10084",
9}