salakash commited on
Commit
27527c8
·
verified ·
1 Parent(s): 5a527bc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +75 -1
README.md CHANGED
@@ -57,7 +57,7 @@ Minimalism is designed for teams that value **minimalism, clarity, and correctne
57
  When you ask for code, Minimalism is tuned toward “runnable-first” answers—clear implementation, a minimal usage example, and a quick sanity check when appropriate.
58
 
59
 
60
- ![image](https://cdn-uploads.huggingface.co/production/uploads/6903f5738b82cf1035f9a011/fHRjpLh5Wy5s5sB26y3U9.png)
61
 
62
  ### Early validation
63
 
@@ -82,6 +82,80 @@ Developers need coding assistance that:
82
  - **Educators** teaching programming with consistent code examples
83
  - **Researchers** experimenting with LoRA fine-tuning on MLX
84
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
 
86
 
87
  ## Quick Start
 
57
  When you ask for code, Minimalism is tuned toward “runnable-first” answers—clear implementation, a minimal usage example, and a quick sanity check when appropriate.
58
 
59
 
60
+
61
 
62
  ### Early validation
63
 
 
82
  - **Educators** teaching programming with consistent code examples
83
  - **Researchers** experimenting with LoRA fine-tuning on MLX
84
 
85
+ ## 🔧 Technical Architecture
86
+
87
+ ### Method 1 Pipeline (9 Steps)
88
+
89
+ ```
90
+ 1. Receive Request
91
+
92
+ 2. Derive Requirements + Tests
93
+
94
+ 3. Generate N Candidates
95
+
96
+ 4. Normalize Code
97
+
98
+ 5. Score by LoC
99
+
100
+ 6. Apply Quality Gates (G1-G5)
101
+
102
+ 7. Select Minimal Passing
103
+
104
+ 8. Optional Reduction Loop
105
+
106
+ 9. Output + Audit
107
+ ```
108
+
109
+ ### Quality Gates
110
+
111
+ - **G1 Compile**: Python syntax validation
112
+ - **G2 Constraints**: Dependency checking
113
+ - **G3 Execution**: Sandbox smoke test (2s timeout)
114
+ - **G4 Tests**: Acceptance test validation
115
+ - **G5 Safety**: Dangerous operation detection
116
+
117
+ ### Key Design Principles
118
+
119
+ 1. **Text-based analysis** (no AST as required)
120
+ 2. **Fail-fast validation** (stop on first gate failure)
121
+ 3. **Sandbox isolation** (subprocess with timeout)
122
+ 4. **Complete audit trail** (every decision logged)
123
+ 5. **Pluggable architecture** (easy to extend)
124
+
125
+ ![image](https://cdn-uploads.huggingface.co/production/uploads/6903f5738b82cf1035f9a011/fHRjpLh5Wy5s5sB26y3U9.png)
126
+ ---
127
+
128
+ ## ✅ Acceptance Criteria Verification
129
+
130
+ ### Required Command ✅
131
+ ```bash
132
+ python3 -m askbuddyx_gov.cli \
133
+ --prompt "Write a Python function that parses a JSON string and returns an empty dict on error" \
134
+ --n 3 \
135
+ --reduce-iter 1
136
+ ```
137
+
138
+ **Results:**
139
+ - ✅ Produces output code file
140
+ - ✅ Shows full step-by-step sequence
141
+ - ✅ Selects minimal passing candidate
142
+ - ✅ Generates audit.json with per-candidate results
143
+
144
+ ### Pipeline Execution ✅
145
+ - ✅ All 9 steps execute in sequence
146
+ - ✅ Proper logging at each step
147
+ - ✅ 3 candidates generated (LoC: 19, 6, 2)
148
+ - ✅ All candidates validated through gates
149
+ - ✅ Minimal candidate selected (LoC=2)
150
+ - ✅ Complete audit trail saved
151
+
152
+ ### Quality Metrics ✅
153
+ - ✅ Selected candidate passes compile gate
154
+ - ✅ Selected candidate has minimal LoC
155
+ - ✅ Audit contains gate results for all candidates
156
+ - ✅ All data properly structured
157
+
158
+ ---
159
 
160
 
161
  ## Quick Start