SynLayers commited on
Commit
0dd3d3d
·
verified ·
1 Parent(s): 82299c8

Upload demo/README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. demo/README.md +1 -102
demo/README.md CHANGED
@@ -6,7 +6,7 @@ colorTo: purple
6
  sdk: gradio
7
  python_version: "3.10"
8
  app_file: app.py
9
- suggested_hardware: H800
10
  models:
11
  - SynLayers/Bbox-caption-8b
12
  pinned: false
@@ -20,7 +20,6 @@ This folder now contains a unified real-world inference demo:
20
  2. `infer/infer.py` runs SynLayers decomposition with `infer/infer.yaml`.
21
  3. `demo/real_world_pipeline.py` stitches the two stages together for one uploaded image.
22
  4. `demo/app.py` provides a Gradio interface that can be used locally or adapted for a Hugging Face Space.
23
- 5. `demo/upload_used_bundle_to_hf.py` uploads only the Python/config files actually used by the demo, plus the selected runtime assets.
24
 
25
  ## Local Run
26
 
@@ -37,104 +36,4 @@ python demo/real_world_pipeline.py \
37
  --image "/path/to/your/image.png"
38
  ```
39
 
40
- ## Default Models
41
 
42
- The current local defaults are:
43
-
44
- - bbox-caption model:
45
- `/project/llmsvgen/share/data/kmw_layered_checkpoint/Bbox-caption-8b`
46
- - SynLayers base checkpoints:
47
- `/project/llmsvgen/share/data/kmw_layered_checkpoint/SynLayers_checkpoints`
48
- - SynLayers decomposition checkpoint:
49
- `/project/llmsvgen/share/data/kmw_layered_checkpoint/SynLayers_ckpt/step_120000`
50
- - base config:
51
- `infer/infer.yaml`
52
-
53
- ## Hugging Face Space Notes
54
-
55
- The Gradio app is ready for a Hugging Face Space.
56
- After you upload the model/runtime bundle to `SynLayers/Bbox-caption-8b`, the Space can download
57
- those uploaded assets automatically and use them directly.
58
-
59
- The app supports overriding the local defaults with environment variables:
60
-
61
- - `SYNLAYERS_MODEL_REPO`
62
- - `SYNLAYERS_BBOX_MODEL`
63
- - `SYNLAYERS_BASE_MODEL`
64
- - `SYNLAYERS_ADAPTER_MODEL`
65
- - `SYNLAYERS_TRANSP_VAE`
66
- - `SYNLAYERS_PRETRAINED_LORA`
67
- - `SYNLAYERS_ARTPLUS_LORA`
68
- - `SYNLAYERS_DECOMP_CKPT_ROOT`
69
- - `SYNLAYERS_REAL_CONFIG`
70
- - `SYNLAYERS_DEMO_WORK_DIR`
71
- - `SYNLAYERS_EXAMPLE_DIR`
72
-
73
- In practice, for a real Hugging Face Space deployment you will want to:
74
-
75
- 1. upload the required model/runtime assets to `SynLayers/Bbox-caption-8b`
76
- 2. create a Gradio Space repo, for example `SynLayers/synlayers-real-world-demo`
77
- 3. upload the Space scaffold with `demo/publish_space.py`
78
- 4. set `SYNLAYERS_MODEL_REPO=SynLayers/Bbox-caption-8b` in the Space settings
79
- 5. launch `app.py` as the Space entrypoint
80
-
81
- ### Public interface flow
82
-
83
- 1. Upload the model/runtime bundle:
84
-
85
- ```bash
86
- python demo/upload_used_bundle_to_hf.py \
87
- --repo-id SynLayers/Bbox-caption-8b
88
- ```
89
-
90
- 2. Create and upload the Space scaffold:
91
-
92
- ```bash
93
- python demo/publish_space.py \
94
- --repo-id SynLayers/synlayers-real-world-demo
95
- ```
96
-
97
- 3. In the Hugging Face Space settings, add:
98
-
99
- ```text
100
- SYNLAYERS_MODEL_REPO=SynLayers/Bbox-caption-8b
101
- ```
102
-
103
- Then the public Space interface will:
104
-
105
- - accept a user image upload
106
- - load the bbox-caption model from the uploaded model repo
107
- - download the SynLayers decomposition assets from that same repo
108
- - run the one-step decomposition pipeline
109
- - return the bbox visualization, merged output, per-layer outputs, and a downloadable archive
110
-
111
- ## Upload Bundle
112
-
113
- To upload the minimal used demo bundle to a Hugging Face repo:
114
-
115
- ```bash
116
- python demo/upload_used_bundle_to_hf.py \
117
- --repo-id SynLayers/Bbox-caption-8b
118
- ```
119
-
120
- This uploads:
121
-
122
- - the used `demo`, `infer`, `models`, and `tools` Python files
123
- - `demo/upload_used_bundle_to_hf.py`
124
- - `demo/publish_space.py`
125
- - `infer/infer.yaml`
126
- - `environment.yml`
127
- - `ckpt/trans_vae/0008000.pt`
128
- - `ckpt/pre_trained_LoRA/pytorch_lora_weights.safetensors`
129
- - `ckpt/prism_ft_LoRA/pytorch_lora_weights.safetensors`
130
- - `SynLayers_ckpt/step_120000`
131
- - `SynLayers_checkpoints/FLUX.1-dev`
132
- - `SynLayers_checkpoints/FLUX.1-dev-Controlnet-Inpainting-Alpha`
133
-
134
- ## Fixed Prompt
135
-
136
- The bbox detector always uses the fixed prompt defined in:
137
-
138
- - `demo/infer/run_caption_bbox_infer.py`
139
-
140
- No extra user text prompt is required.
 
6
  sdk: gradio
7
  python_version: "3.10"
8
  app_file: app.py
9
+ suggested_hardware: a100-large
10
  models:
11
  - SynLayers/Bbox-caption-8b
12
  pinned: false
 
20
  2. `infer/infer.py` runs SynLayers decomposition with `infer/infer.yaml`.
21
  3. `demo/real_world_pipeline.py` stitches the two stages together for one uploaded image.
22
  4. `demo/app.py` provides a Gradio interface that can be used locally or adapted for a Hugging Face Space.
 
23
 
24
  ## Local Run
25
 
 
36
  --image "/path/to/your/image.png"
37
  ```
38
 
 
39