Initial commit (#1)

- Model sources and card (5077097c10597c32041e4eebde07de6d8a2ea4ca)

README.md

@@ -0,0 +1,85 @@
+---
+language:
+  - en
+---
+
+# Model Card for `passage-ranker-v1-XS-en`
+
+This model is a passage ranker developed by Sinequa. It produces a relevance score given a query-passage pair and is
+used to order search results.
+
+Model name: `passage-ranker-v1-XS-en`
+
+## Supported Languages
+
+The model was trained and tested in the following languages:
+
+- English
+
+## Scores
+
+| Metric              | Value |
+|:--------------------|------:|
+| Relevance (NDCG@10) | 0.438 |
+
+Note that the relevance score is computed as an average over 14 retrieval datasets (see
+[details below](#evaluation-metrics)).
+
+## Inference Times
+
+| GPU        | Batch size 32 |
+|:-----------|--------------:|
+| NVIDIA A10 |          8 ms |
+| NVIDIA T4  |         20 ms |
+
+The inference times only measure the time the model takes to process a single batch, it does not include pre- or
+post-processing steps like the tokenization.
+
+## Requirements
+
+- Minimal Sinequa version: 11.10.0
+- GPU memory usage: 170 MiB
+
+Note that GPU memory usage only includes how much GPU memory the actual model consumes on an NVIDIA T4 GPU with a batch
+size of 32. It does not include the fix amount of memory that is consumed by the ONNX Runtime upon initialization which
+can be around 0.5 to 1 GiB depending on the used GPU.
+
+## Model Details
+
+### Overview
+
+- Number of parameters: 11 million
+- Base language model: [English BERT-Mini](https://huggingface.co/google/bert_uncased_L-4_H-256_A-4)
+- Insensitive to casing and accents
+- Training procedure: [MonoBERT](https://arxiv.org/abs/1901.04085)
+
+### Training Data
+
+- MS MARCO Passage Ranking
+  ([Paper](https://arxiv.org/abs/1611.09268),
+  [Official Page](https://microsoft.github.io/msmarco/),
+  [English dataset on the HF dataset hub](https://huggingface.co/datasets/unicamp-dl/mmarco))
+
+### Evaluation Metrics
+
+To determine the relevance score, we averaged the results that we obtained when evaluating on the datasets of the
+[BEIR benchmark](https://github.com/beir-cellar/beir). Note that all these datasets are in English.
+
+| Dataset           | NDCG@10 |
+|:------------------|--------:|
+| Average           |   0.438 |
+|                   |         |
+| Arguana           |   0.524 |
+| CLIMATE-FEVER     |   0.150 |
+| DBPedia Entity    |   0.338 |
+| FEVER             |   0.706 |
+| FiQA-2018         |   0.269 |
+| HotpotQA          |   0.630 |
+| MS MARCO          |   0.328 |
+| NFCorpus          |   0.340 |
+| NQ                |   0.429 |
+| Quora             |   0.722 |
+| SCIDOCS           |   0.141 |
+| SciFact           |   0.627 |
+| TREC-COVID        |   0.628 |
+| Webis-Touche-2020 |   0.306 |

config.json

@@ -0,0 +1,23 @@
+{
+  "architectures": [
+    "BertForSequenceClassification"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "classifier_dropout": null,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 256,
+  "initializer_range": 0.02,
+  "intermediate_size": 1024,
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 4,
+  "num_hidden_layers": 4,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.23.1",
+  "type_vocab_size": 2,
+  "use_cache": true,
+  "vocab_size": 30522
+}

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:112ae3bb45ac90575b3f015f1fe9d41deaf008bb4184b3fa17d0bf04c754b81d
+size 44711239