---
language:
- en
license: apache-2.0
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:50
- loss:MultipleNegativesRankingLoss
base_model: sentence-transformers/all-MiniLM-L6-v2
widget:
- source_sentence: Two men on bicycles competing in a race.
sentences:
- People are riding bikes.
- A woman is doing a cartwheel.
- A few people are catching fish.
- source_sentence: A man selling donuts to a customer during a world exhibition event
held in the city of Angeles
sentences:
- An Indian woman is doing her laundry in a lake.
- A man selling donuts to a customer.
- A woman drinks her coffee in a small cafe.
- source_sentence: Kids are on a amusement ride.
sentences:
- A car is broke down on the side of the road.
- A man is wearing a blue shirt
- Kids ride an amusement ride.
- source_sentence: Two young children in blue jerseys, one with the number 9 and one
with the number 2 are standing on wooden steps in a bathroom and washing their
hands in a sink.
sentences:
- A woman is doing a cartwheel.
- Two kids in jackets walk to school.
- Two kids in numbered jerseys wash their hands.
- source_sentence: Two women having drinks and smoking cigarettes at the bar.
sentences:
- boys play football
- Three women are at a bar.
- Two women are at a bar.
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
- cosine_accuracy@1
- cosine_accuracy@3
- cosine_accuracy@5
- cosine_accuracy@10
- cosine_precision@1
- cosine_precision@3
- cosine_precision@5
- cosine_precision@10
- cosine_recall@1
- cosine_recall@3
- cosine_recall@5
- cosine_recall@10
- cosine_ndcg@10
- cosine_mrr@10
- cosine_map@100
model-index:
- name: all-MiniLM-L6-v2 finetuned on AllNLI
results:
- task:
type: information-retrieval
name: Information Retrieval
dataset:
name: NanoMSMARCO
type: NanoMSMARCO
metrics:
- type: cosine_accuracy@1
value: 0.36
name: Cosine Accuracy@1
- type: cosine_accuracy@3
value: 0.52
name: Cosine Accuracy@3
- type: cosine_accuracy@5
value: 0.58
name: Cosine Accuracy@5
- type: cosine_accuracy@10
value: 0.8
name: Cosine Accuracy@10
- type: cosine_precision@1
value: 0.36
name: Cosine Precision@1
- type: cosine_precision@3
value: 0.1733333333333333
name: Cosine Precision@3
- type: cosine_precision@5
value: 0.11599999999999999
name: Cosine Precision@5
- type: cosine_precision@10
value: 0.08
name: Cosine Precision@10
- type: cosine_recall@1
value: 0.36
name: Cosine Recall@1
- type: cosine_recall@3
value: 0.52
name: Cosine Recall@3
- type: cosine_recall@5
value: 0.58
name: Cosine Recall@5
- type: cosine_recall@10
value: 0.8
name: Cosine Recall@10
- type: cosine_ndcg@10
value: 0.5537649594026555
name: Cosine Ndcg@10
- type: cosine_mrr@10
value: 0.47934920634920636
name: Cosine Mrr@10
- type: cosine_map@100
value: 0.4904052935766491
name: Cosine Map@100
- task:
type: information-retrieval
name: Information Retrieval
dataset:
name: NanoNFCorpus
type: NanoNFCorpus
metrics:
- type: cosine_accuracy@1
value: 0.4
name: Cosine Accuracy@1
- type: cosine_accuracy@3
value: 0.6
name: Cosine Accuracy@3
- type: cosine_accuracy@5
value: 0.62
name: Cosine Accuracy@5
- type: cosine_accuracy@10
value: 0.72
name: Cosine Accuracy@10
- type: cosine_precision@1
value: 0.4
name: Cosine Precision@1
- type: cosine_precision@3
value: 0.35999999999999993
name: Cosine Precision@3
- type: cosine_precision@5
value: 0.324
name: Cosine Precision@5
- type: cosine_precision@10
value: 0.276
name: Cosine Precision@10
- type: cosine_recall@1
value: 0.03458800957047009
name: Cosine Recall@1
- type: cosine_recall@3
value: 0.06249836236458624
name: Cosine Recall@3
- type: cosine_recall@5
value: 0.08046568973676278
name: Cosine Recall@5
- type: cosine_recall@10
value: 0.13259147712553063
name: Cosine Recall@10
- type: cosine_ndcg@10
value: 0.32368179953782333
name: Cosine Ndcg@10
- type: cosine_mrr@10
value: 0.4918571428571428
name: Cosine Mrr@10
- type: cosine_map@100
value: 0.1389531634193327
name: Cosine Map@100
- task:
type: nano-beir
name: Nano BEIR
dataset:
name: NanoBEIR mean
type: NanoBEIR_mean
metrics:
- type: cosine_accuracy@1
value: 0.38
name: Cosine Accuracy@1
- type: cosine_accuracy@3
value: 0.56
name: Cosine Accuracy@3
- type: cosine_accuracy@5
value: 0.6
name: Cosine Accuracy@5
- type: cosine_accuracy@10
value: 0.76
name: Cosine Accuracy@10
- type: cosine_precision@1
value: 0.38
name: Cosine Precision@1
- type: cosine_precision@3
value: 0.2666666666666666
name: Cosine Precision@3
- type: cosine_precision@5
value: 0.22
name: Cosine Precision@5
- type: cosine_precision@10
value: 0.17800000000000002
name: Cosine Precision@10
- type: cosine_recall@1
value: 0.19729400478523504
name: Cosine Recall@1
- type: cosine_recall@3
value: 0.29124918118229315
name: Cosine Recall@3
- type: cosine_recall@5
value: 0.3302328448683814
name: Cosine Recall@5
- type: cosine_recall@10
value: 0.46629573856276535
name: Cosine Recall@10
- type: cosine_ndcg@10
value: 0.4387233794702394
name: Cosine Ndcg@10
- type: cosine_mrr@10
value: 0.4856031746031746
name: Cosine Mrr@10
- type: cosine_map@100
value: 0.3146792284979909
name: Cosine Map@100
---
# all-MiniLM-L6-v2 finetuned on AllNLI
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) on the all-nli dataset. It maps sentences & paragraphs to a 384-dimensional dense vector space and can be used for retrieval.
## Model Details
### Model Description
- **Model Type:** Sentence Transformer
- **Base model:** [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2)
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 384 dimensions
- **Similarity Function:** Cosine Similarity
- **Supported Modality:** Text
- **Training Dataset:**
- all-nli
- **Language:** en
- **License:** apache-2.0
### Model Sources
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
### Full Model Architecture
```
SentenceTransformer(
(0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'BertModel'})
(1): Pooling({'embedding_dimension': 384, 'pooling_mode': 'mean', '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("Hyperakan/all-MiniLM-L6-v2-smoke")
# Run inference
queries = [
'Two women having drinks and smoking cigarettes at the bar.',
]
documents = [
'Two women are at a bar.',
'Three women are at a bar.',
'boys play football',
]
query_embeddings = model.encode_query(queries)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings.shape)
# [1, 384] [3, 384]
# Get the similarity scores for the embeddings
similarities = model.similarity(query_embeddings, document_embeddings)
print(similarities)
# tensor([[ 0.7893, 0.6667, -0.1284]])
```
## Evaluation
### Metrics
#### Information Retrieval
* Datasets: `NanoMSMARCO` and `NanoNFCorpus`
* Evaluated with [InformationRetrievalEvaluator](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.sentence_transformer.evaluation.InformationRetrievalEvaluator)
| Metric | NanoMSMARCO | NanoNFCorpus |
|:--------------------|:------------|:-------------|
| cosine_accuracy@1 | 0.36 | 0.4 |
| cosine_accuracy@3 | 0.52 | 0.6 |
| cosine_accuracy@5 | 0.58 | 0.62 |
| cosine_accuracy@10 | 0.8 | 0.72 |
| cosine_precision@1 | 0.36 | 0.4 |
| cosine_precision@3 | 0.1733 | 0.36 |
| cosine_precision@5 | 0.116 | 0.324 |
| cosine_precision@10 | 0.08 | 0.276 |
| cosine_recall@1 | 0.36 | 0.0346 |
| cosine_recall@3 | 0.52 | 0.0625 |
| cosine_recall@5 | 0.58 | 0.0805 |
| cosine_recall@10 | 0.8 | 0.1326 |
| **cosine_ndcg@10** | **0.5538** | **0.3237** |
| cosine_mrr@10 | 0.4793 | 0.4919 |
| cosine_map@100 | 0.4904 | 0.139 |
#### Nano BEIR
* Dataset: `NanoBEIR_mean`
* Evaluated with [NanoBEIREvaluator](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.sentence_transformer.evaluation.NanoBEIREvaluator) with these parameters:
```json
{
"dataset_names": [
"msmarco",
"nfcorpus"
],
"dataset_id": "sentence-transformers/NanoBEIR-en"
}
```
| Metric | Value |
|:--------------------|:-----------|
| cosine_accuracy@1 | 0.38 |
| cosine_accuracy@3 | 0.56 |
| cosine_accuracy@5 | 0.6 |
| cosine_accuracy@10 | 0.76 |
| cosine_precision@1 | 0.38 |
| cosine_precision@3 | 0.2667 |
| cosine_precision@5 | 0.22 |
| cosine_precision@10 | 0.178 |
| cosine_recall@1 | 0.1973 |
| cosine_recall@3 | 0.2912 |
| cosine_recall@5 | 0.3302 |
| cosine_recall@10 | 0.4663 |
| **cosine_ndcg@10** | **0.4387** |
| cosine_mrr@10 | 0.4856 |
| cosine_map@100 | 0.3147 |
## Training Details
### Training Dataset
#### all-nli
* Dataset: all-nli
* Size: 50 training samples
* Columns: anchor, positive, and negative
* Approximate statistics based on the first 50 samples:
| | anchor | positive | negative |
|:---------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
| type | string | string | string |
| modality | text | text | text |
| details |
A person on a horse jumps over a broken down airplane. | A person is outdoors, on a horse. | A person is at a diner, ordering an omelette. |
| Children smiling and waving at camera | There are children present | The kids are frowning |
| A boy is jumping on skateboard in the middle of a red bridge. | The boy does a skateboarding trick. | The boy skates down the sidewalk. |
* Loss: [MultipleNegativesRankingLoss](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
```json
{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false,
"directions": [
"query_to_doc"
],
"partition_mode": "joint",
"hardness_mode": null,
"hardness_strength": 0.0
}
```
### Evaluation Dataset
#### all-nli
* Dataset: all-nli
* Size: 20 evaluation samples
* Columns: anchor, positive, and negative
* Approximate statistics based on the first 20 samples:
| | anchor | positive | negative |
|:---------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
| type | string | string | string |
| modality | text | text | text |
| details | Two women are embracing while holding to go packages. | Two woman are holding packages. | The men are fighting outside a deli. |
| Two young children in blue jerseys, one with the number 9 and one with the number 2 are standing on wooden steps in a bathroom and washing their hands in a sink. | Two kids in numbered jerseys wash their hands. | Two kids in jackets walk to school. |
| A man selling donuts to a customer during a world exhibition event held in the city of Angeles | A man selling donuts to a customer. | A woman drinks her coffee in a small cafe. |
* Loss: [MultipleNegativesRankingLoss](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
```json
{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false,
"directions": [
"query_to_doc"
],
"partition_mode": "joint",
"hardness_mode": null,
"hardness_strength": 0.0
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `per_device_train_batch_size`: 16
- `per_device_eval_batch_size`: 16
- `learning_rate`: 2e-05
- `weight_decay`: 0.01
- `num_train_epochs`: 1
- `max_steps`: 1
- `warmup_ratio`: 0.1
- `seed`: 12
- `bf16`: True
- `load_best_model_at_end`: True
- `batch_sampler`: no_duplicates
#### All Hyperparameters