|
--- |
|
library_name: transformers |
|
license: gemma |
|
datasets: |
|
- naver-clova-ix/cord-v2 |
|
language: |
|
- en |
|
--- |
|
|
|
# Model Card for Model ID |
|
|
|
<!-- Provide a quick summary of what the model is/does. --> |
|
Input - Receipt image <br> |
|
Output - JSON |
|
|
|
## Model Details |
|
|
|
Taken from Donut: |
|
|
|
``` |
|
### Use this code to convert the generated output to JSON |
|
def token2json(tokens, is_inner_value=False, added_vocab=None): |
|
""" |
|
Convert a (generated) token sequence into an ordered JSON format. |
|
""" |
|
if added_vocab is None: |
|
added_vocab = processor.tokenizer.get_added_vocab() |
|
|
|
output = {} |
|
|
|
while tokens: |
|
start_token = re.search(r"<s_(.*?)>", tokens, re.IGNORECASE) |
|
if start_token is None: |
|
break |
|
key = start_token.group(1) |
|
key_escaped = re.escape(key) |
|
|
|
end_token = re.search(rf"</s_{key_escaped}>", tokens, re.IGNORECASE) |
|
start_token = start_token.group() |
|
if end_token is None: |
|
tokens = tokens.replace(start_token, "") |
|
else: |
|
end_token = end_token.group() |
|
start_token_escaped = re.escape(start_token) |
|
end_token_escaped = re.escape(end_token) |
|
content = re.search( |
|
f"{start_token_escaped}(.*?){end_token_escaped}", tokens, re.IGNORECASE | re.DOTALL |
|
) |
|
if content is not None: |
|
content = content.group(1).strip() |
|
if r"<s_" in content and r"</s_" in content: # non-leaf node |
|
value = token2json(content, is_inner_value=True, added_vocab=added_vocab) |
|
if value: |
|
if len(value) == 1: |
|
value = value[0] |
|
output[key] = value |
|
else: # leaf nodes |
|
output[key] = [] |
|
for leaf in content.split(r"<sep/>"): |
|
leaf = leaf.strip() |
|
if leaf in added_vocab and leaf[0] == "<" and leaf[-2:] == "/>": |
|
leaf = leaf[1:-2] # for categorical special tokens |
|
output[key].append(leaf) |
|
if len(output[key]) == 1: |
|
output[key] = output[key][0] |
|
|
|
tokens = tokens[tokens.find(end_token) + len(end_token) :].strip() |
|
if tokens[:6] == r"<sep/>": # non-leaf nodes |
|
return [output] + token2json(tokens[6:], is_inner_value=True, added_vocab=added_vocab) |
|
|
|
if len(output): |
|
return [output] if is_inner_value else output |
|
else: |
|
return [] if is_inner_value else {"text_sequence": tokens} |
|
``` |
|
|
|
### Model Description |
|
|
|
<!-- Provide a longer summary of what this model is. --> |
|
|
|
This is the model card of a 🤗 paligemma-img-to-json model that has been pushed on the Hub. |
|
|
|
- **Developed by:** [Arsive](https://huggingface.co/Arsive) |
|
- **Model type:** [More Information Needed] |
|
- **Language(s) (NLP):** [More Information Needed] |
|
- **License:** [More Information Needed] |
|
- **Finetuned from model [optional]:** [google/paligemma-3b-pt-224](https://huggingface.co/google/paligemma-3b-pt-224) |
|
|
|
### Model Sources [optional] |
|
|
|
<!-- Provide the basic links for the model. --> |
|
|
|
- **Repository:** [Respository] (https://huggingface.co/Arsive/paligemma-img-to-json/tree/main) |
|
- **Paper [optional]:** NIL |
|
- **Demo [optional]:** NIL |
|
|
|
## Uses |
|
|
|
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. --> |
|
Can be used to get the json version of an image. The Image must contain a receipt. |
|
|
|
### Direct Use |
|
|
|
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. --> |
|
|
|
[More Information Needed] |
|
|
|
### Downstream Use [optional] |
|
|
|
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app --> |
|
|
|
[More Information Needed] |
|
|
|
### Out-of-Scope Use |
|
|
|
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. --> |
|
|
|
[More Information Needed] |
|
|
|
## Bias, Risks, and Limitations |
|
|
|
<!-- This section is meant to convey both technical and sociotechnical limitations. --> |
|
|
|
[More Information Needed] |
|
|
|
### Recommendations |
|
|
|
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. --> |
|
|
|
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. |
|
|
|
## How to Get Started with the Model |
|
|
|
Use the code below to get started with the model. |
|
|
|
[More Information Needed] |
|
|
|
## Training Details |
|
|
|
### Training Data |
|
|
|
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. --> |
|
|
|
[More Information Needed] |
|
|
|
### Training Procedure |
|
|
|
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. --> |
|
|
|
#### Preprocessing [optional] |
|
|
|
[More Information Needed] |
|
|
|
|
|
#### Training Hyperparameters |
|
|
|
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> |
|
|
|
#### Speeds, Sizes, Times [optional] |
|
|
|
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. --> |
|
|
|
[More Information Needed] |
|
|
|
## Evaluation |
|
|
|
<!-- This section describes the evaluation protocols and provides the results. --> |
|
|
|
### Testing Data, Factors & Metrics |
|
|
|
#### Testing Data |
|
|
|
<!-- This should link to a Dataset Card if possible. --> |
|
|
|
[More Information Needed] |
|
|
|
#### Factors |
|
|
|
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. --> |
|
|
|
[More Information Needed] |
|
|
|
#### Metrics |
|
|
|
<!-- These are the evaluation metrics being used, ideally with a description of why. --> |
|
|
|
[More Information Needed] |
|
|
|
### Results |
|
|
|
[More Information Needed] |
|
|
|
#### Summary |
|
|
|
### Model Architecture and Objective |
|
|
|
[More Information Needed] |
|
|
|
### Compute Infrastructure |
|
|
|
[More Information Needed] |
|
|
|
#### Hardware |
|
|
|
[More Information Needed] |
|
|
|
#### Software |
|
|
|
[More Information Needed] |
|
|
|
## Citation [optional] |
|
|
|
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. --> |
|
|
|
**BibTeX:** |
|
|
|
[More Information Needed] |
|
|
|
**APA:** |
|
|
|
[More Information Needed] |
|
|
|
## Glossary [optional] |
|
|
|
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. --> |
|
|
|
[More Information Needed] |
|
|
|
## Model Card Contact |
|
|
|
[mail](arsive.ai@gmail.com) |
