upscale_models / AGENTS.md
yakdoli's picture
add project guidance
80dd0da verified
|
Raw
History Blame Contribute Delete
1.67 kB

PROJECT KNOWLEDGE BASE

OVERVIEW

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.

WHERE TO LOOK

Task Location Notes
Identify model provenance README.md Links to original projects/model cards
Use standalone checkpoints root *.pth files Copy into ComfyUI/models/upscale_models/
Inspect DAT implementation DAT/ Upstream code and its own conventions
Inspect HAT implementation HAT/ Upstream code and its own conventions
Inspect Omni-SR implementation Omni-SR/ Upstream code and its own conventions

CONVENTIONS

  • Preserve checkpoint filenames; downstream ComfyUI workflows may reference them directly.
  • Keep provenance/citation links in README.md when adding or replacing a model.
  • Treat each implementation directory as upstream code, not a shared workspace utility.
  • Keep model binaries under Git LFS policy; verify pointer/content state before transfers.

ANTI-PATTERNS

  • Do not recursively inspect, reformat, or rewrite model checkpoints.
  • Do not add Gwanbo-specific orchestration inside DAT, HAT, or Omni-SR sources.
  • Do not silently replace a checkpoint under an existing filename.
  • Do not copy these binaries into application, OCR, or restoration source repositories.
  • Do not run training or broad model downloads without explicit operator intent.

NOTES

No unified test or build command exists at this root. Follow the selected upstream implementation only when modifying that implementation itself.