synhack / README.md
TusharsinghBaghel's picture
Upload 4 files
f083f90 verified
---
title: Architecture Evaluator LLM
emoji: ๐Ÿ—๏ธ
colorFrom: blue
colorTo: green
sdk: docker
pinned: false
---
# Architecture Evaluator LLM
An AI-powered system design architecture evaluator using **Groq's FREE ultra-fast inference** with advanced reasoning models.
## Features
- ๐Ÿš€ **FREE** - Uses Groq's free API (no costs!)
- โšก **FAST** - Groq provides blazing-fast inference
- ๐Ÿง  **Smart** - DeepSeek R1 reasoning model for deep analysis
- Evaluates system design architectures based on multiple heuristics
- Provides detailed suggestions and recommendations
- Returns structured JSON responses
- Easy to integrate with any frontend
## API Endpoints
### POST /evaluate
Evaluates a system architecture.
**Request Body:**
```json
{
"question": "Your question or context about the architecture",
"architecture": {
// Your architecture JSON with components and links
}
}
```
**Response:**
```json
{
"heuristic_scores": {
"DURABILITY": 8.5,
"AVAILABILITY": 9.0,
"ENERGY_EFFICIENCY": 7.5,
"CONSISTENCY": 8.0,
"MAINTAINABILITY": 7.0,
"LATENCY": 8.5,
"COST": 6.5,
"SECURITY": 8.0,
"THROUGHPUT": 8.5,
"SCALABILITY": 9.0
},
"suggestion": "Your architecture shows strong scalability..."
}
```
## Environment Variables
- `GROQ_API_KEY`: Your Groq API key (required - get free at https://console.groq.com)
- `MODEL_NAME`: Model to use (default: deepseek-r1-distill-llama-70b)
- Available models:
- `deepseek-r1-distill-llama-70b` - Best reasoning (default)
- `llama-3.3-70b-versatile` - Great all-rounder
- `llama-3.1-70b-versatile` - Fast and capable
## Getting Your Free Groq API Key
1. Go to https://console.groq.com
2. Sign up for a free account
3. Navigate to API Keys section
4. Create a new API key
5. Copy and use it (completely FREE!)