From 6b1558bad877af56b41c4b72874ea683441eafc7 Mon Sep 17 00:00:00 2001
From: Felix MIKAELIAN <39884124+fmikaelian@users.noreply.github.com>
Date: Mon, 2 Mar 2020 23:07:13 +0100
Subject: [PATCH] add models cards for camembert-base-fquad
 camembert-base-squad (#3089)

* add models cards for camembert-base-fquad camembert-base-squad

* typo fix
---
 .../fmikaelian/camembert-base-fquad/README.md | 49 +++++++++++++++++++
 .../fmikaelian/camembert-base-squad/README.md | 49 +++++++++++++++++++
 2 files changed, 98 insertions(+)
 create mode 100644 model_cards/fmikaelian/camembert-base-fquad/README.md
 create mode 100644 model_cards/fmikaelian/camembert-base-squad/README.md

diff --git a/model_cards/fmikaelian/camembert-base-fquad/README.md b/model_cards/fmikaelian/camembert-base-fquad/README.md
new file mode 100644
index 0000000000..e37e3fa4a3
--- /dev/null
+++ b/model_cards/fmikaelian/camembert-base-fquad/README.md
@@ -0,0 +1,49 @@
+---
+language: french
+---
+
+# camembert-base-fquad
+
+## Description
+
+A baseline model for question-answering in french ([CamemBERT](https://camembert-model.fr/) model fine-tuned on [FQuAD](https://fquad.illuin.tech/))
+
+## Training hyperparameters
+
+```shell
+python3 ./examples/run_squad.py \
+--model_type camembert \
+--model_name_or_path camembert-base \
+--do_train \
+--do_eval \
+--do_lower_case \
+--train_file train.json \
+--predict_file valid.json \
+--learning_rate 3e-5 \
+--num_train_epochs 2 \
+--max_seq_length 384 \
+--doc_stride 128 \
+--output_dir output \
+--per_gpu_eval_batch_size=3 \
+--per_gpu_train_batch_size=3 \
+--save_steps 10000
+``` 
+
+## Evaluation results
+
+```shell
+{"f1": 77.24515316052342, "exact_match": 52.82308657465496}
+```
+
+## Usage
+
+```python
+from transformers import pipeline
+
+nlp = pipeline('question-answering', model='fmikaelian/camembert-base-fquad', tokenizer='fmikaelian/camembert-base-fquad')
+
+nlp({
+    'question': "Qui est Claude Monet?",
+    'context': "Claude Monet, né le 14 novembre 1840 à Paris et mort le 5 décembre 1926 à Giverny, est un peintre français et l’un des fondateurs de l'impressionnisme."
+})
+```
\ No newline at end of file
diff --git a/model_cards/fmikaelian/camembert-base-squad/README.md b/model_cards/fmikaelian/camembert-base-squad/README.md
new file mode 100644
index 0000000000..a6c9f54374
--- /dev/null
+++ b/model_cards/fmikaelian/camembert-base-squad/README.md
@@ -0,0 +1,49 @@
+---
+language: french
+---
+
+# camembert-base-squad
+
+## Description
+
+A baseline model for question-answering in french ([CamemBERT](https://camembert-model.fr/) model fine-tuned on [french-translated SQuAD 1.1 dataset](https://github.com/Alikabbadj/French-SQuAD))
+
+## Training hyperparameters
+
+```shell
+python3 ./examples/run_squad.py \
+--model_type camembert \
+--model_name_or_path camembert-base \
+--do_train \
+--do_eval \
+--do_lower_case \
+--train_file SQuAD-v1.1-train_fr_ss999_awstart2_net.json \
+--predict_file SQuAD-v1.1-dev_fr_ss999_awstart2_net.json \
+--learning_rate 3e-5 \
+--num_train_epochs 2 \
+--max_seq_length 384 \
+--doc_stride 128 \
+--output_dir output3 \
+--per_gpu_eval_batch_size=3 \
+--per_gpu_train_batch_size=3 \
+--save_steps 10000
+``` 
+
+## Evaluation results
+
+```shell
+{"f1": 79.8570684959745, "exact_match": 59.21327108373895}
+```
+
+## Usage
+
+```python
+from transformers import pipeline
+
+nlp = pipeline('question-answering', model='fmikaelian/camembert-base-squad', tokenizer='fmikaelian/camembert-base-squad')
+
+nlp({
+    'question': "Qui est Claude Monet?",
+    'context': "Claude Monet, né le 14 novembre 1840 à Paris et mort le 5 décembre 1926 à Giverny, est un peintre français et l’un des fondateurs de l'impressionnisme."
+})
+```
\ No newline at end of file