Reference¶
Technical reference documentation for WakeBuilder.
In This Section¶
-
Project Structure
Complete directory and file structure reference.
-
Scripts Reference
Available utility scripts and their usage.
-
API Endpoints
REST API and WebSocket endpoint documentation.
-
Data Formats
File formats, schemas, and data structures.
Quick Reference¶
Key Paths¶
| Path | Purpose |
|---|---|
src/wakebuilder/ | Main source code |
frontend/ | Web interface |
models/ | Trained models |
data/ | Training data |
tts_voices/ | TTS voice models |
scripts/ | Utility scripts |
tests/ | Test suite |
Key Files¶
| File | Purpose |
|---|---|
src/wakebuilder/config.py | Configuration settings |
src/wakebuilder/backend/main.py | API entry point |
src/wakebuilder/models/trainer.py | Training pipeline |
src/wakebuilder/models/classifier.py | Model architecture |
run.py | Setup and run script |
pyproject.toml | Project metadata |
API Base URL¶
Documentation URLs¶
| URL | Description |
|---|---|
/docs | Swagger UI |
/redoc | ReDoc |
/openapi.json | OpenAPI schema |
/health | Health check |
/api/info | System info |