Nishan30 commited on
Commit
aa56604
Β·
verified Β·
1 Parent(s): 6640b02

Update Readme

Browse files
Files changed (1) hide show
  1. README.md +93 -6
README.md CHANGED
@@ -1,12 +1,99 @@
1
  ---
2
- title: N8n Workflow Generator App
3
- emoji: πŸ‘
4
- colorFrom: purple
5
- colorTo: yellow
6
  sdk: gradio
7
- sdk_version: 6.0.1
8
  app_file: app.py
9
  pinned: false
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: n8n Workflow Generator
3
+ emoji: πŸš€
4
+ colorFrom: red
5
+ colorTo: green
6
  sdk: gradio
7
+ sdk_version: 4.16.0
8
  app_file: app.py
9
  pinned: false
10
+ license: apache-2.0
11
  ---
12
 
13
+ # n8n Workflow Generator
14
+
15
+ Generate n8n workflows using natural language! This app uses a fine-tuned **Qwen2.5-Coder-1.5B** model to convert plain English descriptions into working n8n workflows.
16
+
17
+ ## 🎯 Performance
18
+
19
+ - **Overall Test Score:** 92.4%
20
+ - **Training Examples:** 247 curated workflows
21
+ - **Validation Examples:** 44
22
+
23
+ ## πŸš€ Features
24
+
25
+ - **Natural Language Input:** Describe workflows in plain English
26
+ - **Visual Preview:** See your workflow nodes and connections
27
+ - **TypeScript DSL:** Get clean, production-ready code
28
+ - **n8n JSON Export:** Import directly into your n8n instance
29
+ - **Adjustable Parameters:** Control creativity and output length
30
+
31
+ ## πŸ“Š Test Results by Category
32
+
33
+ | Category | Score |
34
+ |----------|-------|
35
+ | Basic Workflows | 100% |
36
+ | Complexity | 96% |
37
+ | Error Handling | 80% |
38
+ | Loops | 67% |
39
+ | Branching | 67% |
40
+ | **Overall** | **92.4%** |
41
+
42
+ ## πŸ’‘ Example Prompts
43
+
44
+ Try these prompts to see what the model can do:
45
+
46
+ - "Create a webhook that sends data to Slack"
47
+ - "Schedule that runs daily and backs up database to Google Drive"
48
+ - "Webhook receives form data, validates email, saves to Airtable"
49
+ - "Monitor RSS feed and post new items to Twitter"
50
+ - "Fetch GitHub issues, if priority is high send to Slack, else email"
51
+
52
+ ## πŸ› οΈ How It Works
53
+
54
+ 1. **Input:** You describe your workflow in natural language
55
+ 2. **Generation:** Fine-tuned Qwen2.5-Coder-1.5B generates TypeScript DSL
56
+ 3. **Conversion:** Code is converted to n8n JSON format
57
+ 4. **Visualization:** Workflow structure is displayed visually
58
+ 5. **Export:** Copy and import into your n8n instance
59
+
60
+ ## πŸ“ Model Details
61
+
62
+ - **Base Model:** Qwen/Qwen2.5-Coder-1.5B-Instruct
63
+ - **Fine-tuning Method:** LoRA (Low-Rank Adaptation)
64
+ - **Dataset:** Curated n8n workflows from GitHub
65
+ - **Training Framework:** Transformers + PEFT
66
+
67
+ ## πŸŽ“ Training Details
68
+
69
+ - **LoRA Rank:** 16
70
+ - **LoRA Alpha:** 32
71
+ - **Learning Rate:** 2e-4
72
+ - **Training Strategy:** Early stopping with validation monitoring
73
+ - **Hardware:** NVIDIA Tesla T4 GPU
74
+
75
+ ## πŸ“– Usage Tips
76
+
77
+ - **Be specific:** More details = better results
78
+ - **Use n8n terminology:** Mention specific nodes like "webhook", "Slack", "HTTP Request"
79
+ - **Describe the flow:** "When X happens, do Y, then Z"
80
+ - **Adjust temperature:** Lower (0.1-0.3) for consistency, higher (0.5-0.8) for creativity
81
+
82
+ ## πŸ”§ Limitations
83
+
84
+ - Works best with common n8n patterns
85
+ - May struggle with very complex branching (>5 conditions)
86
+ - Advanced error handling might need manual refinement
87
+ - Custom node configurations may need adjustment
88
+
89
+ ## πŸ“„ License
90
+
91
+ Apache 2.0
92
+
93
+ ## πŸ™ Acknowledgments
94
+
95
+ Built with:
96
+ - [Qwen2.5-Coder](https://huggingface.co/Qwen/Qwen2.5-Coder-1.5B-Instruct)
97
+ - [Hugging Face Transformers](https://github.com/huggingface/transformers)
98
+ - [PEFT](https://github.com/huggingface/peft)
99
+ - [Gradio](https://gradio.app)