87 lines
2.4 KiB
Markdown
87 lines
2.4 KiB
Markdown
|
---
|
||
|
|
pipeline_tag: sentence-similarity
|
||
|
|
tags:
|
||
|
|
- sentence-transformers
|
||
|
|
- feature-extraction
|
||
|
|
- sentence-similarity
|
||
|
|
---
|
||
|
|
|
||
|
|
# {MODEL_NAME}
|
||
|
|
|
||
|
|
This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 256 dimensional dense vector space and can be used for tasks like clustering or semantic search.
|
||
|
|
|
||
|
|
<!--- Describe your model here -->
|
||
|
|
|
||
|
|
## Usage (Sentence-Transformers)
|
||
|
|
|
||
|
|
Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
|
||
|
|
|
||
|
|
```
|
||
|
|
pip install -U sentence-transformers
|
||
|
|
```
|
||
|
|
|
||
|
|
Then you can use the model like this:
|
||
|
|
|
||
|
|
```python
|
||
|
|
from sentence_transformers import SentenceTransformer
|
||
|
|
sentences = ["This is an example sentence", "Each sentence is converted"]
|
||
|
|
|
||
|
|
model = SentenceTransformer('{MODEL_NAME}')
|
||
|
|
embeddings = model.encode(sentences)
|
||
|
|
print(embeddings)
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Evaluation Results
|
||
|
|
|
||
|
|
<!--- Describe how your model was evaluated -->
|
||
|
|
|
||
|
|
For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
|
||
|
|
|
||
|
|
|
||
|
|
## Training
|
||
|
|
The model was trained with the parameters:
|
||
|
|
|
||
|
|
**DataLoader**:
|
||
|
|
|
||
|
|
`torch.utils.data.dataloader.DataLoader` of length 11 with parameters:
|
||
|
|
```
|
||
|
|
{'batch_size': 15, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
|
||
|
|
```
|
||
|
|
|
||
|
|
**Loss**:
|
||
|
|
|
||
|
|
`sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss`
|
||
|
|
|
||
|
|
Parameters of the fit()-Method:
|
||
|
|
```
|
||
|
|
{
|
||
|
|
"epochs": 5,
|
||
|
|
"evaluation_steps": 1,
|
||
|
|
"evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
|
||
|
|
"max_grad_norm": 1,
|
||
|
|
"optimizer_class": "<class 'transformers.optimization.AdamW'>",
|
||
|
|
"optimizer_params": {
|
||
|
|
"lr": 2e-05
|
||
|
|
},
|
||
|
|
"scheduler": "WarmupLinear",
|
||
|
|
"steps_per_epoch": null,
|
||
|
|
"warmup_steps": 6,
|
||
|
|
"weight_decay": 0.01
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Full Model Architecture
|
||
|
|
```
|
||
|
|
SentenceTransformer(
|
||
|
|
(0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: 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})
|
||
|
|
(2): Dense({'in_features': 768, 'out_features': 256, 'bias': True, 'activation_function': 'torch.nn.modules.activation.Tanh'})
|
||
|
|
)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Citing & Authors
|
||
|
|
|
||
|
|
<!--- Describe where people can find more information -->
|