Adding a model card (#5)
Browse files- Adding a model card (52f32295c42ed95680f0a4eb2cbbcded14947e84)
- Update README.md (8c95092c3b6d2aca2c5727463c4027df5fc9561e)
README.md
CHANGED
@@ -24,3 +24,72 @@ model-index:
|
|
24 |
value: 83.8765
|
25 |
verified: true
|
26 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
24 |
value: 83.8765
|
25 |
verified: true
|
26 |
---
|
27 |
+
|
28 |
+
# bert-large-uncased-whole-word-masking-squad2
|
29 |
+
|
30 |
+
This is a berta-large model, fine-tuned using the SQuAD2.0 dataset for the task of question answering.
|
31 |
+
|
32 |
+
## Overview (example - fill to need)
|
33 |
+
**Language model:** bert-large
|
34 |
+
**Language:** English
|
35 |
+
**Downstream-task:** Extractive QA
|
36 |
+
**Training data:** SQuAD 2.0
|
37 |
+
**Eval data:** SQuAD 2.0
|
38 |
+
**Code:** See [an example QA pipeline on Haystack](https://haystack.deepset.ai/tutorials/first-qa-system)
|
39 |
+
|
40 |
+
## Usage
|
41 |
+
|
42 |
+
### In Haystack
|
43 |
+
Haystack is an NLP framework by deepset. You can use this model in a Haystack pipeline to do question answering at scale (over many documents). To load the model in [Haystack](https://github.com/deepset-ai/haystack/):
|
44 |
+
```python
|
45 |
+
reader = FARMReader(model_name_or_path="deepset/bert-large-uncased-whole-word-masking-squad2")
|
46 |
+
# or
|
47 |
+
reader = TransformersReader(model_name_or_path="FILL",tokenizer="deepset/bert-large-uncased-whole-word-masking-squad2")
|
48 |
+
```
|
49 |
+
|
50 |
+
### In Transformers
|
51 |
+
```python
|
52 |
+
from transformers import AutoModelForQuestionAnswering, AutoTokenizer, pipeline
|
53 |
+
|
54 |
+
model_name = "deepset/bert-large-uncased-whole-word-masking-squad2"
|
55 |
+
|
56 |
+
# a) Get predictions
|
57 |
+
nlp = pipeline('question-answering', model=model_name, tokenizer=model_name)
|
58 |
+
QA_input = {
|
59 |
+
'question': 'Why is model conversion important?',
|
60 |
+
'context': 'The option to convert models between FARM and transformers gives freedom to the user and let people easily switch between frameworks.'
|
61 |
+
}
|
62 |
+
res = nlp(QA_input)
|
63 |
+
|
64 |
+
# b) Load model & tokenizer
|
65 |
+
model = AutoModelForQuestionAnswering.from_pretrained(model_name)
|
66 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
67 |
+
```
|
68 |
+
|
69 |
+
## About us
|
70 |
+
<div class="grid lg:grid-cols-2 gap-x-4 gap-y-3">
|
71 |
+
<div class="w-full h-40 object-cover mb-2 rounded-lg flex items-center justify-center">
|
72 |
+
<img alt="" src="https://raw.githubusercontent.com/deepset-ai/.github/main/deepset-logo-colored.png" class="w-40"/>
|
73 |
+
</div>
|
74 |
+
<div class="w-full h-40 object-cover mb-2 rounded-lg flex items-center justify-center">
|
75 |
+
<img alt="" src="https://raw.githubusercontent.com/deepset-ai/.github/main/haystack-logo-colored.png" class="w-40"/>
|
76 |
+
</div>
|
77 |
+
</div>
|
78 |
+
|
79 |
+
[deepset](http://deepset.ai/) is the company behind the open-source NLP framework [Haystack](https://haystack.deepset.ai/) which is designed to help you build production ready NLP systems that use: Question answering, summarization, ranking etc.
|
80 |
+
|
81 |
+
|
82 |
+
Some of our other work:
|
83 |
+
- [Distilled roberta-base-squad2 (aka "tinyroberta-squad2")]([https://huggingface.co/deepset/tinyroberta-squad2)
|
84 |
+
- [German BERT (aka "bert-base-german-cased")](https://deepset.ai/german-bert)
|
85 |
+
- [GermanQuAD and GermanDPR datasets and models (aka "gelectra-base-germanquad", "gbert-base-germandpr")](https://deepset.ai/germanquad)
|
86 |
+
|
87 |
+
## Get in touch and join the Haystack community
|
88 |
+
|
89 |
+
<p>For more info on Haystack, visit our <strong><a href="https://github.com/deepset-ai/haystack">GitHub</a></strong> repo and <strong><a href="https://docs.haystack.deepset.ai">Documentation</a></strong>.
|
90 |
+
|
91 |
+
We also have a <strong><a class="h-7" href="https://haystack.deepset.ai/community">Discord community open to everyone!</a></strong></p>
|
92 |
+
|
93 |
+
[Twitter](https://twitter.com/deepset_ai) | [LinkedIn](https://www.linkedin.com/company/deepset-ai/) | [Discord](https://haystack.deepset.ai/community/join) | [GitHub Discussions](https://github.com/deepset-ai/haystack/discussions) | [Website](https://deepset.ai)
|
94 |
+
|
95 |
+
By the way: [we're hiring!](http://www.deepset.ai/jobs)
|