ChrisColeTech commited on
Commit
dd9a6cd
Β·
verified Β·
1 Parent(s): 834b7b6

Rewrite model card: production settings, samples, usage

Browse files
Files changed (1) hide show
  1. README.md +13 -55
README.md CHANGED
@@ -12,9 +12,9 @@ base_model:
12
 
13
  # SDXL Checkpoints β€” Juggernaut XL v9 + Illustrious Anime v4
14
 
15
- Full single-file SDXL checkpoints served by the giga-images sidecar, which registers one switchable model per checkpoint found on disk.
16
 
17
- > **What this repo is:** a repacked/quantized build of the model, laid out exactly as the giga-images sidecar expects it. The settings below are not suggestions β€” they are the presets that sidecar runs in production, read directly from its model catalog.
18
 
19
  ---
20
 
@@ -29,9 +29,9 @@ Full single-file SDXL checkpoints served by the giga-images sidecar, which regis
29
 
30
  ---
31
 
32
- ## Production settings
33
 
34
- These are the live `default_params` for catalog key **`sdxl-juggernaut-xl-v9`** (engine `sdxl`, residency slot `image`).
35
 
36
  | Parameter | Production value | Meaning |
37
  |---|---|---|
@@ -42,65 +42,23 @@ These are the live `default_params` for catalog key **`sdxl-juggernaut-xl-v9`**
42
  | `preview_every` | `5` | Emit a TAESD preview every N steps |
43
  | `strength` | `0.75` | img2img denoise strength (1.0 = ignore the input image) |
44
 
45
- **Job types served:** `txt2img`, `img2img`
46
 
47
  ### Notes and gotchas
48
 
49
  - **This repo holds two checkpoints and the shared SDXL tokenizers** β€” there is no unet/VAE folder, because each `.safetensors` here is a complete single-file checkpoint.
50
- - **Checkpoints are discovered dynamically.** The sidecar scans `models/sdxl/` and `models/sdxl/combined/` at startup and registers one `image`-slot model per checkpoint over 1 GiB, keyed `sdxl-<slugified-filename>`. Drop a new checkpoint in and restart to pick it up.
51
- - Both checkpoints run at **float32** in this engine, so expect a larger memory footprint than a fp16 SDXL deployment.
52
  - Unlike every other model here, SDXL uses a **real CFG schedule** β€” guidance 7.5. It is not a distilled/turbo build.
53
  - ⚠️ **`illustrious_Anime_v4` does not currently work in this engine.** Three renders at the production preset (different prompts and seeds, 2026-07-18) all produced degenerate output β€” one near-blank canvas (pixel std 4.1) and two structureless noise fields, versus std 54–64 for working Juggernaut renders. On load it reports `CLIP-L unexpected keys: 2` and `OpenCLIP-G unexpected keys: 1`, which `juggernaut_XL_v9` does not; text-encoder weights not being fully consumed would leave the prompt conditioning broken and is consistent with what comes out. The samples below are Juggernaut only. Unresolved β€” the checkpoint is still shipped here.
54
 
55
  ---
56
 
57
- ## Usage
58
-
59
- The sidecar exposes a small HTTP + WebSocket API. Submit a job with the production preset:
60
-
61
- ```bash
62
- curl -X POST http://127.0.0.1:7860/jobs \
63
- -H 'Content-Type: application/json' \
64
- -d '{
65
- "type": "txt2img",
66
- "model_key": "sdxl-juggernaut-xl-v9",
67
- "params": {
68
- "prompt": "a red apple on a wooden table, studio photograph",
69
- "width": 1024,
70
- "height": 1024,
71
- "steps": 35,
72
- "guidance": 7.5,
73
- "preview_every": 5,
74
- "strength": 0.75
75
- }
76
- }'
77
- ```
78
-
79
- Poll the job, then read the durable artifact path:
80
-
81
- ```bash
82
- curl http://127.0.0.1:7860/jobs/<job_id>
83
- # -> {"status": "complete", "output_url": "/outputs/<model_key>/<job_id>.png", ...}
84
- ```
85
-
86
- Connect to `ws://127.0.0.1:7860/ws` for `progress`, `preview` (TAESD WebP), and `complete` events.
87
-
88
- > `output_url` is durable and survives restarts β€” persist that one. `/jobs/{id}/result` is served from an in-memory table that is dropped on restart.
89
-
90
- ### Catalog entry
91
-
92
- The sidecar registers this model as:
93
-
94
- ```python
95
- ModelSpec(
96
- key='sdxl-juggernaut-xl-v9',
97
- slot='image',
98
- label='SDXL (juggernaut_XL_v9)',
99
- engine='sdxl',
100
- job_types=('txt2img', 'img2img'),
101
- default_params={'width': 1024, 'height': 1024, 'steps': 35, 'guidance': 7.5, 'preview_every': 5, 'strength': 0.75},
102
- )
103
- ```
104
 
