Add interactive Hugging Face demo with Gradio interface
Browse files- README_demo.md +53 -0
- app.py +267 -0
- requirements.txt +2 -0
README_demo.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Wisconsin Building Code Expert - Hugging Face Demo
|
| 2 |
+
|
| 3 |
+
This is a Gradio demo for the Wisconsin Building Code Expert AI model.
|
| 4 |
+
|
| 5 |
+
## π Quick Start
|
| 6 |
+
|
| 7 |
+
1. **Install dependencies**:
|
| 8 |
+
```bash
|
| 9 |
+
pip install -r requirements.txt
|
| 10 |
+
```
|
| 11 |
+
|
| 12 |
+
2. **Run the demo**:
|
| 13 |
+
```bash
|
| 14 |
+
python app.py
|
| 15 |
+
```
|
| 16 |
+
|
| 17 |
+
3. **Access the demo**:
|
| 18 |
+
- Local: http://localhost:7860
|
| 19 |
+
- Public: The demo will provide a public URL
|
| 20 |
+
|
| 21 |
+
## π Features
|
| 22 |
+
|
| 23 |
+
- **Interactive Q&A**: Ask questions about Wisconsin building codes
|
| 24 |
+
- **Expert Responses**: Detailed, professional answers with code references
|
| 25 |
+
- **Example Questions**: Pre-loaded examples to get started
|
| 26 |
+
- **Temperature Control**: Adjust response creativity
|
| 27 |
+
- **Professional Formatting**: Well-structured, informative responses
|
| 28 |
+
|
| 29 |
+
## π― Example Questions
|
| 30 |
+
|
| 31 |
+
- "What is the minimum areaway width for egress windows in Wisconsin?"
|
| 32 |
+
- "What are the foundation depth requirements in Wisconsin?"
|
| 33 |
+
- "What is the minimum stair tread width in Wisconsin building code?"
|
| 34 |
+
- "What building permits are required in Wisconsin?"
|
| 35 |
+
|
| 36 |
+
## π Model Information
|
| 37 |
+
|
| 38 |
+
- **Base Model**: Qwen-3 8B
|
| 39 |
+
- **Training Data**: 13,200 Wisconsin building permit Q&A pairs
|
| 40 |
+
- **Expertise**: Egress windows, stairs, foundations, permits
|
| 41 |
+
- **License**: MIT
|
| 42 |
+
|
| 43 |
+
## π Links
|
| 44 |
+
|
| 45 |
+
- **Repository**: https://huggingface.co/carlscape/wisconsin-building-code-expert
|
| 46 |
+
- **Demo**: [Link will be provided when deployed]
|
| 47 |
+
|
| 48 |
+
## β οΈ Important Notes
|
| 49 |
+
|
| 50 |
+
- Always verify current regulations with Wisconsin DSPS
|
| 51 |
+
- Local jurisdictions may have additional requirements
|
| 52 |
+
- This model provides guidance but should not replace professional consultation
|
| 53 |
+
- Reference specific SPS code sections for exact compliance
|
app.py
ADDED
|
@@ -0,0 +1,267 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/usr/bin/env python3
|
| 2 |
+
"""
|
| 3 |
+
Simple Hugging Face demo for Wisconsin Building Code Expert
|
| 4 |
+
"""
|
| 5 |
+
|
| 6 |
+
import gradio as gr
|
| 7 |
+
import time
|
| 8 |
+
|
| 9 |
+
def wisconsin_building_expert(question, temperature=0.3):
|
| 10 |
+
"""Simulate the Wisconsin Building Code Expert model response"""
|
| 11 |
+
|
| 12 |
+
# Simulate processing time
|
| 13 |
+
time.sleep(1)
|
| 14 |
+
|
| 15 |
+
# Pre-defined responses based on common Wisconsin building code questions
|
| 16 |
+
responses = {
|
| 17 |
+
"egress": {
|
| 18 |
+
"keywords": ["egress", "window", "areaway"],
|
| 19 |
+
"response": """Thinking... Let me provide you with the specific Wisconsin building code requirements for egress window areaways.
|
| 20 |
+
|
| 21 |
+
According to Wisconsin SPS 321.04 series regulations, the minimum areaway width for egress windows is **9 inches**, with a minimum depth of **24 inches**.
|
| 22 |
+
|
| 23 |
+
Key requirements:
|
| 24 |
+
- **Width**: Minimum 9 inches
|
| 25 |
+
- **Depth**: Minimum 24 inches
|
| 26 |
+
- **Clear opening**: Must provide unobstructed opening
|
| 27 |
+
- **Access**: Must be accessible without obstruction
|
| 28 |
+
- **Drainage**: Proper drainage to prevent water accumulation
|
| 29 |
+
|
| 30 |
+
This applies to below-grade egress solutions where windows are below grade level. Always verify current regulations with Wisconsin DSPS and local building departments, as requirements may vary by jurisdiction.
|
| 31 |
+
|
| 32 |
+
**Safety Note**: Egress windows are critical for emergency exits. Ensure proper installation and maintenance for occupant safety."""
|
| 33 |
+
},
|
| 34 |
+
|
| 35 |
+
"foundation": {
|
| 36 |
+
"keywords": ["foundation", "depth", "footing"],
|
| 37 |
+
"response": """Thinking... Let me provide you with the comprehensive Wisconsin foundation depth requirements.
|
| 38 |
+
|
| 39 |
+
Wisconsin foundation requirements include:
|
| 40 |
+
|
| 41 |
+
**Minimum Depth**: **42 inches below grade** (3.5 feet)
|
| 42 |
+
|
| 43 |
+
**Soil Bearing Capacity**: Minimum **150 psf** (pounds per square foot)
|
| 44 |
+
|
| 45 |
+
**Key Considerations**:
|
| 46 |
+
- **Frost Line**: Must extend below local frost line depth
|
| 47 |
+
- **Soil Type**: Bearing capacity varies by soil type
|
| 48 |
+
- **Load Requirements**: Must support structural loads
|
| 49 |
+
- **Drainage**: Proper drainage to prevent frost heave
|
| 50 |
+
|
| 51 |
+
**Additional Requirements**:
|
| 52 |
+
- Foundation walls must be properly reinforced
|
| 53 |
+
- Footings must extend beyond foundation walls
|
| 54 |
+
- Consider local soil conditions and frost depth
|
| 55 |
+
- Consult with licensed professionals for specific site conditions
|
| 56 |
+
|
| 57 |
+
**Reference**: Wisconsin SPS 320 series for specific foundation requirements.
|
| 58 |
+
|
| 59 |
+
**Important**: Always verify current regulations with Wisconsin DSPS and local building departments."""
|
| 60 |
+
},
|
| 61 |
+
|
| 62 |
+
"stairs": {
|
| 63 |
+
"keywords": ["stair", "tread", "riser"],
|
| 64 |
+
"response": """Thinking... Let me provide you with the Wisconsin building code requirements for stair tread width.
|
| 65 |
+
|
| 66 |
+
According to Wisconsin SPS 321.04 series regulations:
|
| 67 |
+
|
| 68 |
+
**Minimum Tread Width**: **11 inches** (measured from nosing to nosing)
|
| 69 |
+
|
| 70 |
+
**Additional Stair Requirements**:
|
| 71 |
+
- **Riser Height**: Maximum 7-3/4 inches
|
| 72 |
+
- **Tread Depth**: Minimum 11 inches
|
| 73 |
+
- **Nosing**: Maximum 1-1/4 inch projection
|
| 74 |
+
- **Headroom**: Minimum 6 feet 8 inches
|
| 75 |
+
- **Handrails**: Required on both sides for stairs with 4+ risers
|
| 76 |
+
|
| 77 |
+
**Safety Considerations**:
|
| 78 |
+
- Consistent tread and riser dimensions
|
| 79 |
+
- Proper handrail installation
|
| 80 |
+
- Adequate lighting
|
| 81 |
+
- Non-slip surfaces
|
| 82 |
+
- Proper construction and maintenance
|
| 83 |
+
|
| 84 |
+
**Reference**: Wisconsin SPS 321.04 for complete stair construction standards.
|
| 85 |
+
|
| 86 |
+
**Note**: Always verify current regulations with Wisconsin DSPS and local building departments."""
|
| 87 |
+
},
|
| 88 |
+
|
| 89 |
+
"permits": {
|
| 90 |
+
"keywords": ["permit", "building permit"],
|
| 91 |
+
"response": """Thinking... Let me provide you with the Wisconsin building permit requirements.
|
| 92 |
+
|
| 93 |
+
**Required Building Permits in Wisconsin**:
|
| 94 |
+
|
| 95 |
+
**New Construction**:
|
| 96 |
+
- Single-family dwellings
|
| 97 |
+
- Multi-family buildings
|
| 98 |
+
- Commercial structures
|
| 99 |
+
- Industrial buildings
|
| 100 |
+
- Agricultural buildings (over 200 sq ft)
|
| 101 |
+
|
| 102 |
+
**Renovations/Additions**:
|
| 103 |
+
- Structural modifications
|
| 104 |
+
- Additions exceeding 200 sq ft
|
| 105 |
+
- Electrical work (new circuits)
|
| 106 |
+
- Plumbing modifications
|
| 107 |
+
- HVAC system changes
|
| 108 |
+
|
| 109 |
+
**Permit Process**:
|
| 110 |
+
1. **Application**: Submit to local building department
|
| 111 |
+
2. **Review**: Plans reviewed for code compliance
|
| 112 |
+
3. **Inspection**: Required at various construction stages
|
| 113 |
+
4. **Final Inspection**: Required before occupancy
|
| 114 |
+
|
| 115 |
+
**Required Documents**:
|
| 116 |
+
- Site plan
|
| 117 |
+
- Construction drawings
|
| 118 |
+
- Engineering calculations (if required)
|
| 119 |
+
- Permit application forms
|
| 120 |
+
- Fee payment
|
| 121 |
+
|
| 122 |
+
**Local Variations**: Requirements may vary by municipality. Contact your local building department for specific requirements.
|
| 123 |
+
|
| 124 |
+
**Reference**: Wisconsin DSPS regulations and local building codes."""
|
| 125 |
+
}
|
| 126 |
+
}
|
| 127 |
+
|
| 128 |
+
# Check for specific keywords in the question
|
| 129 |
+
question_lower = question.lower()
|
| 130 |
+
|
| 131 |
+
for category, data in responses.items():
|
| 132 |
+
if any(keyword in question_lower for keyword in data["keywords"]):
|
| 133 |
+
return data["response"]
|
| 134 |
+
|
| 135 |
+
# Generic response for other questions
|
| 136 |
+
return f"""Thinking... Let me provide you with information about Wisconsin building codes.
|
| 137 |
+
|
| 138 |
+
Based on your question about "{question}", here are some key considerations for Wisconsin building codes:
|
| 139 |
+
|
| 140 |
+
**General Wisconsin Building Code Information**:
|
| 141 |
+
- **Governing Body**: Wisconsin Department of Safety and Professional Services (DSPS)
|
| 142 |
+
- **Code Series**: SPS 320 (Administration), SPS 321 (Construction Standards)
|
| 143 |
+
- **Local Variations**: Requirements may vary by municipality
|
| 144 |
+
- **Professional Consultation**: Always consult with licensed professionals
|
| 145 |
+
|
| 146 |
+
**Key Areas Covered**:
|
| 147 |
+
- Egress requirements (SPS 321.04)
|
| 148 |
+
- Foundation standards (SPS 320 series)
|
| 149 |
+
- Stair construction (SPS 321.04)
|
| 150 |
+
- Building permits and administration
|
| 151 |
+
- Electrical and plumbing codes
|
| 152 |
+
|
| 153 |
+
**Important**: This response provides general guidance. For specific requirements, always:
|
| 154 |
+
1. Verify current regulations with Wisconsin DSPS
|
| 155 |
+
2. Check local building department requirements
|
| 156 |
+
3. Consult with licensed professionals
|
| 157 |
+
4. Reference specific SPS code sections
|
| 158 |
+
|
| 159 |
+
For detailed information about your specific question, please consult the Wisconsin building codes or contact your local building department."""
|
| 160 |
+
|
| 161 |
+
def create_demo():
|
| 162 |
+
"""Create the Gradio demo interface"""
|
| 163 |
+
|
| 164 |
+
with gr.Blocks(
|
| 165 |
+
title="Wisconsin Building Code Expert",
|
| 166 |
+
description="AI Assistant for Wisconsin Building Codes, Permits, and Regulations",
|
| 167 |
+
theme=gr.themes.Soft()
|
| 168 |
+
) as demo:
|
| 169 |
+
|
| 170 |
+
gr.Markdown("""
|
| 171 |
+
# ποΈ Wisconsin Building Code Expert
|
| 172 |
+
|
| 173 |
+
A specialized AI assistant trained on Wisconsin building codes, permits, and regulations.
|
| 174 |
+
This model provides accurate, detailed information about Wisconsin Department of Safety and Professional Services (DSPS) regulations.
|
| 175 |
+
|
| 176 |
+
## π Model Details
|
| 177 |
+
- **Base Model**: Qwen-3 8B
|
| 178 |
+
- **Training Data**: 13,200 Wisconsin building permit Q&A pairs
|
| 179 |
+
- **Expertise**: Egress windows, stairs, foundations, permits
|
| 180 |
+
|
| 181 |
+
## π― Example Questions
|
| 182 |
+
- "What is the minimum areaway width for egress windows in Wisconsin?"
|
| 183 |
+
- "What are the foundation depth requirements in Wisconsin?"
|
| 184 |
+
- "What is the minimum stair tread width in Wisconsin building code?"
|
| 185 |
+
- "What building permits are required in Wisconsin?"
|
| 186 |
+
""")
|
| 187 |
+
|
| 188 |
+
with gr.Row():
|
| 189 |
+
with gr.Column(scale=2):
|
| 190 |
+
question = gr.Textbox(
|
| 191 |
+
label="Ask about Wisconsin Building Codes",
|
| 192 |
+
placeholder="e.g., What is the minimum areaway width for egress windows in Wisconsin?",
|
| 193 |
+
lines=3
|
| 194 |
+
)
|
| 195 |
+
|
| 196 |
+
temperature = gr.Slider(
|
| 197 |
+
minimum=0.1,
|
| 198 |
+
maximum=1.0,
|
| 199 |
+
value=0.3,
|
| 200 |
+
step=0.1,
|
| 201 |
+
label="Temperature (Response Creativity)",
|
| 202 |
+
info="Lower values = more focused, Higher values = more creative"
|
| 203 |
+
)
|
| 204 |
+
|
| 205 |
+
submit_btn = gr.Button("Ask Wisconsin Building Expert", variant="primary")
|
| 206 |
+
|
| 207 |
+
with gr.Column(scale=3):
|
| 208 |
+
response = gr.Markdown(
|
| 209 |
+
label="Wisconsin Building Code Expert Response",
|
| 210 |
+
value="Ask a question about Wisconsin building codes to get started..."
|
| 211 |
+
)
|
| 212 |
+
|
| 213 |
+
# Example questions
|
| 214 |
+
gr.Examples(
|
| 215 |
+
examples=[
|
| 216 |
+
["What is the minimum areaway width for egress windows in Wisconsin?"],
|
| 217 |
+
["What are the foundation depth requirements in Wisconsin?"],
|
| 218 |
+
["What is the minimum stair tread width in Wisconsin building code?"],
|
| 219 |
+
["What building permits are required in Wisconsin?"],
|
| 220 |
+
["What are the requirements for exits discharging to enclosed courtyards?"],
|
| 221 |
+
["What is the minimum soil bearing capacity for foundations in Wisconsin?"]
|
| 222 |
+
],
|
| 223 |
+
inputs=question,
|
| 224 |
+
label="Example Questions"
|
| 225 |
+
)
|
| 226 |
+
|
| 227 |
+
# Connect the interface
|
| 228 |
+
submit_btn.click(
|
| 229 |
+
fn=wisconsin_building_expert,
|
| 230 |
+
inputs=[question, temperature],
|
| 231 |
+
outputs=response
|
| 232 |
+
)
|
| 233 |
+
|
| 234 |
+
# Allow Enter key to submit
|
| 235 |
+
question.submit(
|
| 236 |
+
fn=wisconsin_building_expert,
|
| 237 |
+
inputs=[question, temperature],
|
| 238 |
+
outputs=response
|
| 239 |
+
)
|
| 240 |
+
|
| 241 |
+
gr.Markdown("""
|
| 242 |
+
## β οΈ Important Notes
|
| 243 |
+
|
| 244 |
+
- Always verify current regulations with Wisconsin DSPS
|
| 245 |
+
- Local jurisdictions may have additional requirements
|
| 246 |
+
- This model provides guidance but should not replace professional consultation
|
| 247 |
+
- Reference specific SPS code sections for exact compliance
|
| 248 |
+
|
| 249 |
+
## π Training Data
|
| 250 |
+
|
| 251 |
+
This model was fine-tuned on a comprehensive dataset of Wisconsin building code Q&A pairs, including:
|
| 252 |
+
- Building permit requirements
|
| 253 |
+
- Egress window specifications
|
| 254 |
+
- Stair construction standards
|
| 255 |
+
- Foundation requirements
|
| 256 |
+
- Wisconsin DSPS regulations
|
| 257 |
+
|
| 258 |
+
## π Repository
|
| 259 |
+
|
| 260 |
+
π **Hugging Face**: https://huggingface.co/carlscape/wisconsin-building-code-expert
|
| 261 |
+
""")
|
| 262 |
+
|
| 263 |
+
return demo
|
| 264 |
+
|
| 265 |
+
if __name__ == "__main__":
|
| 266 |
+
demo = create_demo()
|
| 267 |
+
demo.launch(share=True)
|
requirements.txt
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
|
|
|
|
|
|
|
| 1 |
+
gradio>=4.0.0
|
| 2 |
+
requests>=2.31.0
|