Skip to content

Commit 386bda7

Browse files
committed
add readme
1 parent db4afb5 commit 386bda7

File tree

2 files changed

+103
-0
lines changed

2 files changed

+103
-0
lines changed

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<div align="center">
2+
3+
# 🚀 ComfyUI-Copilot: Your Intelligent Assistant for Comfy-UI
4+
5+
<!-- Enhancing Image Generation Development with Smart Assistance -->
6+
7+
<h4 align="center">
8+
9+
<div align="center">
10+
<img src="https://img.shields.io/badge/Version-1.0.0-blue.svg" alt="Version">
11+
<img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License">
12+
<img src="https://img.shields.io/github/stars/your-repo/ComfyUI-Copilot?color=yellow" alt="Stars">
13+
<img src="https://img.shields.io/github/issues/your-repo/ComfyUI-Copilot?color=red" alt="Issues">
14+
<img src="https://img.shields.io/badge/python-3.10%2B-purple.svg" alt="Python">
15+
16+
</h4>
17+
18+
19+
👾 _**Alibaba International Digital Commerce**_
20+
21+
[**Github**](https://github.com/AIDC-AI/ComfyUI-Copilot) 📑
22+
23+
</div>
24+
25+
https://github.com/user-attachments/assets/0372faf4-eb64-4aad-82e6-5fd69f349c2c
26+
27+
## 🌟 Introduction
28+
29+
Welcome to **ComfyUI-Copilot**, an intelligent assistant built on the Comfy-UI framework that simplifies and enhances the AI algorithm debugging and deployment process through natural language interactions.
30+
31+
Whether it's generating text, images, or audio, ComfyUI-Copilot offers intuitive node recommendations, workflow building aids, and model querying services to streamline your development process.
32+
33+
<div align="center">
34+
<img src="assets/Framework.png"/>
35+
</div>
36+
37+
38+
---
39+
40+
## 🤔 Why Choose ComfyUI-Copilot?
41+
42+
- **Ease of Use**: Lower the barriers to entry with natural language interaction, making Comfy-UI accessible even for beginners.
43+
- **Smart Recommendations**: Leverage AI-driven node suggestions and workflow implementations to boost development efficiency.
44+
- **Real-Time Assistance**: Benefit from round-the-clock interactive support to address any issues encountered during development.
45+
46+
---
47+
48+
## ⚙️ Core Features
49+
50+
- **Interactive Q&A Bot**: Access a robust Q&A platform where users can inquire about model intricacies, node details, and parameter utilization with ease.
51+
- **Natural Language Node Suggestions**: Employ our advanced search mechanism to swiftly identify desired nodes and enhance workflow construction efficacy.
52+
<img src="assets/comfycopilot_nodes_recommend.gif"/>
53+
- **Node Query System**: Dive deeper into nodes by exploring their explanations, parameter definitions, usage tips, and downstream workflow recommendations.
54+
<img src="assets/comfycopilot_nodes_search.gif"/>
55+
- **Smart Workflow Assistance**: Automatically discern developer needs to recommend and build fitting workflow frameworks, minimizing manual setup time.
56+
<img src="assets/工作流检索.png"/>
57+
- **Model Querying**: Prompt Copilot to seek foundational models and 'lora' based on requirements.
58+
- **Up-and-Coming Features**:
59+
60+
- **Automated Parameter Tuning**: Exploit machine learning algorithms for seamless analysis and optimization of critical workflow parameters.
61+
- **Error Diagnosis and Fix Suggestions**: Receive comprehensive error insights and corrective advice to swiftly pinpoint and resolve issues.
62+
63+
---
64+
65+
## 🚀 Getting Started
66+
67+
**Repository Overview**: Visit the [GitHub Repository](https://github.com/AIDC-AI/ComfyUI-Copilot) to access the complete codebase.
68+
69+
1. **Installation**:
70+
71+
```bash
72+
cd ComfyUI/custom_nodes
73+
git clone [email protected]:AIDC-AI/ComfyUI-Copilot.git
74+
```
75+
76+
or
77+
78+
```bash
79+
cd ComfyUI/custom_nodes
80+
git clone https://github.com/AIDC-AI/ComfyUI-Copilot
81+
```
82+
2. **Activation**: After running the ComfyUI project, find the Copilot activation button at the top-right corner of the board to launch its service.
83+
<img src="assets/start.png"/>
84+
3. **KeyGeneration**:Enter your name and email address on the link, and the api-key will automatically be sent to your email address later.
85+
86+
<img src="assets/keygen.png"/>
87+
---
88+
89+
## 🤝 Contributions
90+
91+
We welcome any form of contribution! Feel free to make issues, pull requests, or suggest new features.
92+
93+
---
94+
95+
## 📞 Contact Us
96+
97+
For any queries or suggestions, please feel free to contact: [email protected]
98+
99+
---
100+
101+
## 📄 License
102+
103+
This project is licensed under the MIT License - see the [LICENSE](https://opensource.org/licenses/MIT) file for details.

assets/Framework.png

1.26 MB
Loading

0 commit comments

Comments
 (0)