Add context encoder model

README.md

@@ -0,0 +1,80 @@
+---
+language: de
+license: mit
+thumbnail: https://thumb.tildacdn.com/tild3433-3637-4830-a533-353833613061/-/resize/720x/-/format/webp/germanquad.jpg
+tags:
+- exbert
+---
+
+![bert_image](https://thumb.tildacdn.com/tild3433-3637-4830-a533-353833613061/-/resize/720x/-/format/webp/germanquad.jpg)
+
+## Overview
+**Language model:** gbert-base-germandpr   
+**Language:** German  
+**Training data:** GermanDPR train set (~ 56MB)  
+**Eval data:** GermanDPR test set (~ 6MB)   
+**Infrastructure**: 4x V100 GPU  
+**Published**: Apr 26th, 2021
+
+## Details
+- We trained a dense passage retrieval model with two gbert-base models as encoders of questions and passages.
+- The dataset is GermanDPR, a new, German language dataset, which we hand-annotated and published [online](https://deepset.ai/germanquad).
+- It comprises 9275 question/answer pairs in the training set and 1025 pairs in the test set.
+For each pair, there are one positive context and three hard negative contexts.
+- As the basis of the training data, we used our hand-annotated GermanQuAD dataset as positive samples and generated hard negative samples from the latest German Wikipedia dump (6GB of raw txt files).
+- The data dump was cleaned with tailored scripts, leading to 2.8 million indexed passages from German Wikipedia.
+
+See https://deepset.ai/germanquad for more details and dataset download.
+
+## Hyperparameters
+```
+batch_size = 40
+n_epochs = 20
+num_training_steps = 4640
+num_warmup_steps = 460
+max_seq_len = 32 tokens for question encoder and 300 tokens for passage encoder
+learning_rate = 1e-6
+lr_schedule = LinearWarmup
+embeds_dropout_prob = 0.1
+num_hard_negatives = 2
+```
+## Performance
+During training, we monitored the in-batch average rank and the loss and evaluated different batch sizes, numbers of epochs, and number of hard negatives on a dev set split from the train set.
+The dev split contained 1030 question/answer pairs.
+Even without thorough hyperparameter tuning, we observed quite stable learning. Multiple restarts with different seeds produced quite similar results.
+Note that the in-batch average rank is influenced by settings for batch size and number of hard negatives. A smaller number of hard negatives makes the task easier.
+After fixing the hyperparameters we trained the model on the full GermanDPR train set.
+  
+We further evaluated the retrieval performance of the trained model on the full German Wikipedia with the GermanDPR test set as labels. To this end, we converted the GermanDPR test set to SQuAD format. The DPR model drastically outperforms the BM25 baseline with regard to recall@k.
+![performancetable](https://lh3.google.com/u/0/d/1lX6G0cp4NTx1yUWs74LI0Gcs41sYy_Fb=w2880-h1578-iv1)
+
+## Usage
+### In haystack
+You can load the model in [haystack](https://github.com/deepset-ai/haystack/) as a retriever for doing QA at scale:
+```python
+retriever = DensePassageRetriever(
+  document_store=document_store,
+  query_embedding_model="deepset/gbert-base-germandpr-question_encoder"
+  passage_embedding_model="deepset/gbert-base-germandpr-ctx_encoder"
+)
+```
+
+## Authors
+- Timo Möller: `timo.moeller [at] deepset.ai`
+- Julian Risch: `julian.risch [at] deepset.ai`
+- Malte Pietsch: `malte.pietsch [at] deepset.ai`
+## About us
+![deepset logo](https://raw.githubusercontent.com/deepset-ai/FARM/master/docs/img/deepset_logo.png)
+We bring NLP to the industry via open source!  
+Our focus: Industry specific language models & large scale QA systems.  
+  
+Some of our work: 
+- [German BERT (aka "bert-base-german-cased")](https://deepset.ai/german-bert)
+- [GermanQuAD and GermanDPR datasets and models (aka "gelectra-base-germanquad", "gbert-base-germandpr")](https://deepset.ai/germanquad)
+- [FARM](https://github.com/deepset-ai/FARM)
+- [Haystack](https://github.com/deepset-ai/haystack/)
+
+Get in touch:
+[Twitter](https://twitter.com/deepset_ai) | [LinkedIn](https://www.linkedin.com/company/deepset-ai/) | [Website](https://deepset.ai)  
+
+By the way: [we're hiring!](https://apply.workable.com/deepset/) 

config.json

@@ -0,0 +1,27 @@
+{
+  "_name_or_path": "../../gbert-base-germandpr/lm2/language_model.bin",
+  "architectures": [
+    "DPRContextEncoder"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "language": "english",
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "dpr",
+  "name": "DPRContextEncoder",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "projection_dim": 0,
+  "revision": null,
+  "transformers_version": "4.5.0",
+  "type_vocab_size": 2,
+  "vocab_size": 31102
+}

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:81027779cf0b4e3fea7843b6513ba80b1220346f43ea6ce783292734d5f4496c
+size 439804479

special_tokens_map.json

@@ -0,0 +1 @@
+{"unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]"}

tokenizer_config.json

@@ -0,0 +1 @@
+{"do_lower_case": false, "unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]", "tokenize_chinese_chars": true, "strip_accents": false, "max_len": 512, "special_tokens_map_file": null, "name_or_path": "deepset/gbert-base", "do_basic_tokenize": true, "never_split": null}