From 39d5be3f5d49dae3a0d655a23fbb1c1c6e92a365 Mon Sep 17 00:00:00 2001 From: stancld Date: Fri, 7 Aug 2026 09:08:40 +0200 Subject: [PATCH 1/5] docs: Replace pip with uv pip commands --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 02d7969..134a66f 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ You can also work with the zipped datasets when you turn off image caching (chec ### Option 1: Install as a library Install the library with: ```shell -pip install docile-benchmark +uv pip install docile-benchmark ``` To convert pdfs into images, the library uses https://github.com/Belval/pdf2image. On linux you might need to install: @@ -56,8 +56,8 @@ brew install poppler Now you have all dependencies to work with the dataset annotations, pdfs, pre-comptued OCR and to run the evaluation. You can install extra dependencies by running the following (although using one of the provided dockerfiles, as explained below, might be easier in this case): ```shell -pip install "docile-benchmark[interactive]" -pip install "docile-benchmark[ocr]" +uv pip install "docile-benchmark[interactive]" +uv pip install "docile-benchmark[ocr]" ``` The first line installs additional dependencies allowing you to use the interactive dataset browser in [docile/tools/dataset_browser.py](docile/tools/dataset_browser.py) and the [tutorials](tutorials/). The second line let's you rerun the OCR predictions from scratch (e.g., if you'd like to run it with different parameters) but to make it work, you might need additional dependencies on your system. Check https://github.com/mindee/doctr for the installation instructions (for pytorch). From d9f25a35c6a72387ebae5122f28caebdf5b12855 Mon Sep 17 00:00:00 2001 From: stancld Date: Fri, 7 Aug 2026 09:12:18 +0200 Subject: [PATCH 2/5] docs: Make installation section collapsible for quicker skimming --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 134a66f..3f90c21 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,11 @@ You can also work with the zipped datasets when you turn off image caching (chec ## Installation -### Option 1: Install as a library +Choose one of the two options below: install `docile` as a library, or use docker. + +
+Option 1: Install as a library + Install the library with: ```shell uv pip install docile-benchmark @@ -62,7 +66,11 @@ uv pip install "docile-benchmark[ocr]" The first line installs additional dependencies allowing you to use the interactive dataset browser in [docile/tools/dataset_browser.py](docile/tools/dataset_browser.py) and the [tutorials](tutorials/). The second line let's you rerun the OCR predictions from scratch (e.g., if you'd like to run it with different parameters) but to make it work, you might need additional dependencies on your system. Check https://github.com/mindee/doctr for the installation instructions (for pytorch). -### Option 2: Use docker +
+ +
+Option 2: Use docker + There are two Dockerfiles available with the dependencies preinstalled: * `Dockerfile` is a lighter, CPU-only, version with all necessary dependencies to use the dataset with the pre-computed OCR and interactive browser. @@ -83,6 +91,8 @@ docker compose exec jupyter bash ``` After that the `docile` library and its dependencies are already installed in the environment; prefix commands with `uv run ...` (e.g. `uv run jupyter lab`) to run them inside it. +
+ ## Predictions format and running evaluation To evaluate predictions for tasks KILE or LIR on the test set, you have to make a submission to the benchmark on the [Robust Reading Competition](https://rrc.cvc.uab.es/?ch=26) website. To evaluate on the validation set, use the following command: From 86a54fd52e679c4d34ef6874038e47c24f6ca1b6 Mon Sep 17 00:00:00 2001 From: stancld Date: Fri, 7 Aug 2026 09:15:14 +0200 Subject: [PATCH 3/5] docs: Center README badges --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f90c21..2886815 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # DocILE: Document Information Localization and Extraction Benchmark -[![Tests](https://github.com/rossumai/docile/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/rossumai/docile/actions/workflows/tests.yml) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +

+ Tests + License: MIT +

Repository to work with the [DocILE dataset and benchmark](https://docile.rossum.ai/), used in the DocILE'23 CLEF Lab and ICDAR Competition. The competition deadline is on ~~May 10~~ **May 24, 2023** and comes with a **$9000 prize pool**. From 433a8e748c4bfb508e6cc5709826c2229e0f73b7 Mon Sep 17 00:00:00 2001 From: stancld Date: Fri, 7 Aug 2026 09:15:32 +0200 Subject: [PATCH 4/5] docs: Add PyPI version badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2886815..3a98065 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@

Tests + PyPI version License: MIT

From abee36ab0690a9e083acfd6909b9fbbdb823c5d2 Mon Sep 17 00:00:00 2001 From: stancld Date: Fri, 7 Aug 2026 09:15:50 +0200 Subject: [PATCH 5/5] docs: Add supported Python versions badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3a98065..d237cd9 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@

Tests PyPI version + Supported Python versions License: MIT