Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions COMPREHENSIVE_DEMO.py
Original file line number Diff line number Diff line change
Expand Up @@ -366,12 +366,12 @@ def main():
print(" 1. Run individual test scripts: python experiments/test_*.py")
print(" 2. Start API server: uvicorn src.agent_api:app --reload")
print(" 3. Process your own audio files")
print(" 4. Check documentation: README.md, SETUP_INSTRUCTIONS.md")
print(" 4. Check documentation: README.md, docs/SETUP_INSTRUCTIONS.md")
print("\n📚 Documentation locations:")
print(" - README.md - Full documentation")
print(" - SETUP_INSTRUCTIONS.md - Detailed setup guide")
print(" - QUICK_REFERENCE.md - Quick command reference")
print(" - DATA_MANAGEMENT_README.md - Data management guide")
print(" - docs/SETUP_INSTRUCTIONS.md - Detailed setup guide")
print(" - docs/QUICK_REFERENCE.md - Quick command reference")
print(" - docs/DATA_MANAGEMENT_SYSTEM.md - Data management guide")
print(" - docs/ - Component-specific docs")
print("\n🧪 Test scripts:")
print(" - experiments/test_baseline.py")
Expand Down
Binary file removed Project Planning.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions QUICK_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ experiments/test_*.py # Test scripts
experiments/kavya_evaluation_framework.py # Evaluation
requirements.txt # Dependencies
README.md # Full documentation
SETUP_INSTRUCTIONS.md # Detailed setup
docs/SETUP_INSTRUCTIONS.md # Detailed setup
```

## 🔑 Key Concepts
Expand Down Expand Up @@ -306,6 +306,6 @@ ls docs/

For detailed information, see:
- **README.md** - Full project documentation
- **SETUP_INSTRUCTIONS.md** - Detailed setup guide
- **docs/SETUP_INSTRUCTIONS.md** - Detailed setup guide
- **docs/** - Component-specific guides

30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ A production-ready, self-improving speech-to-text system with autonomous error d
- [Development Workflows](#development-workflows)
- [Testing](#testing)
- [Documentation](#documentation)
- [Tutorials](#tutorials)

## 🎯 Overview

Expand Down Expand Up @@ -107,9 +108,7 @@ Adaptive-Self-Learning-Agentic-AI-System/
├── requirements.txt # Python dependencies
├── README.md # This file
├── SETUP_INSTRUCTIONS.md # Detailed setup guide
├── WEEK1_DELIVERABLES_REPORT.md # Week 1 completion report
├── WEEK2_DELIVERABLES_REPORT.md # Week 2 completion report
├── docs/SETUP_INSTRUCTIONS.md # Detailed setup guide
└── docs/DATA_MANAGEMENT_SYSTEM.md # Data management guide
```

Expand Down Expand Up @@ -756,14 +755,33 @@ python scripts/monitor_gcp_costs.py

## 📚 Documentation

- **[SETUP_INSTRUCTIONS.md](SETUP_INSTRUCTIONS.md)** - Detailed setup guide
- **[docs/SETUP_INSTRUCTIONS.md](docs/SETUP_INSTRUCTIONS.md)** - Detailed setup guide
- **[docs/DATA_MANAGEMENT_SYSTEM.md](docs/DATA_MANAGEMENT_SYSTEM.md)** - Complete data management guide
- **[docs/QUICK_START_DATA_MANAGEMENT.md](docs/QUICK_START_DATA_MANAGEMENT.md)** - Quick start for data management
- **[docs/DATA_MANAGEMENT_SYSTEM.md](docs/DATA_MANAGEMENT_SYSTEM.md)** - Complete data management API
- **[docs/QUICK_START_DATA_MANAGEMENT.md](docs/QUICK_START_DATA_MANAGEMENT.md)** - Quick start for data management
- **[docs/GCP_SETUP_GUIDE.md](docs/GCP_SETUP_GUIDE.md)** - GCP setup instructions
- **[WEEK1_DELIVERABLES_REPORT.md](WEEK1_DELIVERABLES_REPORT.md)** - Week 1 completion report
- **[WEEK2_DELIVERABLES_REPORT.md](WEEK2_DELIVERABLES_REPORT.md)** - Week 2 completion report

## 🎥 Tutorials

### Complete System Overview Video

Watch our comprehensive tutorial video that covers everything you need to get started:

**[📹 Watch Complete Tutorial Video](docs/submission/Presentation_Demo_Tutorial.mp4)**

**What's included in the video:**
- 🎯 **Project Presentation** - Overview of the Adaptive Self-Learning Agentic AI System
- 🚀 **System Demo** - Live demonstration of transcription, error detection, and data management
- 🛠️ **Repository Setup** - Step-by-step guide to setting up the repository and dependencies
- 💡 **Key Features Walkthrough** - Deep dive into agent system, data management, and fine-tuning

### Additional Tutorial Resources

- **[docs/UI_TUTORIAL.md](docs/UI_TUTORIAL.md)** - Control Panel UI walkthrough
- **[docs/CONTROL_PANEL_GUIDE.md](docs/CONTROL_PANEL_GUIDE.md)** - Complete control panel guide
- **[docs/FINETUNING_QUICK_START.md](docs/FINETUNING_QUICK_START.md)** - Fine-tuning tutorial
- **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)** - Quick command reference

## 📊 Performance Metrics

Expand Down
Loading