python-doctr 0.12.0__tar.gz → 1.0.0__tar.gz

{python_doctr-0.12.0/python_doctr.egg-info → python_doctr-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-doctr
-Version: 0.12.0
+Version: 1.0.0
 Summary: Document Text Recognition (docTR): deep Learning for high-performance OCR on documents.
 Author-email: Mindee <contact@mindee.com>
 Maintainer: François-Guillaume Fernandez, Charles Gaillard, Olivier Dulcy, Felix Dittrich
@@ -210,7 +210,7 @@ Project-URL: documentation, https://mindee.github.io/doctr
 Project-URL: repository, https://github.com/mindee/doctr
 Project-URL: tracker, https://github.com/mindee/doctr/issues
 Project-URL: changelog, https://mindee.github.io/doctr/changelog.html
-Keywords: OCR,deep learning,computer vision,tensorflow,pytorch,text detection,text recognition
+Keywords: OCR,deep learning,computer vision,pytorch,text detection,text recognition
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
@@ -226,6 +226,9 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: <4,>=3.10.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: torch<3.0.0,>=2.0.0
+Requires-Dist: torchvision>=0.15.0
+Requires-Dist: onnx<3.0.0,>=1.12.0
 Requires-Dist: numpy<3.0.0,>=1.16.0
 Requires-Dist: scipy<2.0.0,>=1.4.0
 Requires-Dist: h5py<4.0.0,>=3.1.0
@@ -241,15 +244,6 @@ Requires-Dist: defusedxml>=0.7.0
 Requires-Dist: anyascii>=0.3.2
 Requires-Dist: validators>=0.18.0
 Requires-Dist: tqdm>=4.30.0
-Provides-Extra: tf
-Requires-Dist: tensorflow[and-cuda]<3.0.0,>=2.15.0; sys_platform == "linux" and extra == "tf"
-Requires-Dist: tensorflow<3.0.0,>=2.15.0; sys_platform != "linux" and extra == "tf"
-Requires-Dist: tf-keras<3.0.0,>=2.15.0; extra == "tf"
-Requires-Dist: tf2onnx<2.0.0,>=1.16.0; extra == "tf"
-Provides-Extra: torch
-Requires-Dist: torch<3.0.0,>=2.0.0; extra == "torch"
-Requires-Dist: torchvision>=0.15.0; extra == "torch"
-Requires-Dist: onnx<3.0.0,>=1.12.0; extra == "torch"
 Provides-Extra: html
 Requires-Dist: weasyprint>=55.0; extra == "html"
 Provides-Extra: viz
@@ -277,10 +271,6 @@ Requires-Dist: sphinx-markdown-tables>=0.0.15; extra == "docs"
 Requires-Dist: sphinx-tabs>=3.3.0; extra == "docs"
 Requires-Dist: furo>=2022.3.4; extra == "docs"
 Provides-Extra: dev
-Requires-Dist: tensorflow[and-cuda]<3.0.0,>=2.15.0; sys_platform == "linux" and extra == "dev"
-Requires-Dist: tensorflow<3.0.0,>=2.15.0; sys_platform != "linux" and extra == "dev"
-Requires-Dist: tf-keras<3.0.0,>=2.15.0; extra == "dev"
-Requires-Dist: tf2onnx<2.0.0,>=1.16.0; extra == "dev"
 Requires-Dist: torch<3.0.0,>=2.0.0; extra == "dev"
 Requires-Dist: torchvision>=0.15.0; extra == "dev"
 Requires-Dist: onnx<3.0.0,>=1.12.0; extra == "dev"
@@ -309,10 +299,10 @@ Dynamic: license-file
   <img src="https://github.com/mindee/doctr/raw/main/docs/images/Logo_doctr.gif" width="40%">
 </p>
 
-[![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) [![Docker Images](https://img.shields.io/badge/Docker-4287f5?style=flat&logo=docker&logoColor=white)](https://github.com/mindee/doctr/pkgs/container/doctr) [![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.12.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) [![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20docTR%20Guru-006BFF)](https://gurubase.io/g/doctr)
+[![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) [![Docker Images](https://img.shields.io/badge/Docker-4287f5?style=flat&logo=docker&logoColor=white)](https://github.com/mindee/doctr/pkgs/container/doctr) [![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-v1.0.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) [![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20docTR%20Guru-006BFF)](https://gurubase.io/g/doctr)
 
 
-**Optical Character Recognition made seamless & accessible to anyone, powered by TensorFlow 2 & PyTorch**
+**Optical Character Recognition made seamless & accessible to anyone, powered by PyTorch**
 
 What you can expect from this repository:
 
@@ -440,19 +430,6 @@ The KIE predictor results per page are in a dictionary format with each key repr
 
 ## Installation
 
-> [!WARNING]
-> **TensorFlow Backend Deprecation Notice**
->
-> Using docTR with TensorFlow as a backend is deprecated and will be removed in the next major release (v1.0.0).
-> We **recommend switching to the PyTorch backend**, which is more actively maintained and supports the latest features and models.
-> Alternatively, you can use [OnnxTR](https://github.com/felixdittrich92/OnnxTR), which does **not** require TensorFlow or PyTorch.
->
-> This decision was made based on several considerations:
->
-> - Allows better focus on improving the core library
-> - Frees up resources to develop new features faster
-> - Enables more targeted optimizations with PyTorch
-
 ### Prerequisites
 
 Python 3.10 (or higher) and [pip](https://pip.pypa.io/en/stable/) are required to install docTR.
@@ -465,24 +442,15 @@ You can then install the latest release of the package using [pypi](https://pypi
 pip install python-doctr
 ```
 
-> :warning: Please note that the basic installation is not standalone, as it does not provide a deep learning framework, which is required for the package to run.
-
-We try to keep framework-specific dependencies to a minimum. You can install framework-specific builds as follows:
+We try to keep extra dependencies to a minimum. You can install specific builds as follows:
 
 ```shell
-# for TensorFlow
-pip install "python-doctr[tf]"
-# for PyTorch
-pip install "python-doctr[torch]"
+# standard build
+pip install python-doctr
 # optional dependencies for visualization, html, and contrib modules can be installed as follows:
-pip install "python-doctr[torch,viz,html,contib]"
+pip install "python-doctr[viz,html,contrib]"
 ```
 
-For MacBooks with M1 chip, you will need some additional packages or specific versions:
-
-- TensorFlow 2: [metal plugin](https://developer.apple.com/metal/tensorflow-plugin/)
-- PyTorch: [version >= 2.0.0](https://pytorch.org/get-started/locally/#start-locally)
-
 ### Developer mode
 
 Alternatively, you can install it from source, which will require you to install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
@@ -493,13 +461,10 @@ git clone https://github.com/mindee/doctr.git
 pip install -e doctr/.
 ```
 
-Again, if you prefer to avoid the risk of missing dependencies, you can install the TensorFlow or the PyTorch build:
+Again, if you prefer to avoid the risk of missing dependencies, you can install the build:
 
 ```shell
-# for TensorFlow
-pip install -e doctr/.[tf]
-# for PyTorch
-pip install -e doctr/.[torch]
+pip install -e doctr/.
 ```
 
 ## Models architectures
@@ -542,20 +507,6 @@ Check it out [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%2
 
 If you prefer to use it locally, there is an extra dependency ([Streamlit](https://streamlit.io/)) that is required.
 
-##### Tensorflow version
-
-```shell
-pip install -r demo/tf-requirements.txt
-```
-
-Then run your app in your default browser with:
-
-```shell
-USE_TF=1 streamlit run demo/app.py
-```
-
-##### PyTorch version
-
 ```shell
 pip install -r demo/pt-requirements.txt
 ```
@@ -563,23 +514,16 @@ pip install -r demo/pt-requirements.txt
 Then run your app in your default browser with:
 
 ```shell
-USE_TORCH=1 streamlit run demo/app.py
+streamlit run demo/app.py
 ```
 
-#### TensorFlow.js
-
-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/raw/main/docs/images/demo_illustration_mini.png)
-
 ### Docker container
 
 We offer Docker container support for easy testing and deployment. [Here are the available docker tags.](https://github.com/mindee/doctr/pkgs/container/doctr).
 
 #### Using GPU with docTR Docker Images
 
-The docTR Docker images are GPU-ready and based on CUDA `12.2`. Make sure your host is **at least `12.2`**, otherwise Torch or TensorFlow won't be able to initialize the GPU.
+The docTR Docker images are GPU-ready and based on CUDA `12.2`. Make sure your host is **at least `12.2`**, otherwise Torch won't be able to initialize the GPU.
 Please ensure that Docker is configured to use your GPU.
 
 To verify and configure GPU support for Docker, please follow the instructions provided in the [NVIDIA Container Toolkit Installation Guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html).
@@ -594,7 +538,7 @@ docker run -it --gpus all ghcr.io/mindee/doctr:torch-py3.9.18-2024-10 bash
 
 The Docker images for docTR follow a specific tag nomenclature: `<deps>-py<python_version>-<doctr_version|YYYY-MM>`. Here's a breakdown of the tag structure:
 
-- `<deps>`: `tf`, `torch`, `tf-viz-html-contrib` or `torch-viz-html-contrib`.
+- `<deps>`: `torch`, `torch-viz-html-contrib`.
 - `<python_version>`: `3.9.18`, `3.10.13` or `3.11.8`.
 - `<doctr_version>`: a tag >= `v0.11.0`
 - `<YYYY-MM>`: e.g. `2014-10`
@@ -603,7 +547,6 @@ Here are examples of different image tags:
 
 | Tag                        | Description                                       |
 |----------------------------|---------------------------------------------------|
-| `tf-py3.10.13-v0.11.0`       | TensorFlow version `3.10.13` with docTR `v0.11.0`. |
 | `torch-viz-html-contrib-py3.11.8-2024-10`       | Torch with extra dependencies version `3.11.8` from latest commit on `main` in `2024-10`. |
 | `torch-py3.11.8-2024-10`| PyTorch version `3.11.8` from latest commit on `main` in `2024-10`. |
 
@@ -615,10 +558,10 @@ You can also build docTR Docker images locally on your computer.
 docker build -t doctr .
 ```
 
-You can specify custom Python versions and docTR versions using build arguments. For example, to build a docTR image with TensorFlow, Python version `3.9.10`, and docTR version `v0.7.0`, run the following command:
+You can specify custom Python versions and docTR versions using build arguments. For example, to build a docTR image with PyTorch, Python version `3.9.10`, and docTR version `v0.7.0`, run the following command:
 
 ```shell
-docker build -t doctr --build-arg FRAMEWORK=tf --build-arg PYTHON_VERSION=3.9.10 --build-arg DOCTR_VERSION=v0.7.0 .
+docker build -t doctr --build-arg FRAMEWORK=torch --build-arg PYTHON_VERSION=3.9.10 --build-arg DOCTR_VERSION=v0.7.0 .
 ```
 
 ### Example script

{python_doctr-0.12.0 → python_doctr-1.0.0}/README.md

@@ -2,10 +2,10 @@
   <img src="https://github.com/mindee/doctr/raw/main/docs/images/Logo_doctr.gif" width="40%">
 </p>
 
-[![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) [![Docker Images](https://img.shields.io/badge/Docker-4287f5?style=flat&logo=docker&logoColor=white)](https://github.com/mindee/doctr/pkgs/container/doctr) [![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.12.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) [![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20docTR%20Guru-006BFF)](https://gurubase.io/g/doctr)
+[![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) [![Docker Images](https://img.shields.io/badge/Docker-4287f5?style=flat&logo=docker&logoColor=white)](https://github.com/mindee/doctr/pkgs/container/doctr) [![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-v1.0.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) [![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20docTR%20Guru-006BFF)](https://gurubase.io/g/doctr)
 
 
-**Optical Character Recognition made seamless & accessible to anyone, powered by TensorFlow 2 & PyTorch**
+**Optical Character Recognition made seamless & accessible to anyone, powered by PyTorch**
 
 What you can expect from this repository:
 
@@ -133,19 +133,6 @@ The KIE predictor results per page are in a dictionary format with each key repr
 
 ## Installation
 
-> [!WARNING]
-> **TensorFlow Backend Deprecation Notice**
->
-> Using docTR with TensorFlow as a backend is deprecated and will be removed in the next major release (v1.0.0).
-> We **recommend switching to the PyTorch backend**, which is more actively maintained and supports the latest features and models.
-> Alternatively, you can use [OnnxTR](https://github.com/felixdittrich92/OnnxTR), which does **not** require TensorFlow or PyTorch.
->
-> This decision was made based on several considerations:
->
-> - Allows better focus on improving the core library
-> - Frees up resources to develop new features faster
-> - Enables more targeted optimizations with PyTorch
-
 ### Prerequisites
 
 Python 3.10 (or higher) and [pip](https://pip.pypa.io/en/stable/) are required to install docTR.
@@ -158,24 +145,15 @@ You can then install the latest release of the package using [pypi](https://pypi
 pip install python-doctr
 ```
 
-> :warning: Please note that the basic installation is not standalone, as it does not provide a deep learning framework, which is required for the package to run.
-
-We try to keep framework-specific dependencies to a minimum. You can install framework-specific builds as follows:
+We try to keep extra dependencies to a minimum. You can install specific builds as follows:
 
 ```shell
-# for TensorFlow
-pip install "python-doctr[tf]"
-# for PyTorch
-pip install "python-doctr[torch]"
+# standard build
+pip install python-doctr
 # optional dependencies for visualization, html, and contrib modules can be installed as follows:
-pip install "python-doctr[torch,viz,html,contib]"
+pip install "python-doctr[viz,html,contrib]"
 ```
 
-For MacBooks with M1 chip, you will need some additional packages or specific versions:
-
-- TensorFlow 2: [metal plugin](https://developer.apple.com/metal/tensorflow-plugin/)
-- PyTorch: [version >= 2.0.0](https://pytorch.org/get-started/locally/#start-locally)
-
 ### Developer mode
 
 Alternatively, you can install it from source, which will require you to install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
@@ -186,13 +164,10 @@ git clone https://github.com/mindee/doctr.git
 pip install -e doctr/.
 ```
 
-Again, if you prefer to avoid the risk of missing dependencies, you can install the TensorFlow or the PyTorch build:
+Again, if you prefer to avoid the risk of missing dependencies, you can install the build:
 
 ```shell
-# for TensorFlow
-pip install -e doctr/.[tf]
-# for PyTorch
-pip install -e doctr/.[torch]
+pip install -e doctr/.
 ```
 
 ## Models architectures
@@ -235,20 +210,6 @@ Check it out [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%2
 
 If you prefer to use it locally, there is an extra dependency ([Streamlit](https://streamlit.io/)) that is required.
 
-##### Tensorflow version
-
-```shell
-pip install -r demo/tf-requirements.txt
-```
-
-Then run your app in your default browser with:
-
-```shell
-USE_TF=1 streamlit run demo/app.py
-```
-
-##### PyTorch version
-
 ```shell
 pip install -r demo/pt-requirements.txt
 ```
@@ -256,23 +217,16 @@ pip install -r demo/pt-requirements.txt
 Then run your app in your default browser with:
 
 ```shell
-USE_TORCH=1 streamlit run demo/app.py
+streamlit run demo/app.py
 ```
 
-#### TensorFlow.js
-
-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/raw/main/docs/images/demo_illustration_mini.png)
-
 ### Docker container
 
 We offer Docker container support for easy testing and deployment. [Here are the available docker tags.](https://github.com/mindee/doctr/pkgs/container/doctr).
 
 #### Using GPU with docTR Docker Images
 
-The docTR Docker images are GPU-ready and based on CUDA `12.2`. Make sure your host is **at least `12.2`**, otherwise Torch or TensorFlow won't be able to initialize the GPU.
+The docTR Docker images are GPU-ready and based on CUDA `12.2`. Make sure your host is **at least `12.2`**, otherwise Torch won't be able to initialize the GPU.
 Please ensure that Docker is configured to use your GPU.
 
 To verify and configure GPU support for Docker, please follow the instructions provided in the [NVIDIA Container Toolkit Installation Guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html).
@@ -287,7 +241,7 @@ docker run -it --gpus all ghcr.io/mindee/doctr:torch-py3.9.18-2024-10 bash
 
 The Docker images for docTR follow a specific tag nomenclature: `<deps>-py<python_version>-<doctr_version|YYYY-MM>`. Here's a breakdown of the tag structure:
 
-- `<deps>`: `tf`, `torch`, `tf-viz-html-contrib` or `torch-viz-html-contrib`.
+- `<deps>`: `torch`, `torch-viz-html-contrib`.
 - `<python_version>`: `3.9.18`, `3.10.13` or `3.11.8`.
 - `<doctr_version>`: a tag >= `v0.11.0`
 - `<YYYY-MM>`: e.g. `2014-10`
@@ -296,7 +250,6 @@ Here are examples of different image tags:
 
 | Tag                        | Description                                       |
 |----------------------------|---------------------------------------------------|
-| `tf-py3.10.13-v0.11.0`       | TensorFlow version `3.10.13` with docTR `v0.11.0`. |
 | `torch-viz-html-contrib-py3.11.8-2024-10`       | Torch with extra dependencies version `3.11.8` from latest commit on `main` in `2024-10`. |
 | `torch-py3.11.8-2024-10`| PyTorch version `3.11.8` from latest commit on `main` in `2024-10`. |
 
@@ -308,10 +261,10 @@ You can also build docTR Docker images locally on your computer.
 docker build -t doctr .
 ```
 
-You can specify custom Python versions and docTR versions using build arguments. For example, to build a docTR image with TensorFlow, Python version `3.9.10`, and docTR version `v0.7.0`, run the following command:
+You can specify custom Python versions and docTR versions using build arguments. For example, to build a docTR image with PyTorch, Python version `3.9.10`, and docTR version `v0.7.0`, run the following command:
 
 ```shell
-docker build -t doctr --build-arg FRAMEWORK=tf --build-arg PYTHON_VERSION=3.9.10 --build-arg DOCTR_VERSION=v0.7.0 .
+docker build -t doctr --build-arg FRAMEWORK=torch --build-arg PYTHON_VERSION=3.9.10 --build-arg DOCTR_VERSION=v0.7.0 .
 ```
 
 ### Example script

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/__init__.py

@@ -1,3 +1,2 @@
 from . import io, models, datasets, contrib, transforms, utils
-from .file_utils import is_tf_available, is_torch_available
 from .version import __version__  # noqa: F401

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/datasets/__init__.py

@@ -1,5 +1,3 @@
-from doctr.file_utils import is_tf_available
-
 from .generator import *
 from .coco_text import *
 from .cord import *
@@ -22,6 +20,3 @@ from .synthtext import *
 from .utils import *
 from .vocabs import *
 from .wildreceipt import *
-
-if is_tf_available():
-    from .loader import *

python_doctr-1.0.0/doctr/datasets/datasets/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/datasets/datasets/pytorch.py

@@ -50,9 +50,9 @@ class AbstractDataset(_AbstractDataset):
     @staticmethod
     def collate_fn(samples: list[tuple[torch.Tensor, Any]]) -> tuple[torch.Tensor, list[Any]]:
         images, targets = zip(*samples)
-        images = torch.stack(images, dim=0)
+        images = torch.stack(images, dim=0)  # type: ignore[assignment]
 
-        return images, list(targets)
+        return images, list(targets)  # type: ignore[return-value]
 
 
 class VisionDataset(AbstractDataset, _VisionDataset):  # noqa: D101

python_doctr-1.0.0/doctr/datasets/generator/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/datasets/vocabs.py

@@ -264,8 +264,6 @@ VOCABS["estonian"] = VOCABS["english"] + "šžõäöüŠŽÕÄÖÜ"
 VOCABS["esperanto"] = re.sub(r"[QqWwXxYy]", "", VOCABS["english"]) + "ĉĝĥĵŝŭĈĜĤĴŜŬ" + "₷"
 
 VOCABS["french"] = VOCABS["english"] + "àâéèêëîïôùûüçÀÂÉÈÊËÎÏÔÙÛÜÇ"
-# NOTE: legacy french is outdated, but kept for compatibility
-VOCABS["legacy_french"] = VOCABS["latin"] + "°" + "àâéèêëîïôùûçÀÂÉÈËÎÏÔÙÛÇ" + _BASE_VOCABS["currency"]
 
 VOCABS["finnish"] = VOCABS["english"] + "äöÄÖ"
 

python_doctr-1.0.0/doctr/file_utils.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2021-2025, Mindee.
+
+# This program is licensed under the Apache License 2.0.
+# See LICENSE or go to <https://opensource.org/licenses/Apache-2.0> for full license details.
+
+import importlib.metadata
+import logging
+
+__all__ = ["requires_package", "CLASS_NAME"]
+
+CLASS_NAME: str = "words"
+ENV_VARS_TRUE_VALUES = {"1", "ON", "YES", "TRUE"}
+
+
+def requires_package(name: str, extra_message: str | None = None) -> None:  # pragma: no cover
+    """
+    package requirement helper
+
+    Args:
+        name: name of the package
+        extra_message: additional message to display if the package is not found
+    """
+    try:
+        _pkg_version = importlib.metadata.version(name)
+        logging.info(f"{name} version {_pkg_version} available.")
+    except importlib.metadata.PackageNotFoundError:
+        raise ImportError(
+            f"\n\n{extra_message if extra_message is not None else ''} "
+            f"\nPlease install it with the following command: pip install {name}\n"
+        )

python_doctr-1.0.0/doctr/io/image/__init__.py

@@ -0,0 +1,2 @@
+from .base import *
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/io/image/pytorch.py

@@ -95,4 +95,4 @@ def tensor_from_numpy(npy_img: np.ndarray, dtype: torch.dtype = torch.float32) -
 
 def get_img_shape(img: torch.Tensor) -> tuple[int, int]:
     """Get the shape of an image"""
-    return img.shape[-2:]
+    return img.shape[-2:]  # type: ignore[return-value]

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/_utils.py

@@ -63,7 +63,7 @@ def estimate_orientation(
         thresh = img.astype(np.uint8)
 
     page_orientation, orientation_confidence = general_page_orientation or (None, 0.0)
-    if page_orientation and orientation_confidence >= min_confidence:
+    if page_orientation is not None and orientation_confidence >= min_confidence:
         # We rotate the image to the general orientation which improves the detection
         # No expand needed bitmap is already padded
         thresh = rotate_image(thresh, -page_orientation)
@@ -100,7 +100,7 @@ def estimate_orientation(
         estimated_angle = -round(median) if abs(median) != 0 else 0
 
     # combine with the general orientation and the estimated angle
-    if page_orientation and orientation_confidence >= min_confidence:
+    if page_orientation is not None and orientation_confidence >= min_confidence:
         # special case where the estimated angle is mostly wrong:
         # case 1: - and + swapped
         # case 2: estimated angle is completely wrong
@@ -184,7 +184,7 @@ def invert_data_structure(
         dictionary of list when x is a list of dictionaries or a list of dictionaries when x is dictionary of lists
     """
     if isinstance(x, dict):
-        assert len({len(v) for v in x.values()}) == 1, "All the lists in the dictionnary should have the same length."
+        assert len({len(v) for v in x.values()}) == 1, "All the lists in the dictionary should have the same length."
         return [dict(zip(x, t)) for t in zip(*x.values())]
     elif isinstance(x, list):
         return {k: [dic[k] for dic in x] for k in x[0]}

python_doctr-1.0.0/doctr/models/classification/magc_resnet/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/magc_resnet/pytorch.py

@@ -14,7 +14,7 @@ from torch import nn
 
 from doctr.datasets import VOCABS
 
-from ..resnet.pytorch import ResNet
+from ..resnet import ResNet
 
 __all__ = ["magc_resnet31"]
 
@@ -72,7 +72,7 @@ class MAGC(nn.Module):
     def forward(self, inputs: torch.Tensor) -> torch.Tensor:
         batch, _, height, width = inputs.size()
         # (N * headers, C / headers, H , W)
-        x = inputs.view(batch * self.headers, self.single_header_inplanes, height, width)
+        x = inputs.contiguous().view(batch * self.headers, self.single_header_inplanes, height, width)
         shortcut = x
         # (N * headers, C / headers, H * W)
         shortcut = shortcut.view(batch * self.headers, self.single_header_inplanes, height * width)

python_doctr-1.0.0/doctr/models/classification/mobilenet/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

python_doctr-1.0.0/doctr/models/classification/predictor/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/predictor/pytorch.py

@@ -35,7 +35,7 @@ class OrientationPredictor(nn.Module):
     @torch.inference_mode()
     def forward(
         self,
-        inputs: list[np.ndarray | torch.Tensor],
+        inputs: list[np.ndarray],
     ) -> list[list[int] | list[float]]:
         # Dimension check
         if any(input.ndim != 3 for input in inputs):

python_doctr-1.0.0/doctr/models/classification/resnet/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

python_doctr-1.0.0/doctr/models/classification/textnet/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/textnet/pytorch.py

@@ -11,7 +11,7 @@ from torch import nn
 
 from doctr.datasets import VOCABS
 
-from ...modules.layers.pytorch import FASTConvLayer
+from ...modules.layers import FASTConvLayer
 from ...utils import conv_sequence_pt, load_pretrained_params
 
 __all__ = ["textnet_tiny", "textnet_small", "textnet_base"]

python_doctr-1.0.0/doctr/models/classification/vgg/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

python_doctr-1.0.0/doctr/models/classification/vip/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

python_doctr-1.0.0/doctr/models/classification/vip/layers/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/vip/layers/pytorch.py

@@ -433,7 +433,7 @@ class LePEAttention(nn.Module):
         Returns:
             A float tensor of shape (b, h, w, c).
         """
-        b_merged = int(img_splits_hw.shape[0] / (h * w / h_sp / w_sp))
+        b_merged = img_splits_hw.shape[0] // ((h * w) // (h_sp * w_sp))
         img = img_splits_hw.view(b_merged, h // h_sp, w // w_sp, h_sp, w_sp, -1)
         # contiguous() required to ensure the tensor has a contiguous memory layout
         # after permute, allowing the subsequent view operation to work correctly.

python_doctr-1.0.0/doctr/models/classification/vit/__init__.py

@@ -0,0 +1 @@
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/vit/pytorch.py

@@ -11,9 +11,9 @@ from torch import nn
 
 from doctr.datasets import VOCABS
 from doctr.models.modules.transformer import EncoderBlock
-from doctr.models.modules.vision_transformer.pytorch import PatchEmbedding
+from doctr.models.modules.vision_transformer import PatchEmbedding
 
-from ...utils.pytorch import load_pretrained_params
+from ...utils import load_pretrained_params
 
 __all__ = ["vit_s", "vit_b"]
 

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/classification/zoo.py

@@ -5,7 +5,7 @@
 
 from typing import Any
 
-from doctr.file_utils import is_tf_available, is_torch_available
+from doctr.models.utils import _CompiledModule
 
 from .. import classification
 from ..preprocessor import PreProcessor
@@ -30,11 +30,10 @@ ARCHS: list[str] = [
     "vgg16_bn_r",
     "vit_s",
     "vit_b",
+    "vip_tiny",
+    "vip_base",
 ]
 
-if is_torch_available():
-    ARCHS.extend(["vip_tiny", "vip_base"])
-
 ORIENTATION_ARCHS: list[str] = ["mobilenet_v3_small_crop_orientation", "mobilenet_v3_small_page_orientation"]
 
 
@@ -52,12 +51,8 @@ def _orientation_predictor(
         # Load directly classifier from backbone
         _model = classification.__dict__[arch](pretrained=pretrained)
     else:
-        allowed_archs = [classification.MobileNetV3]
-        if is_torch_available():
-            # Adding the type for torch compiled models to the allowed architectures
-            from doctr.models.utils import _CompiledModule
-
-            allowed_archs.append(_CompiledModule)
+        # Adding the type for torch compiled models to the allowed architectures
+        allowed_archs = [classification.MobileNetV3, _CompiledModule]
 
         if not isinstance(arch, tuple(allowed_archs)):
             raise ValueError(f"unknown architecture: {type(arch)}")
@@ -66,7 +61,7 @@ def _orientation_predictor(
     kwargs["mean"] = kwargs.get("mean", _model.cfg["mean"])
     kwargs["std"] = kwargs.get("std", _model.cfg["std"])
     kwargs["batch_size"] = kwargs.get("batch_size", 128 if model_type == "crop" else 4)
-    input_shape = _model.cfg["input_shape"][:-1] if is_tf_available() else _model.cfg["input_shape"][1:]
+    input_shape = _model.cfg["input_shape"][1:]
     predictor = OrientationPredictor(
         PreProcessor(input_shape, preserve_aspect_ratio=True, symmetric_pad=True, **kwargs), _model
     )

python_doctr-1.0.0/doctr/models/detection/_utils/__init__.py

@@ -0,0 +1,2 @@
+from .base import *
+from .pytorch import *

{python_doctr-0.12.0 → python_doctr-1.0.0}/doctr/models/detection/core.py

@@ -53,7 +53,7 @@ class DetectionPostProcessor(NestedObject):
 
         else:
             mask: np.ndarray = np.zeros((h, w), np.int32)
-            cv2.fillPoly(mask, [points.astype(np.int32)], 1.0)  # type: ignore[call-overload]
+            cv2.fillPoly(mask, [points.astype(np.int32)], 1.0)
             product = pred * mask
             return np.sum(product) / np.count_nonzero(product)