Skip to content

Commit

Permalink
Fix: some typos and add a first minor benchmark
Browse files Browse the repository at this point in the history
  • Loading branch information
felixdittrich92 committed May 10, 2024
1 parent 4793547 commit 3a55ecc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ Python 3.9 (or higher) and [pip](https://pip.pypa.io/en/stable/) are required to

You can then install the latest release of the package using [pypi](https://pypi.org/project/OnnxTR/) as follows:

**NOTE:**
**NOTE:**

For GPU support please take a look at: [ONNX Runtime](https://onnxruntime.ai/getting-started). Currently supported execution providers by default are: CPU, CUDA

- **Prerequisites:** CUDA & cuDNN needs to be installed before [Version table](https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html).

```shell
Expand Down Expand Up @@ -74,7 +75,7 @@ from onnxtr.models import ocr_predictor

model = ocr_predictor(
det_arch='fast_base', # detection architecture
rec_arch='vitstr_base', # recognition architecture
reco_arch='vitstr_base', # recognition architecture
det_bs=4, # detection batch size
reco_bs=1024, # recognition batch size
assume_straight_pages=True, # set to `False` if the pages are not straight (rotation, perspective, etc.) (default: True)
Expand Down Expand Up @@ -132,7 +133,7 @@ from onnxtr.models import ocr_predictor, linknet_resnet18, parseq

reco_model = parseq("path_to_custom_model.onnx", vocab="ABC")
det_model = linknet_resnet18("path_to_custom_model.onnx")
model = ocr_predictor(det_model=det_model, reco_model=reco_model)
model = ocr_predictor(det_arch=det_model, reco_arch=reco_model)
```

## Models architectures
Expand Down Expand Up @@ -205,7 +206,6 @@ MORE BENCHMARKS COMING SOON
|FUNSD (199 pages) | ~1.29s / Page | ~0.57s / Page |
|CORD (900 pages) | ~0.60s / Page | ~0.25s / Page |


## Citation

If you wish to cite please refer to the base project citation, feel free to use this [BibTeX](http://www.bibtex.org/) reference:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from setuptools import setup

PKG_NAME = "onnxtr"
VERSION = os.getenv("BUILD_VERSION", "0.1.1a0")
VERSION = os.getenv("BUILD_VERSION", "0.1.2a0")


if __name__ == "__main__":
Expand Down

0 comments on commit 3a55ecc

Please sign in to comment.