---
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- dense
- generated_from_trainer
- dataset_size:10
- loss:MultipleNegativesRankingLoss
base_model: ibm-granite/granite-embedding-small-english-r2
widget:
- source_sentence: unsloth
sentences:
- A very large expanse of sea
- A long curved fruit that grows in clusters
- A library for fast model training and fine-tuning with reduced memory usage
- source_sentence: PyTorch
sentences:
- The region of the atmosphere and outer space seen from the earth
- Large language model capable of generating text
- An open source machine learning framework
pipeline_tag: sentence-similarity
library_name: sentence-transformers
---
# SentenceTransformer based on ibm-granite/granite-embedding-small-english-r2
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [ibm-granite/granite-embedding-small-english-r2](https://huggingface.co/ibm-granite/granite-embedding-small-english-r2). 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:** [ibm-granite/granite-embedding-small-english-r2](https://huggingface.co/ibm-granite/granite-embedding-small-english-r2)
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 384 dimensions
- **Similarity Function:** Cosine Similarity
### 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({'max_seq_length': 512, 'do_lower_case': False, 'architecture': 'PeftModelForFeatureExtraction'})
(1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, '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("sentence_transformers_model_id")
# Run inference
sentences = [
'PyTorch',
'An open source machine learning framework',
'The region of the atmosphere and outer space seen from the earth',
]
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.4991, 0.1094],
# [0.4991, 1.0000, 0.4888],
# [0.1094, 0.4888, 1.0000]])
```
## Training Details
### Training Dataset
#### Unnamed Dataset
* Size: 10 training samples
* Columns: anchor and positive
* Approximate statistics based on the first 10 samples:
| | anchor | positive |
|:--------|:-------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|
| type | string | string |
| details |
unsloth | A library for fast model training and fine-tuning with reduced memory usage |
| PyTorch | An open source machine learning framework |
| CUDA | A parallel computing platform and api model created by nvidia |
* 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
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `per_device_train_batch_size`: 10
- `learning_rate`: 0.0002
- `num_train_epochs`: 100
- `lr_scheduler_type`: constant
- `bf16`: True
#### All Hyperparameters