diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e854938 --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +# Internal config +rh_config.json + +# Python +__pycache__/ +*.py[cod] +*$py.class +*.so +.Python +venv/ +ENV/ +*.egg-info/ +.eggs/ +dist/ +build/ + +# IDE +.idea/ +.vscode/ +*.swp +*.swo + +# OS +.DS_Store +Thumbs.db + +# Large model files +*.pth +*.ckpt +*.safetensors +models/ + +# Logs +*.log diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9492af7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to the Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2024 RunningHub + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b857f0 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# ComfyUI Z-Image I2L (Image to LoRA) + +![License](https://img.shields.io/badge/License-Apache%202.0-green) + +ComfyUI custom nodes for Z-Image Image-to-LoRA generation. Generate personalized LoRA weights from reference images using [DiffSynth-Studio](https://github.com/modelscope/DiffSynth-Studio)'s Z-Image pipeline. + +## ✨ Features + +- **Image to LoRA**: Generate LoRA weights directly from reference images +- **No Training Required**: Instant LoRA generation without traditional fine-tuning +- **ComfyUI Integration**: Seamless workflow integration with standard LoRA nodes + +## 🛠️ Installation + +1. Clone this repository into your ComfyUI custom nodes folder: + +```bash +cd ComfyUI/custom_nodes +git clone https://github.com/HM-RunningHub/ComfyUI_RH_ZImageI2L.git +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +## 📦 Model Downloads + +Models will be automatically downloaded from ModelScope/HuggingFace on first run: + +- [Tongyi-MAI/Z-Image](https://modelscope.cn/models/Tongyi-MAI/Z-Image) - Base transformer +- [Tongyi-MAI/Z-Image-Turbo](https://modelscope.cn/models/Tongyi-MAI/Z-Image-Turbo) - Text encoder & VAE +- [DiffSynth-Studio/General-Image-Encoders](https://modelscope.cn/models/DiffSynth-Studio/General-Image-Encoders) - Image encoders (SigLIP2, DINOv3) +- [DiffSynth-Studio/Z-Image-i2L](https://modelscope.cn/models/DiffSynth-Studio/Z-Image-i2L) - Image to LoRA model + +## 🚀 Usage + +### Nodes + +| Node | Description | +|------|-------------| +| **ZImageI2L Loader** | Load the Z-Image I2L pipeline | +| **ZImageI2L LoRA Generator** | Generate LoRA from input images | +| **ZImageI2L Saver** | Save generated LoRA to output folder | + +### Basic Workflow + +1. Add **ZImageI2L Loader** to load the pipeline +2. Connect your reference images to **ZImageI2L LoRA Generator** +3. Use **ZImageI2L Saver** to save the generated LoRA +4. Use the generated LoRA with any standard LoRA loader node + +## 📝 Parameters + +### ZImageI2L LoRA Generator + +| Parameter | Type | Description | +|-----------|------|-------------| +| `pipeline` | RH_ZImageI2LPipeline | Pipeline from Loader node | +| `training_images` | IMAGE | Reference images for LoRA generation | +| `seed` | INT | Random seed for reproducibility | + +## ⚠️ Requirements + +- **VRAM**: 24GB+ recommended (tested on RTX 4090) +- **Python**: 3.10+ +- **ComfyUI**: Latest version + +## 🙏 Acknowledgments + +- [DiffSynth-Studio](https://github.com/modelscope/DiffSynth-Studio) - Core Z-Image pipeline +- [Tongyi-MAI](https://modelscope.cn/organization/Tongyi-MAI) - Z-Image models + +## 📄 License + +This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. diff --git a/nodes.py b/nodes.py index 24f866b..78dec34 100644 --- a/nodes.py +++ b/nodes.py @@ -67,7 +67,7 @@ class RunningHub_ZImageI2L_Loader: def load(self): loaded_models = mm.current_loaded_models - print(f'[kiki] loaded_models:', len(loaded_models)) + print(f'[ZImageI2L] Unloading {len(loaded_models)} models for pipeline loading') if len(loaded_models) > 0: mm.unload_all_models() gc.collect() @@ -118,7 +118,7 @@ class RunningHub_ZImageI2L_LoraGenerator: def generate(self, pipeline, training_images, **kwargs): loaded_models = mm.current_loaded_models - print(f'[kiki] loaded_models before generate:', len(loaded_models)) + print(f'[ZImageI2L] Unloading {len(loaded_models)} models for LoRA generation') if len(loaded_models) > 0: mm.unload_all_models() gc.collect() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e752d21 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +# Core dependencies +torch>=2.0.0 +safetensors +Pillow +numpy + +# DiffSynth-Studio (includes Z-Image pipeline) +# Install from: https://github.com/modelscope/DiffSynth-Studio +diffsynth diff --git a/rh_config.json b/rh_config.json deleted file mode 100644 index 6e0b528..0000000 --- a/rh_config.json +++ /dev/null @@ -1 +0,0 @@ -{"enable": true, "untracked_paths": []}