aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-30 19:15:03 +0100
committerDanilo M. <danix@danix.xyz>2026-10-30 19:15:03 +0100
commit69810152d0dfedeaa02a96df73cbc184225a1278 (patch)
tree23b1f2c4cd3904831edccc942ab9277179f3121a /README.md
parent610bf7f3432037f7f8cfb641b05e39e48830f82a (diff)
downloadupscale-qt-69810152d0dfedeaa02a96df73cbc184225a1278.tar.gz
upscale-qt-69810152d0dfedeaa02a96df73cbc184225a1278.zip
Drop imajev suggestion, describe models from models.txt
The vision model picked the right upscaler about half the time on four test photos, and llama-mtmd-cli cannot turn its thinking off: greedy decoding loops, larger budgets cost seconds and still miss. The dropdown now shows a one-line description per model from an optional models.txt next to the models, so the choice stays with the user but is readable. Document usage, model descriptions and how to test. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 69bb441..bc59a39 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,33 @@
# upscale-qt
-Small PyQt6 app to upscale an image with an ESRGAN model through `sd-cli` (stable-diffusion.cpp). A local vision model suggests which upscaler fits the image, a slider wipe compares before and after, and the result can be saved as a new file or written over the original.
+Small PyQt6 app to upscale an image with an ESRGAN model through `sd-cli` (stable-diffusion.cpp). A slider wipe compares before and after, and the result can be saved as a new file or written over the original.
## Requirements
- Python 3
- PyQt6
- `sd-cli` from stable-diffusion.cpp, plus one or more ESRGAN upscaler models in a folder
-- Optional: `llama-mtmd-cli` from llama.cpp and the imajev model with its mmproj, for upscaler suggestions
## Usage
./upscale-qt [image]
+- Open an image (Ctrl+O, or pass it as argument). EXIF rotation is applied.
+- Pick a model and Upscale (Ctrl+U). Expect roughly 25 seconds per megapixel of input; the result is 4x in each direction.
+- The view shows before left of the divider and after right of it. Drag the divider to wipe, drag elsewhere to pan, mouse wheel to zoom, double-click to fit.
+- Save As (Ctrl+Shift+S) writes a new file. Overwrite replaces the original after a confirmation, in the same format. EXIF metadata is not kept.
+- Settings holds the upscalers folder.
+
+### Model descriptions
+
+Put a `models.txt` next to the models to show what each one is for in the dropdown:
+
+ # filename = what it is for
+ some_model_x4.pth = Clean photos: people, nature
+ other_model_x4.pth = Noisy or compressed photos
+
+Models without a line show their filename.
+
## License
Copyright (C) 2026 Danilo M. <danix@danix.xyz>