diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a8973dc02b..fc5760ff38 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -73,4 +73,4 @@ body: - type: markdown attributes: value: > - Thanks for helping us improve the library! \ No newline at end of file + Thanks for helping us improve the library! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 286941eba9..dface9d3c2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -30,4 +30,4 @@ body: - type: markdown attributes: value: > - Thanks for contributing 🎉 \ No newline at end of file + Thanks for contributing 🎉 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a42fca4f18..2880203171 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,6 +8,7 @@ repos: - id: check-toml - id: check-json - id: check-added-large-files + exclude: docs/images/ - id: end-of-file-fixer - id: trailing-whitespace - id: debug-statements diff --git a/README.md b/README.md index 47b9e34b6c..ea5ec082d7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@

- +

[![Slack Icon](https://img.shields.io/badge/Slack-Community-4A154B?style=flat-square&logo=slack&logoColor=white)](https://slack.mindee.com) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) ![Build Status](https://github.com/mindee/doctr/workflows/builds/badge.svg) [![codecov](https://codecov.io/gh/mindee/doctr/branch/main/graph/badge.svg?token=577MO567NM)](https://codecov.io/gh/mindee/doctr) [![CodeFactor](https://www.codefactor.io/repository/github/mindee/doctr/badge?s=bae07db86bb079ce9d6542315b8c6e70fa708a7e)](https://www.codefactor.io/repository/github/mindee/doctr) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/340a76749b634586a498e1c0ab998f08)](https://app.codacy.com/gh/mindee/doctr?utm_source=github.com&utm_medium=referral&utm_content=mindee/doctr&utm_campaign=Badge_Grade) [![Doc Status](https://github.com/mindee/doctr/workflows/doc-status/badge.svg)](https://mindee.github.io/doctr) [![Pypi](https://img.shields.io/badge/pypi-v0.7.0-blue.svg)](https://pypi.org/project/python-doctr/) [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/mindee/doctr) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/mindee/notebooks/blob/main/doctr/quicktour.ipynb) + **Optical Character Recognition made seamless & accessible to anyone, powered by TensorFlow 2 & PyTorch** What you can expect from this repository: @@ -11,7 +12,7 @@ What you can expect from this repository: - efficient ways to parse textual information (localize and identify each word) from your documents - guidance on how to integrate this in your current architecture -![OCR_example](https://github.com/mindee/doctr/releases/download/v0.2.0/ocr.png?raw=True) +![OCR_example](docs/images/ocr.png) ## Quick Tour @@ -77,7 +78,7 @@ To interpret your model's predictions, you can visualize them interactively as f result.show(doc) ``` -![Visualization sample](https://github.com/mindee/doctr/releases/download/v0.1.1/doctr_example_script.gif?raw=True) +![Visualization sample](docs/images/doctr_example_script.gif) Or even rebuild the original document from its predictions: @@ -88,7 +89,7 @@ synthetic_pages = result.synthesize() plt.imshow(synthetic_pages[0]); plt.axis('off'); plt.show() ``` -![Synthesis sample](https://github.com/mindee/doctr/releases/download/v0.3.1/synthesized_sample.png?raw=True) +![Synthesis sample](docs/images/synthesized_sample.png) The `ocr_predictor` returns a `Document` object with a nested structure (with `Page`, `Block`, `Line`, `Word`, `Artefact`). To get a better understanding of our document model, check our [documentation](https://mindee.github.io/doctr/modules/io.html#document-structure): @@ -127,7 +128,7 @@ The KIE predictor results per page are in a dictionary format with each key repr ### If you are looking for support from the Mindee team -[![Bad OCR test detection image asking the developer if they need help](https://github.com/mindee/doctr/releases/download/v0.5.1/doctr-need-help.png?raw=True)](https://mindee.com/product/doctr) +[![Bad OCR test detection image asking the developer if they need help](docs/images/doctr-need-help.png)](https://mindee.com/product/doctr) ## Installation @@ -215,7 +216,7 @@ The full package documentation is available [here](https://mindee.github.io/doct A minimal demo app is provided for you to play with our end-to-end OCR models! -![Demo app](https://github.com/mindee/doctr/releases/download/v0.3.0/demo_update.png?raw=True) +![Demo app](docs/images/demo_update.png) #### Live demo @@ -255,7 +256,7 @@ USE_TORCH=1 streamlit run demo/app.py Instead of having your demo actually running Python, you would prefer to run everything in your web browser? Check out our [TensorFlow.js demo](https://github.com/mindee/doctr-tfjs-demo) to get started! -![TFJS demo](https://github.com/mindee/doctr-tfjs-demo/releases/download/v0.1-models/demo_illustration_mini.png?raw=True) +![TFJS demo](docs/images/demo_illustration_mini.png) ### Docker container diff --git a/docs/images/Logo_doctr.gif b/docs/images/Logo_doctr.gif new file mode 100644 index 0000000000..9c7d991c16 Binary files /dev/null and b/docs/images/Logo_doctr.gif differ diff --git a/docs/images/demo_illustration_mini.png b/docs/images/demo_illustration_mini.png new file mode 100644 index 0000000000..1b3761b6db Binary files /dev/null and b/docs/images/demo_illustration_mini.png differ diff --git a/docs/images/demo_update.png b/docs/images/demo_update.png new file mode 100644 index 0000000000..9095e3727a Binary files /dev/null and b/docs/images/demo_update.png differ diff --git a/docs/images/doctr-need-help.png b/docs/images/doctr-need-help.png new file mode 100644 index 0000000000..ee6c185a0d Binary files /dev/null and b/docs/images/doctr-need-help.png differ diff --git a/docs/images/doctr_demo_app.png b/docs/images/doctr_demo_app.png new file mode 100644 index 0000000000..3d0452a92e Binary files /dev/null and b/docs/images/doctr_demo_app.png differ diff --git a/docs/images/doctr_example_script.gif b/docs/images/doctr_example_script.gif new file mode 100644 index 0000000000..6b20dcf1ff Binary files /dev/null and b/docs/images/doctr_example_script.gif differ diff --git a/docs/images/ocr.png b/docs/images/ocr.png new file mode 100644 index 0000000000..4503e49862 Binary files /dev/null and b/docs/images/ocr.png differ diff --git a/docs/images/synthesized_sample.png b/docs/images/synthesized_sample.png new file mode 100644 index 0000000000..30d86cd08c Binary files /dev/null and b/docs/images/synthesized_sample.png differ diff --git a/notebooks/README.rst b/notebooks/README.rst index e8971fceee..96f9e80edb 100644 --- a/notebooks/README.rst +++ b/notebooks/README.rst @@ -14,4 +14,4 @@ Here are some notebooks compiled for users to better leverage the library capabi +--------------------------------------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | `[Artefact detection] `_ | Object detection for artefacts in documents | .. image:: https://colab.research.google.com/assets/colab-badge.svg | | | | :target: https://colab.research.google.com/github/mindee/notebooks/blob/main/doctr/artefact_detection.ipynb | -+--------------------------------------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file ++--------------------------------------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------+