HOME / README.md
syedazah777's picture
Update README.md
f07733d verified
|
Raw
History Blame Contribute Delete
4.26 kB
---
title: Home
emoji: ๐Ÿ†
colorFrom: yellow
colorTo: green
sdk: gradio
sdk_version: 5.49.1
app_file: app.py
pinned: false
tags:
- build-small
- thousand-token-wood
- best-agent
- off-brand
- codex
---
# ๐Ÿก Home โ€” AI Memory House
**Home** is an interactive AI-powered memory house built for the *Build Small Hackathon*.
Instead of a traditional chatbot, Home turns AI into a **living environment you can explore** โ€” rooms, memories, ambience, and emotional interaction all combined.
---
## โœจ Live Demo
๐Ÿ”— Hugging Face Space:
**[๐Ÿ‘‰ Open Home App](https://huggingface.co/spaces/build-small-hackathon/HOME)**
๐ŸŽฅ Demo Video:
**[โ–ถ Watch Demo Video](https://youtu.be/oanGVNQuduE)**
## ๐Ÿ“ข Social Media Post
๐Ÿ”— X (Twitter) Post:
https://x.com/syedaalizah6/status/2066236561163968796?s=20
๐Ÿ“ธ Screenshots:
### ๐Ÿ  Landing / Entrance
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/m9BkJ9xim1A6j2Oyl4YOs.png)
### ๐Ÿณ Kitchen (Mom Chat Experience)
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/dQSGP_dgcbk1q6XoMVywG.png)
### ๐Ÿ”ฅ Ambience Controls (Rain / Fire / Forest)
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/wecnPnOcHKEdghVKJ2Zqy.png)
### ๐Ÿฑ Memory Discovery (Cat + Letter System)
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/lKJ2WxRSpPIr_CNyW5bq2.png)
### ๐Ÿง  Memory Hallway
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/e3BjatsRIwigtBR6dotyV.png)
### ๐ŸŒฟ Garden Scene
![image](https://cdn-uploads.huggingface.co/production/uploads/67b1b1722ddc61229ecd67d8/UjhnYj4oki6tTCjN-V0yO.png)
---
## ๐Ÿง  Concept
Home reimagines AI not as a chatbot, but as a **space with memory and personality**.
Each room behaves differently:
* ๐Ÿณ Kitchen โ†’ Conversational AI (Mom persona)
* ๐Ÿ”ฅ Ambience System โ†’ Emotional environment control
* ๐Ÿฑ Cat Interaction โ†’ Random memory discovery events
* ๐Ÿ“œ Letters โ†’ Story fragments hidden in the house
* ๐Ÿง  Hallway โ†’ Persistent memory archive
* ๐ŸŒฟ Garden โ†’ Reflection space / ending area
---
## ๐Ÿค– Active Model
* Runtime Provider: **Groq**
* Model: `llama-3.1-8b-instant`
* HF Reference: `meta-llama/Llama-3.1-8B-Instruct`
* Parameters: **8B**
* โœ” Under Build Small limit (โ‰ค32B)
* โœ” Open-weight model
No proprietary cloud models are used.
Fallback system:
* Local deterministic โ€œMom responsesโ€ only (non-AI fallback)
---
## ๐Ÿ—๏ธ Architecture
* `app.py` โ†’ Gradio backend + API layer
* `dist/` โ†’ React + Vite frontend (house UI)
* `public/` โ†’ audio + video + assets
* Hugging Face Space โ†’ deployment host
Frontend is embedded inside Gradio using iframe-style mounting.
---
## ๐Ÿงช Key Features
* ๐Ÿก Multi-room interactive UI
* ๐Ÿ’ฌ Emotional AI chat (Mom persona)
* ๐ŸŒฆ๏ธ Dynamic ambience system
* ๐Ÿฑ Event-based storytelling (cat + letters)
* ๐Ÿง  Persistent memory hallway
* ๐ŸŽฎ Game-like exploration flow
---
## ๐Ÿš€ Codex Contribution
Codex was used in multiple development commits across this repository including UI integration, deployment fixes, and refactoring. These changes are reflected in git history.
Codex was used for:
* Gradio integration cleanup
* Build Small compliance fixes (โ‰ค32B rule)
* Hugging Face Space deployment fixes
* Repo restructuring + debugging
* UI + backend integration support
---
## ๐Ÿ› ๏ธ Local Setup
```bash
pip install -r requirements.txt
npm install
npm run build
python app.py
```
Set environment:
```
GROQ_API_KEY=your_key_here
```
---
## ๐Ÿ† Build Small Hackathon Tags
* Thousand Token Wood (Whimsical AI experience)
* Best Agent (stateful AI house system)
* Off Brand (custom UI beyond default Gradio)
* Codex (AI-assisted development workflow)
---
## ๐Ÿ“Œ Notes
* Fully compliant with โ‰ค32B parameter rule
* Uses only open-weight model (LLaMA 3.1 8B)
* No restricted API dependency required for core functionality
Note: This project targets Build Small โ€œThousand Token Woodโ€ + โ€œBest Agentโ€ categories and does not target Tiny Titan.
---
## ๐ŸŒŸ Vision
> โ€œHome is not a tool. It is a place that remembers you.โ€