add project guidance
Browse files
AGENTS.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# PROJECT KNOWLEDGE BASE
|
| 2 |
+
|
| 3 |
+
## OVERVIEW
|
| 4 |
+
|
| 5 |
+
ComfyUI upscale-model collection containing binary checkpoints and upstream DAT, HAT, and Omni-SR implementations. This is a model distribution/staging repository, not workspace application code.
|
| 6 |
+
|
| 7 |
+
## WHERE TO LOOK
|
| 8 |
+
|
| 9 |
+
| Task | Location | Notes |
|
| 10 |
+
|------|----------|-------|
|
| 11 |
+
| Identify model provenance | `README.md` | Links to original projects/model cards |
|
| 12 |
+
| Use standalone checkpoints | root `*.pth` files | Copy into `ComfyUI/models/upscale_models/` |
|
| 13 |
+
| Inspect DAT implementation | `DAT/` | Upstream code and its own conventions |
|
| 14 |
+
| Inspect HAT implementation | `HAT/` | Upstream code and its own conventions |
|
| 15 |
+
| Inspect Omni-SR implementation | `Omni-SR/` | Upstream code and its own conventions |
|
| 16 |
+
|
| 17 |
+
## CONVENTIONS
|
| 18 |
+
|
| 19 |
+
- Preserve checkpoint filenames; downstream ComfyUI workflows may reference them directly.
|
| 20 |
+
- Keep provenance/citation links in `README.md` when adding or replacing a model.
|
| 21 |
+
- Treat each implementation directory as upstream code, not a shared workspace utility.
|
| 22 |
+
- Keep model binaries under Git LFS policy; verify pointer/content state before transfers.
|
| 23 |
+
|
| 24 |
+
## ANTI-PATTERNS
|
| 25 |
+
|
| 26 |
+
- Do not recursively inspect, reformat, or rewrite model checkpoints.
|
| 27 |
+
- Do not add Gwanbo-specific orchestration inside DAT, HAT, or Omni-SR sources.
|
| 28 |
+
- Do not silently replace a checkpoint under an existing filename.
|
| 29 |
+
- Do not copy these binaries into application, OCR, or restoration source repositories.
|
| 30 |
+
- Do not run training or broad model downloads without explicit operator intent.
|
| 31 |
+
|
| 32 |
+
## NOTES
|
| 33 |
+
|
| 34 |
+
No unified test or build command exists at this root. Follow the selected upstream implementation only when modifying that implementation itself.
|