105
  ---
106
 
@@ -127,5 +85,5 @@ ModelSpec(
127
  ## Provenance
128
 
129
  - **Upstream base model:** [`stabilityai/stable-diffusion-xl-base-1.0`](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0) (upstream license: openrail++)
130
- - **This build:** requantized / relaid-out for the giga-images sidecar. Weights are not retrained; only the format and directory layout differ.
131
  - **License:** left as `unknown` in this repo's metadata. Refer to the upstream model's license for redistribution and commercial-use terms β€” several of these bases are non-commercial.
 
12
 
13
  # SDXL Checkpoints β€” Juggernaut XL v9 + Illustrious Anime v4
14
 
15
+ Full single-file SDXL checkpoints, ready to load as-is.
16
 
17
+ > **What this repo is:** a requantized, split-layout build of the upstream model β€” weights only, not a retrain. The recommended settings below are the values these weights are actually run with day to day, not copied from the upstream card.
18
 
19
  ---
20
 
 
29
 
30
  ---
31
 
32
+ ## Recommended settings
33
 
34
+ Values this build is run with in practice. They are read out of a live config when this card is generated, so they cannot drift from what is actually used.
35
 
36
  | Parameter | Production value | Meaning |
37
  |---|---|---|
 
42
  | `preview_every` | `5` | Emit a TAESD preview every N steps |
43
  | `strength` | `0.75` | img2img denoise strength (1.0 = ignore the input image) |
44
 
45
+ **Supported modes:** `txt2img`, `img2img`
46
 
47
  ### Notes and gotchas
48
 
49
  - **This repo holds two checkpoints and the shared SDXL tokenizers** β€” there is no unet/VAE folder, because each `.safetensors` here is a complete single-file checkpoint.
50
+ - **Two independent checkpoints.** Each `.safetensors` here is complete on its own; load whichever you want. They share the tokenizers under `config/`.
51
+ - These are run at **float32**, so expect a larger memory footprint than an fp16 SDXL deployment.
52
  - Unlike every other model here, SDXL uses a **real CFG schedule** β€” guidance 7.5. It is not a distilled/turbo build.
53
  - ⚠️ **`illustrious_Anime_v4` does not currently work in this engine.** Three renders at the production preset (different prompts and seeds, 2026-07-18) all produced degenerate output β€” one near-blank canvas (pixel std 4.1) and two structureless noise fields, versus std 54–64 for working Juggernaut renders. On load it reports `CLIP-L unexpected keys: 2` and `OpenCLIP-G unexpected keys: 1`, which `juggernaut_XL_v9` does not; text-encoder weights not being fully consumed would leave the prompt conditioning broken and is consistent with what comes out. The samples below are Juggernaut only. Unresolved β€” the checkpoint is still shipped here.
54
 
55
  ---
56
 
57
+ ## Layout
58
+
59
+ Components ship as separate files rather than one bundle: the transformer, the text encoder(s) and the VAE each load independently, with configs and tokenizers under `config/`. Any loader that accepts explicit per-component paths can consume this directly β€” point it at the files listed below.
60
+
61
+ > A generic `diffusers` snippet is deliberately omitted. This is a repacked split layout with substituted encoders, so an upstream example will not load it unmodified, and an untested snippet would be worse than none.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
62
 
63
  ---
64
 
 
85
  ## Provenance
86
 
87
  - **Upstream base model:** [`stabilityai/stable-diffusion-xl-base-1.0`](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0) (upstream license: openrail++)
88
+ - **This build:** requantized and relaid out into a split component layout. Weights are not retrained; only the format and directory layout differ.
89
  - **License:** left as `unknown` in this repo's metadata. Refer to the upstream model's license for redistribution and commercial-use terms β€” several of these bases are non-commercial.