---
tags:
- sentence-transformers
- cross-encoder
- reranker
- generated_from_trainer
- dataset_size:1548
- loss:BinaryCrossEntropyLoss
base_model: Alibaba-NLP/gte-multilingual-reranker-base
pipeline_tag: text-ranking
library_name: sentence-transformers
---
# CrossEncoder based on Alibaba-NLP/gte-multilingual-reranker-base
This is a [Cross Encoder](https://www.sbert.net/docs/cross_encoder/usage/usage.html) model finetuned from [Alibaba-NLP/gte-multilingual-reranker-base](https://huggingface.co/Alibaba-NLP/gte-multilingual-reranker-base) on the json dataset using the [sentence-transformers](https://www.SBERT.net) library. It computes scores for pairs of texts, which can be used for text reranking and semantic search.
## Model Details
### Model Description
- **Model Type:** Cross Encoder
- **Base model:** [Alibaba-NLP/gte-multilingual-reranker-base](https://huggingface.co/Alibaba-NLP/gte-multilingual-reranker-base)
- **Maximum Sequence Length:** 8192 tokens
- **Number of Output Labels:** 1 label
- **Training Dataset:**
- json
### Model Sources
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Documentation:** [Cross Encoder Documentation](https://www.sbert.net/docs/cross_encoder/usage/usage.html)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
- **Hugging Face:** [Cross Encoders on Hugging Face](https://huggingface.co/models?library=sentence-transformers&other=cross-encoder)
## 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 CrossEncoder
# Download from the 🤗 Hub
model = CrossEncoder("cross_encoder_model_id")
# Get scores for pairs of texts
pairs = [
['приймати позу самовдоволеного, виявляючи пиху, зазнайство', 'having a mutual understanding or shared thoughts'],
['приймати позу самовдоволеного, виявляючи пиху, зазнайство', 'in trouble or state of shame'],
['приймати позу самовдоволеного, виявляючи пиху, зазнайство', 'someone who scrounges from others'],
['приймати позу самовдоволеного, виявляючи пиху, зазнайство', 'to subtly and indirectly seek praise, validation, or admiration from others'],
['приймати позу самовдоволеного, виявляючи пиху, зазнайство', 'to be on the verge of doing something'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'приймати позу самовдоволеного, виявляючи пиху, зазнайство',
[
'having a mutual understanding or shared thoughts',
'in trouble or state of shame',
'someone who scrounges from others',
'to subtly and indirectly seek praise, validation, or admiration from others',
'to be on the verge of doing something',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
```
## Training Details
### Training Dataset
#### json
* Dataset: json
* Size: 1,548 training samples
* Columns: text1, text2, and label
* Approximate statistics based on the first 1000 samples:
| | text1 | text2 | label |
|:--------|:-----------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------|:------------------------------------------------|
| type | string | string | int |
| details |
уживається для вираження повного заперечення; ні | уживається для повного заперечення змісту зазначеного слова; зовсім не (треба) | 1 |
| уживається для вираження повного заперечення; ні | уживається для вираження заперечення чогось | 1 |
| уживається для вираження повного заперечення; ні | уживається для повного заперечення змісту зазначеного слова; зовсім не (розбиратися) | 1 |
* Loss: [BinaryCrossEntropyLoss](https://sbert.net/docs/package_reference/cross_encoder/losses.html#binarycrossentropyloss) with these parameters:
```json
{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
```
### Evaluation Dataset
#### json
* Dataset: json
* Size: 225 evaluation samples
* Columns: text1, text2, and label
* Approximate statistics based on the first 225 samples:
| | text1 | text2 | label |
|:--------|:------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------|:------------------------------------------------|
| type | string | string | int |
| details | приймати позу самовдоволеного, виявляючи пиху, зазнайство | having a mutual understanding or shared thoughts | 0 |
| приймати позу самовдоволеного, виявляючи пиху, зазнайство | in trouble or state of shame | 0 |
| приймати позу самовдоволеного, виявляючи пиху, зазнайство | someone who scrounges from others | 0 |
* Loss: [BinaryCrossEntropyLoss](https://sbert.net/docs/package_reference/cross_encoder/losses.html#binarycrossentropyloss) with these parameters:
```json
{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `eval_strategy`: steps
- `per_device_train_batch_size`: 16
- `per_device_eval_batch_size`: 16
- `learning_rate`: 2e-05
- `num_train_epochs`: 2
- `warmup_ratio`: 0.1
- `fp16`: True
- `load_best_model_at_end`: True
#### All Hyperparameters