-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from Rutam21/patch-11
Created impira/layoutlm-document-qa README.md File. Closes #13
- Loading branch information
Showing
1 changed file
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
![Cover](https://user-images.githubusercontent.com/66431403/267597217-2285216a-209c-466b-a0da-ab610356c2af.png) | ||
|
||
# layoutlm-document-qa | ||
|
||
## DagsHub Repository: https://dagshub.com/Rutam21/layoutlm-document-qa | ||
|
||
## Source: [HuggingFace layoutlm-document-qa Model](https://huggingface.co/impira/layoutlm-document-qa) | ||
|
||
# Description | ||
|
||
This is a fine-tuned version of the multi-modal [LayoutLM](https://aka.ms/layoutlm) model for the task of question answering on documents. It has been fine-tuned using both the [SQuAD2.0](https://huggingface.co/datasets/squad_v2) and [DocVQA](https://www.docvqa.org/) datasets. | ||
|
||
# Usage | ||
|
||
To run some of these examples, you must have [PIL](https://pillow.readthedocs.io/en/stable/installation.html), [pytesseract](https://pypi.org/project/pytesseract/), and [PyTorch](https://pytorch.org/get-started/locally/) installed in addition to [transformers](https://huggingface.co/docs/transformers/index). | ||
|
||
```python | ||
from transformers import pipeline | ||
|
||
nlp = pipeline( | ||
"document-question-answering", | ||
model="impira/layoutlm-document-qa", | ||
) | ||
|
||
nlp( | ||
"https://templates.invoicehome.com/invoice-template-us-neat-750px.png", | ||
"What is the invoice number?" | ||
) | ||
# {'score': 0.9943977, 'answer': 'us-001', 'start': 15, 'end': 15} | ||
|
||
nlp( | ||
"https://miro.medium.com/max/787/1*iECQRIiOGTmEFLdWkVIH2g.jpeg", | ||
"What is the purchase amount?" | ||
) | ||
# {'score': 0.9912159, 'answer': '$1,000,000,000', 'start': 97, 'end': 97} | ||
|
||
nlp( | ||
"https://www.accountingcoach.com/wp-content/uploads/2013/10/income-statement-example@2x.png", | ||
"What are the 2020 net sales?" | ||
) | ||
# {'score': 0.59147286, 'answer': '$ 3,750', 'start': 19, 'end': 20} | ||
``` | ||
|
||
**NOTE**: This model and pipeline was recently landed in transformers via [PR #18407](https://github.com/huggingface/transformers/pull/18407) and [PR #18414](https://github.com/huggingface/transformers/pull/18414), so you'll need to use a recent version of transformers. For example: | ||
|
||
```bash | ||
pip install git+https://github.com/huggingface/transformers.git@2ef774211733f0acf8d3415f9284c49ef219e991 | ||
``` | ||
|
||
# License | ||
|
||
This model is available on HuggingFace under the MIT License. | ||
|
||
# Citation | ||
|
||
```citation | ||
This model was created by the team at Impira. | ||
``` |