---
language:
- en
tags:
- sentence-transformers
- cross-encoder
- generated_from_trainer
- dataset_size:78704
- loss:ListMLELoss
base_model: microsoft/MiniLM-L12-H384-uncased
datasets:
- microsoft/ms_marco
pipeline_tag: text-ranking
library_name: sentence-transformers
metrics:
- map
- mrr@10
- ndcg@10
model-index:
- name: CrossEncoder based on microsoft/MiniLM-L12-H384-uncased
results:
- task:
type: cross-encoder-reranking
name: Cross Encoder Reranking
dataset:
name: NanoMSMARCO R100
type: NanoMSMARCO_R100
metrics:
- type: map
value: 0.3407
name: Map
- type: mrr@10
value: 0.3234
name: Mrr@10
- type: ndcg@10
value: 0.3834
name: Ndcg@10
- task:
type: cross-encoder-reranking
name: Cross Encoder Reranking
dataset:
name: NanoNFCorpus R100
type: NanoNFCorpus_R100
metrics:
- type: map
value: 0.2803
name: Map
- type: mrr@10
value: 0.3818
name: Mrr@10
- type: ndcg@10
value: 0.252
name: Ndcg@10
- task:
type: cross-encoder-reranking
name: Cross Encoder Reranking
dataset:
name: NanoNQ R100
type: NanoNQ_R100
metrics:
- type: map
value: 0.2448
name: Map
- type: mrr@10
value: 0.2333
name: Mrr@10
- type: ndcg@10
value: 0.2953
name: Ndcg@10
- task:
type: cross-encoder-nano-beir
name: Cross Encoder Nano BEIR
dataset:
name: NanoBEIR R100 mean
type: NanoBEIR_R100_mean
metrics:
- type: map
value: 0.2886
name: Map
- type: mrr@10
value: 0.3128
name: Mrr@10
- type: ndcg@10
value: 0.3103
name: Ndcg@10
---
# CrossEncoder based on microsoft/MiniLM-L12-H384-uncased
This is a [Cross Encoder](https://www.sbert.net/docs/cross_encoder/usage/usage.html) model finetuned from [microsoft/MiniLM-L12-H384-uncased](https://huggingface.co/microsoft/MiniLM-L12-H384-uncased) on the [ms_marco](https://huggingface.co/datasets/microsoft/ms_marco) 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:** [microsoft/MiniLM-L12-H384-uncased](https://huggingface.co/microsoft/MiniLM-L12-H384-uncased)
- **Maximum Sequence Length:** 512 tokens
- **Number of Output Labels:** 1 label
- **Training Dataset:**
- [ms_marco](https://huggingface.co/datasets/microsoft/ms_marco)
- **Language:** en
### 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("Wi-Fi/reranker-msmarco-v1.1-MiniLM-L12-H384-uncased-listmle")
# Get scores for pairs of texts
pairs = [
['what schooling is required to become a nephrologist', 'Educational Requirements. Necessary education to become a nephrologist includes a medical doctoral degree, completion of an Accreditation Council for Graduate Medical Education (ACGME) internal medicine residency program and at least two years of professional experience working with patients. '],
['what schooling is required to become a nephrologist', 'How to Become a Nephrologist. Nephrology is a discipline of internal medicine that focuses on the kidney and related conditions and diseases. Nephrologists are specially trained medical doctors that are experts on treating patients with conditions related to the kidneys and other related areas. Nephrologists diagnose and treat a variety of conditions such as kidney disease, electrolyte disorders, high blood pressure, and kidney stones. They perform many different types of tests to assist in diagnosis and treatments such as blood tests, urine tests, biopsies, ultrasounds, and placement of catheters.'],
['what schooling is required to become a nephrologist', '10. While in your residency period, try to make contacts with other nephrologists. Having good contacts in the field of nephrology, as well as urology, is a very good step while in your residency and if you are sure of becoming a nephrologist. Since nephrology is a branch of internal medicine, you will have to do your residency in internal medicine first. During your residency period, you will work in a hospital. You are responsible for patients, and supervised by senior residents as well as professional doctors'],
['what schooling is required to become a nephrologist', "Residency and Fellowships. Graduation from medical school is just the beginning of the nephrologist's medical education. After graduation, newly minted doctors do their medical residency at a hospital. Would-be nephrologists complete an internal medicine residency, which lasts for three years. Medical School. Budding nephrologists must graduate from a medical school. The road just to get into medical school after graduation from an accredited four-year college or university is arduous."],
['what schooling is required to become a nephrologist', 'Formal education and training requirements for physicians are among the most demanding of any occupation-4 years of undergraduate school, 4 years of medical school, and 3 to 8 years of internship and residency, depending on the specialty selected. Physicians specializing in anesthesiology must spend a substantial number of years completing education and training requirements, including 4 years of undergraduate school, 4 … years of medical school, and 3 to 8 years of residency.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'what schooling is required to become a nephrologist',
[
'Educational Requirements. Necessary education to become a nephrologist includes a medical doctoral degree, completion of an Accreditation Council for Graduate Medical Education (ACGME) internal medicine residency program and at least two years of professional experience working with patients. ',
'How to Become a Nephrologist. Nephrology is a discipline of internal medicine that focuses on the kidney and related conditions and diseases. Nephrologists are specially trained medical doctors that are experts on treating patients with conditions related to the kidneys and other related areas. Nephrologists diagnose and treat a variety of conditions such as kidney disease, electrolyte disorders, high blood pressure, and kidney stones. They perform many different types of tests to assist in diagnosis and treatments such as blood tests, urine tests, biopsies, ultrasounds, and placement of catheters.',
'10. While in your residency period, try to make contacts with other nephrologists. Having good contacts in the field of nephrology, as well as urology, is a very good step while in your residency and if you are sure of becoming a nephrologist. Since nephrology is a branch of internal medicine, you will have to do your residency in internal medicine first. During your residency period, you will work in a hospital. You are responsible for patients, and supervised by senior residents as well as professional doctors',
"Residency and Fellowships. Graduation from medical school is just the beginning of the nephrologist's medical education. After graduation, newly minted doctors do their medical residency at a hospital. Would-be nephrologists complete an internal medicine residency, which lasts for three years. Medical School. Budding nephrologists must graduate from a medical school. The road just to get into medical school after graduation from an accredited four-year college or university is arduous.",
'Formal education and training requirements for physicians are among the most demanding of any occupation-4 years of undergraduate school, 4 years of medical school, and 3 to 8 years of internship and residency, depending on the specialty selected. Physicians specializing in anesthesiology must spend a substantial number of years completing education and training requirements, including 4 years of undergraduate school, 4 … years of medical school, and 3 to 8 years of residency.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
```
## Evaluation
### Metrics
#### Cross Encoder Reranking
* Datasets: `NanoMSMARCO_R100`, `NanoNFCorpus_R100` and `NanoNQ_R100`
* Evaluated with [CrossEncoderRerankingEvaluator
](https://sbert.net/docs/package_reference/cross_encoder/evaluation.html#sentence_transformers.cross_encoder.evaluation.CrossEncoderRerankingEvaluator) with these parameters:
```json
{
"at_k": 10,
"always_rerank_positives": true
}
```
| Metric | NanoMSMARCO_R100 | NanoNFCorpus_R100 | NanoNQ_R100 |
|:------------|:---------------------|:---------------------|:---------------------|
| map | 0.3407 (-0.1489) | 0.2803 (+0.0193) | 0.2448 (-0.1748) |
| mrr@10 | 0.3234 (-0.1541) | 0.3818 (-0.1180) | 0.2333 (-0.1934) |
| **ndcg@10** | **0.3834 (-0.1570)** | **0.2520 (-0.0730)** | **0.2953 (-0.2053)** |
#### Cross Encoder Nano BEIR
* Dataset: `NanoBEIR_R100_mean`
* Evaluated with [CrossEncoderNanoBEIREvaluator
](https://sbert.net/docs/package_reference/cross_encoder/evaluation.html#sentence_transformers.cross_encoder.evaluation.CrossEncoderNanoBEIREvaluator) with these parameters:
```json
{
"dataset_names": [
"msmarco",
"nfcorpus",
"nq"
],
"rerank_k": 100,
"at_k": 10,
"always_rerank_positives": true
}
```
| Metric | Value |
|:------------|:---------------------|
| map | 0.2886 (-0.1015) |
| mrr@10 | 0.3128 (-0.1552) |
| **ndcg@10** | **0.3103 (-0.1451)** |
## Training Details
### Training Dataset
#### ms_marco
* Dataset: [ms_marco](https://huggingface.co/datasets/microsoft/ms_marco) at [a47ee7a](https://huggingface.co/datasets/microsoft/ms_marco/tree/a47ee7aae8d7d466ba15f9f0bfac3b3681087b3a)
* Size: 78,704 training samples
* Columns: query
, docs
, and labels
* Approximate statistics based on the first 1000 samples:
| | query | docs | labels |
|:--------|:-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|
| type | string | list | list |
| details |
'average cost of hospital stay per day for sepsis'
| ['1 The incremental costs incurred by patients on their last full day of hospital stay were $420 per day on average, or just 2.4 percent of the $17,734 average total cost. 2 End-of-stay costs represented only a slightly higher percentage of total costs when the length of stay was as short as four days.', 'Cost per stay and cost per day for hospitalizations with a secondary diagnosis of septicemia also. increased between 2000 and 2009 (from $30,900 to $33,900; from $2,100 to $2,300), although the. average length of these stays remained relatively stable.', 'They found: 1 The incremental costs incurred by patients on their last full day of hospital stay were $420 per day on average, or just 2.4 percent of the $17,734 average total cost. 2 End-of-stay costs represented only a slightly higher percentage of total costs when the length of stay was as short as four days.', '60 percent of hospital stays in 2011. Forty-seven percent of aggregate costs were billed to Medicare, and. the mean c...
| [1, 0, 0, 0, 0, ...]
|
| what is lion tailing of trees
| ["Lion's tail pruning is a method of pruning the lower branches from tree limbs, leaving a top tuft of foliage that resembles a lion's tail. Previously advocated by some arborists as a way of increasing a tree's wind resistance, the practice has become controversial. ", 'Lions-tailed. This over-lifting or over-thinning is often referred to as lions-tailing. It leaves live branches only at the tips of the canopy. Tremendous numbers of sprouts often result from this type of tree mutilation.', 'To the untrained eye, a lion-tailed tree may appear to be well groomed. Many tree trimmers who routinely lion-tail trees are unaware of the problems that they cause. Lion-tailing is harmful to trees and it increases susceptibility to wind-failure. Clients may ask for this type of pruning because they’re unaware that the practice is detrimental to their trees. Many of these trees are hundreds of years old and can be seen on private, city, county and community properties. It is a practice of trimming...
| [1, 1, 0, 0, 0, ...]
|
| where is kuwait on the world map
| ["Kuwait is located in the Middle East. Kuwait is bordered by the Persian Gulf to the east, Iraq to the west and north, and Saudi Arabia to the south. Iraq, Saudi Arabia. Abdali, Al Ahmadi, Al Jahra, Al Khiran, Al Kuwayt (Kuwait), Al Wafrah, As Subayhiyah, Ash Shuwayhk, Az Zawr, Bubiyan, Mardaz Hudud al Abdali, Mina' 'Abd Allah and Qasr as Sabiyah.", 'Iraq. Iraq is located in the Middle East. It is bound by Iran to the east, Turkey to the north, Syria to the northwest, Jordan to the west, Saudi Arabia to the southwest and south as well as Kuwait and the Persian Gulf to the southeast....', 'Map of Kuwait: Map of the World Map of Asia Map of Kuwait. Map-Kuwait. Google-Kuwait. Earth-Kuwait. Weather-Kuwait. World Map Finder, Map of Kuwait. The best web resource for', 'The State of Kuwait is a sovereign emirate on the coast of the Persian Gulf, enclosed by Saudi Arabia to the south and Iraq to the north and west. The name is a diminutive of an Arabic word meaning fortress built near water.....
| [1, 0, 0, 0, 0, ...]
|
* Loss: [ListMLELoss
](https://sbert.net/docs/package_reference/cross_encoder/losses.html#listmleloss) with these parameters:
```json
{
"activation_fn": "torch.nn.modules.linear.Identity",
"mini_batch_size": 16,
"respect_input_order": true
}
```
### Evaluation Dataset
#### ms_marco
* Dataset: [ms_marco](https://huggingface.co/datasets/microsoft/ms_marco) at [a47ee7a](https://huggingface.co/datasets/microsoft/ms_marco/tree/a47ee7aae8d7d466ba15f9f0bfac3b3681087b3a)
* Size: 1,000 evaluation samples
* Columns: query
, docs
, and labels
* Approximate statistics based on the first 1000 samples:
| | query | docs | labels |
|:--------|:----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|
| type | string | list | list |
| details | what schooling is required to become a nephrologist
| ['Educational Requirements. Necessary education to become a nephrologist includes a medical doctoral degree, completion of an Accreditation Council for Graduate Medical Education (ACGME) internal medicine residency program and at least two years of professional experience working with patients. ', 'How to Become a Nephrologist. Nephrology is a discipline of internal medicine that focuses on the kidney and related conditions and diseases. Nephrologists are specially trained medical doctors that are experts on treating patients with conditions related to the kidneys and other related areas. Nephrologists diagnose and treat a variety of conditions such as kidney disease, electrolyte disorders, high blood pressure, and kidney stones. They perform many different types of tests to assist in diagnosis and treatments such as blood tests, urine tests, biopsies, ultrasounds, and placement of catheters.', '10. While in your residency period, try to make contacts with other nephrologists. Having g...
| [1, 0, 0, 0, 0, ...]
|
| shelled peanut/ carb or protein
| ['One serving of shelled peanuts provides 6 g of carbohydrates and also provides 7 g of protein. Salted shelled peanuts contain 230 mg of sodium, 187 mg of potassium, but they do not provide vitamin A, vitamin C, calcium or iron. Unsalted shelled peanuts contain no sodium, calcium or iron, but they do provide 180 mg of potassium. Both salted and unsalted shelled peanuts provide 2 g of dietary fiber.', 'Carbs in Peanuts. The favorite choice for the term Peanuts is 1 ounce of Peanuts which has about 5 grams of carbohydrate. The total carbohyrate, sugar, fiber and estimated net carbs (non-fiber carbs) for a variety of types and serving sizes of Peanuts is shown below. View other nutritional values (such as Calories or Fats) using the filter below: Calories | Total Carbs | Total Fats | Protein | Sodium | Cholesterol | Vitamins.', 'A 1-ounce serving of peanuts provides 7g of protein, which can meet up to 15 percent of your daily protein needs. Fiber, which accounts for over 1/3 of the carbohydrates in peanuts, is beneficial to the digestive system and slows the absorption of sugar and fat, helping your body regulate blood sugar levels.', 'Protein, fats, and fiber are the major components that make up peanuts. The good news is that these major components are all the healthy types when it comes to peanuts. The protein is plant-based; the fat is unsaturated, and the fiber is the main type of complex carbohydrate in peanuts.', 'When you think of healthy fats, you can think of peanuts, peanut butter, and peanut oil. That is because at least half of the fat in peanuts is heart-healthy monounsaturated fat, the kind found in olive oil and avocados. And over 30% is polyunsaturated fat; another good fat important in a healthy diet.']
| [1, 0, 0, 0, 0]
|
| terahertz radiation definition
| ['SecurActive Performance Vision. The terahertz, abbreviated THz, is a unit of electromagnetic (EM) wave frequency equal to one trillion hertz (10 12 Hz). The terahertz is used as an indicator of the frequency of infrared (IR), visible, and ultraviolet (UV) radiation. Download this Pocket Guide to Network Management and Monitoring. The terahertz is not commonly used in computer and wireless technology, although it is possible that a microprocessor with a clock speed of 1 THz might someday be developed.', 'Electromagnetic radiation with waves of frequencies ranging from 0.3 × 10 12 to 3 × 10 12 hertz and of wavelengths ranging from 0.1 to 1 millimeter of potential use in detection, imaging, and communications technologies. Also called submillimeter radiation. Radiation from airport body scanner may detect early signs of skin ... by Asian News International. is non-ionizing, and reliable studies have shown that active operation in this frequency band is harmless to humans.', 'How to cite...
| [1, 0, 0, 0, 0, ...]
|
* Loss: [ListMLELoss
](https://sbert.net/docs/package_reference/cross_encoder/losses.html#listmleloss) with these parameters:
```json
{
"activation_fn": "torch.nn.modules.linear.Identity",
"mini_batch_size": 16,
"respect_input_order": true
}
```
### 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`: 1
- `warmup_ratio`: 0.1
- `seed`: 12
- `bf16`: True
- `load_best_model_at_end`: True
#### All Hyperparameters