Updated README to have appropriate tags and thumbnail also added
Browse files
README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
| 1 |
---
|
| 2 |
-
title: interview-coach
|
| 3 |
emoji: ποΈ
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: red
|
|
@@ -10,100 +10,107 @@ pinned: false
|
|
| 10 |
python_version: '3.10'
|
| 11 |
license: mit
|
| 12 |
short_description: AI Interview Coach
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
---
|
| 14 |
-
|
| 15 |
-
# ποΈ AI Interview Coach β Version Alpha
|
| 16 |
-
|
| 17 |
-
An AI-powered interview preparation tool built with **Gradio** and **Mistral 7B** via the HuggingFace Inference API.
|
| 18 |
-
|
| 19 |
-
> Built for the **HuggingFace Hackathon 2026** β Gradio on HF Spaces.
|
| 20 |
-
|
| 21 |
-
---
|
| 22 |
-
|
| 23 |
-
## Features
|
| 24 |
-
|
| 25 |
-
- π **Two-stage job description validation** β blocks spam and prompt injection
|
| 26 |
-
- ποΈ **3 interview modes** β Quick (3Q), Standard (5Q), Deep Dive (7Q)
|
| 27 |
-
- π€ **Adaptive questions** β tailored to industry, role level, and detected keywords
|
| 28 |
-
- π **Keyword-aware scoring** β answers scored against job-specific expected terms
|
| 29 |
-
- π **Keyword coverage badges** β see exactly which terms you hit and missed
|
| 30 |
-
- π‘ **AI-generated Prep Sheet** β works for ANY industry (not just tech)
|
| 31 |
-
- π **Timestamped PDF report** β downloadable session summary
|
| 32 |
-
- π¨ **Premium dark UI** β glassmorphism, animated blobs, Inter font
|
| 33 |
-
|
| 34 |
-
---
|
| 35 |
-
|
| 36 |
-
## Quick Start (Local)
|
| 37 |
-
|
| 38 |
-
### 1. Clone and set up environment
|
| 39 |
-
|
| 40 |
-
```bash
|
| 41 |
-
cd HF_Hackathon
|
| 42 |
-
python -m venv .venv
|
| 43 |
-
.venv\Scripts\activate # Windows
|
| 44 |
-
# source .venv/bin/activate # Mac/Linux
|
| 45 |
-
pip install -r requirements.txt
|
| 46 |
-
```
|
| 47 |
-
|
| 48 |
-
### 2. Set your HuggingFace token
|
| 49 |
-
|
| 50 |
-
```bash
|
| 51 |
-
# Copy the example and fill in your token
|
| 52 |
-
copy .env.example .env
|
| 53 |
-
# Edit .env and replace hf_PASTE_YOUR_TOKEN_HERE with your actual token
|
| 54 |
-
```
|
| 55 |
-
|
| 56 |
-
Get a free token at: https://huggingface.co/settings/tokens
|
| 57 |
-
Required permission: **Inference** (read)
|
| 58 |
-
|
| 59 |
-
### 3. Run
|
| 60 |
-
|
| 61 |
-
```bash
|
| 62 |
-
python interview_coach.py
|
| 63 |
-
```
|
| 64 |
-
|
| 65 |
-
Open http://localhost:7860
|
| 66 |
-
|
| 67 |
-
---
|
| 68 |
-
|
| 69 |
-
## HuggingFace Spaces Deployment
|
| 70 |
-
|
| 71 |
-
1. Push this repo to your HF Space (Gradio SDK)
|
| 72 |
-
2. Go to **Settings β Secrets** and add `HF_TOKEN` = your token
|
| 73 |
-
3. The app starts automatically β no other changes needed
|
| 74 |
-
|
| 75 |
-
---
|
| 76 |
-
|
| 77 |
-
## Architecture
|
| 78 |
-
|
| 79 |
-
```
|
| 80 |
-
interview_coach.py β Gradio UI (pure layout + event wiring)
|
| 81 |
-
engine.py β Orchestration (LLM client, session, PDF)
|
| 82 |
-
config.py β All constants, CSS design system
|
| 83 |
-
agents/
|
| 84 |
-
validator.py β 3-stage JD validation + profile extraction
|
| 85 |
-
question_gen.py β Adaptive question generation
|
| 86 |
-
scorer.py β Keyword-aware answer scoring (Agenda #4)
|
| 87 |
-
```
|
| 88 |
-
|
| 89 |
-
---
|
| 90 |
-
|
| 91 |
-
## Model
|
| 92 |
-
|
| 93 |
-
- **Model:** `mistralai/Mistral-7B-Instruct-v0.3`
|
| 94 |
-
- **Parameters:** 7B (within HF Hackathon β€32B limit)
|
| 95 |
-
- **Inference:** HuggingFace Serverless Inference API (free tier)
|
| 96 |
-
- **Local fallback:** Ollama (`mistral:7b`) if no HF token is set
|
| 97 |
-
|
| 98 |
-
---
|
| 99 |
-
|
| 100 |
-
## Scoring System
|
| 101 |
-
|
| 102 |
-
| Score | Meaning |
|
| 103 |
-
|-------|---------|
|
| 104 |
-
| 8β10 | Excellent β strong STAR structure + good keyword coverage |
|
| 105 |
-
| 5β7 | Good β missing key terms or depth |
|
| 106 |
-
| 1β4 | Needs work β expand and use role-specific language |
|
| 107 |
-
| NIL | Irrelevant response |
|
| 108 |
-
|
| 109 |
**Keyword Coverage Rule:** < 40% of expected keywords β score capped at 5/10.
|
|
|
|
| 1 |
---
|
| 2 |
+
title: ai-interview-coach
|
| 3 |
emoji: ποΈ
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: red
|
|
|
|
| 10 |
python_version: '3.10'
|
| 11 |
license: mit
|
| 12 |
short_description: AI Interview Coach
|
| 13 |
+
tags:
|
| 14 |
+
- track:backyard
|
| 15 |
+
- achievement:offgrid
|
| 16 |
+
- achievement:offbrand
|
| 17 |
+
- achievement:fieldnotes
|
| 18 |
+
thumbnail: >-
|
| 19 |
+
https://cdn-uploads.huggingface.co/production/uploads/686f49a3a31e9a517952dd0c/HfuMUE233jLKwNgjefSmy.png
|
| 20 |
---
|
| 21 |
+
|
| 22 |
+
# ποΈ AI Interview Coach β Version Alpha
|
| 23 |
+
|
| 24 |
+
An AI-powered interview preparation tool built with **Gradio** and **Mistral 7B** via the HuggingFace Inference API.
|
| 25 |
+
|
| 26 |
+
> Built for the **HuggingFace Hackathon 2026** β Gradio on HF Spaces.
|
| 27 |
+
|
| 28 |
+
---
|
| 29 |
+
|
| 30 |
+
## Features
|
| 31 |
+
|
| 32 |
+
- π **Two-stage job description validation** β blocks spam and prompt injection
|
| 33 |
+
- ποΈ **3 interview modes** β Quick (3Q), Standard (5Q), Deep Dive (7Q)
|
| 34 |
+
- π€ **Adaptive questions** β tailored to industry, role level, and detected keywords
|
| 35 |
+
- π **Keyword-aware scoring** β answers scored against job-specific expected terms
|
| 36 |
+
- π **Keyword coverage badges** β see exactly which terms you hit and missed
|
| 37 |
+
- π‘ **AI-generated Prep Sheet** β works for ANY industry (not just tech)
|
| 38 |
+
- π **Timestamped PDF report** β downloadable session summary
|
| 39 |
+
- π¨ **Premium dark UI** β glassmorphism, animated blobs, Inter font
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
## Quick Start (Local)
|
| 44 |
+
|
| 45 |
+
### 1. Clone and set up environment
|
| 46 |
+
|
| 47 |
+
```bash
|
| 48 |
+
cd HF_Hackathon
|
| 49 |
+
python -m venv .venv
|
| 50 |
+
.venv\Scripts\activate # Windows
|
| 51 |
+
# source .venv/bin/activate # Mac/Linux
|
| 52 |
+
pip install -r requirements.txt
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
### 2. Set your HuggingFace token
|
| 56 |
+
|
| 57 |
+
```bash
|
| 58 |
+
# Copy the example and fill in your token
|
| 59 |
+
copy .env.example .env
|
| 60 |
+
# Edit .env and replace hf_PASTE_YOUR_TOKEN_HERE with your actual token
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
Get a free token at: https://huggingface.co/settings/tokens
|
| 64 |
+
Required permission: **Inference** (read)
|
| 65 |
+
|
| 66 |
+
### 3. Run
|
| 67 |
+
|
| 68 |
+
```bash
|
| 69 |
+
python interview_coach.py
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
Open http://localhost:7860
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## HuggingFace Spaces Deployment
|
| 77 |
+
|
| 78 |
+
1. Push this repo to your HF Space (Gradio SDK)
|
| 79 |
+
2. Go to **Settings β Secrets** and add `HF_TOKEN` = your token
|
| 80 |
+
3. The app starts automatically β no other changes needed
|
| 81 |
+
|
| 82 |
+
---
|
| 83 |
+
|
| 84 |
+
## Architecture
|
| 85 |
+
|
| 86 |
+
```
|
| 87 |
+
interview_coach.py β Gradio UI (pure layout + event wiring)
|
| 88 |
+
engine.py β Orchestration (LLM client, session, PDF)
|
| 89 |
+
config.py β All constants, CSS design system
|
| 90 |
+
agents/
|
| 91 |
+
validator.py β 3-stage JD validation + profile extraction
|
| 92 |
+
question_gen.py β Adaptive question generation
|
| 93 |
+
scorer.py β Keyword-aware answer scoring (Agenda #4)
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
---
|
| 97 |
+
|
| 98 |
+
## Model
|
| 99 |
+
|
| 100 |
+
- **Model:** `mistralai/Mistral-7B-Instruct-v0.3`
|
| 101 |
+
- **Parameters:** 7B (within HF Hackathon β€32B limit)
|
| 102 |
+
- **Inference:** HuggingFace Serverless Inference API (free tier)
|
| 103 |
+
- **Local fallback:** Ollama (`mistral:7b`) if no HF token is set
|
| 104 |
+
|
| 105 |
+
---
|
| 106 |
+
|
| 107 |
+
## Scoring System
|
| 108 |
+
|
| 109 |
+
| Score | Meaning |
|
| 110 |
+
|-------|---------|
|
| 111 |
+
| 8β10 | Excellent β strong STAR structure + good keyword coverage |
|
| 112 |
+
| 5β7 | Good β missing key terms or depth |
|
| 113 |
+
| 1β4 | Needs work β expand and use role-specific language |
|
| 114 |
+
| NIL | Irrelevant response |
|
| 115 |
+
|
| 116 |
**Keyword Coverage Rule:** < 40% of expected keywords β score capped at 5/10.
|