Xbits commited on
Commit
75b6a6d
·
1 Parent(s): b53a535

update readme

Browse files
Files changed (1) hide show
  1. README.md +20 -0
README.md CHANGED
@@ -11,4 +11,24 @@ pinned: false
11
  short_description: 'Trying out different binarizations solutions '
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
11
  short_description: 'Trying out different binarizations solutions '
12
  ---
13
 
14
+ # Xibi Binarization
15
+
16
+ This demo compares multiple document binarization methods:
17
+ - `Sauvola (Traditional)` — CPU-based adaptive thresholding
18
+ - `Tzefa-Binarization` — Hugging Face image-to-image pipeline fallback
19
+ - `Two-Stage GAN (opensuh)` — Hugging Face pipeline fallback
20
+ - `DocRes (Generalist Transformer)` — Hugging Face pipeline fallback
21
+
22
+ ## Notes
23
+
24
+ - `app.py` now supports running even when `cv2` is not installed.
25
+ - If the hosted Hugging Face model pipelines are unavailable, the demo falls back to local grayscale thresholding or Sauvola-like binarization.
26
+ - This makes the app more stable in environments where GPU/model dependencies are missing.
27
+
28
+ ## Requirements
29
+
30
+ Install the standard dependencies listed in `requirements.txt`.
31
+
32
+ If you want full model support, also install and configure any required GPU/transformers support for the Hugging Face pipelines.
33
+
34
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference