From 104235fef9655034be54b8da6c9bccb8792439fc Mon Sep 17 00:00:00 2001
From: Clemens Neudecker <952378+cneud@users.noreply.github.com>
Date: Wed, 10 Apr 2024 16:30:47 +0200
Subject: [PATCH] Update README.md
---
README.md | 23 ++++++++++-------------
1 file changed, 10 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 157f02b..2c3f25c 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,17 @@
# sbb_binarization
-> Document Image Binarization using pre-trained models
+> Document Image Binarization
[![pip release](https://img.shields.io/pypi/v/sbb-binarization.svg)](https://pypi.org/project/sbb-binarization/)
-[![CircleCI test](https://circleci.com/gh/qurator-spk/sbb_binarization.svg?style=shield)](https://circleci.com/gh/qurator-spk/sbb_binarization)
[![GHActions Tests](https://github.com/qurator-spk/sbb_binarization/actions/workflows/test.yml/badge.svg)](https://github.com/qurator-spk/sbb_binarization/actions/workflows/test.yml)
-## Examples
-
## Installation
-Python versions `3.7-3.10` are currently supported.
+Python `3.8-3.11` with Tensorflow `<=2.11.1` are currently supported. While newer versions might also work, we currently don't test this.
-You can either install via
+You can either install from PyPI via
```
pip install sbb-binarization
@@ -29,16 +26,16 @@ cd sbb_binarization; pip install -e .
### Models
-Pre-trained models can be downloaded from the locations below. We also provide the models and [model card](https://huggingface.co/SBB/sbb_binarization) on 🤗
+Pre-trained models can be downloaded from the locations below. We also provide models and [model cards](https://huggingface.co/SBB/sbb_binarization) on 🤗
-| Version | Format | Download |
-|----------|:-------------:|-------|
+| Version | Format | Download |
+|------------|:-------------:|------------------------------------------------------------------------------------------------------|
| 2021-03-09 | `SavedModel` | https://github.com/qurator-spk/sbb_binarization/releases/download/v0.0.11/saved_model_2021_03_09.zip |
-| 2021-03-09 | `HDF5` | https://qurator-data.de/sbb_binarization/2021-03-09/models.tar.gz |
-| 2020-01-16 | `SavedModel` | https://github.com/qurator-spk/sbb_binarization/releases/download/v0.0.11/saved_model_2020_01_16.zip |
-| 2020-01-16 | `HDF5` | https://qurator-data.de/sbb_binarization/2020-01-16/models.tar.gz |
+| 2021-03-09 | `HDF5` | https://qurator-data.de/sbb_binarization/2021-03-09/models.tar.gz |
+| 2020-01-16 | `SavedModel` | https://github.com/qurator-spk/sbb_binarization/releases/download/v0.0.11/saved_model_2020_01_16.zip |
+| 2020-01-16 | `HDF5` | https://qurator-data.de/sbb_binarization/2020-01-16/models.tar.gz |
-With [OCR-D](https://ocr-d.de/), you can use the [Resource Manager](https://ocr-d.de/en/models) to deploy models, e.g.
+With [OCR-D](https://ocr-d.de/), you can also use the [Resource Manager](https://ocr-d.de/en/models), e.g.
ocrd resmgr download ocrd-sbb-binarize "*"