Skip to content

Commit 821f9dc

Browse files
committed
docs: update README with comprehensive documentation links
Update README to reflect Phase 2+ implementation status: - Add documentation section with links to all guides: * ADVANCED_FEATURES.md - Usage guide for reservoir, MLP, SNN * DEPLOYMENT.md - Platform deployment instructions * PERFORMANCE.md - Optimization techniques * AUTONOMOUS_DEVELOPMENT_SUMMARY.md - Development summary - Update phase status to show implemented features: * Mark Phase 2+ features as completed (reservoir, MLP, SNN) * Show current stats: 69+ tests, 7,500+ lines, 10 modules * Reorganize future phases based on integration needs - Add examples section with runnable demonstrations - Add benchmarks section This provides users with clear navigation to all project documentation and accurately reflects current implementation status.
1 parent 4fc04b3 commit 821f9dc

1 file changed

Lines changed: 53 additions & 16 deletions

File tree

README.md

Lines changed: 53 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ See [claude.md](claude.md) for comprehensive architecture documentation.
9595
| **Context Manager** | Conversation state | `src/context.rs` |
9696
| **Orchestrator** | Main coordinator | `src/orchestrator.rs` |
9797

98-
## Phase 1 MVP (Current)
98+
## Phase 1 MVP (Implemented)
9999

100100
✅ Expert system (rule-based safety)
101101
✅ Heuristic router (keyword-based routing)
@@ -104,22 +104,34 @@ See [claude.md](claude.md) for comprehensive architecture documentation.
104104
✅ CLI interface
105105
✅ Comprehensive tests (>90% coverage)
106106

107-
## Future Phases
107+
## Phase 2+ Features (Implemented)
108+
109+
**Reservoir Computing** - Echo State Networks for temporal context compression
110+
**Neural Routing** - Multi-Layer Perceptron for learned routing decisions
111+
**Spiking Neural Networks** - Event-driven wake detection (ultra-low power)
112+
**Benchmarking Suite** - Performance profiling with Criterion
113+
**Example Applications** - Runnable demonstrations of all features
108114

109-
**Phase 2: Memory & Context** (Weeks 5-8)
110-
- Reservoir computing (liquid state machines)
111-
- RAG system (document retrieval)
112-
- Knowledge graph (project relationships)
115+
**Stats**: 69+ tests, 7,500+ lines of code, 10 modules
113116

114-
**Phase 3: Specialization** (Weeks 9-12)
115-
- Mixture of Experts (specialized models)
116-
- Bayesian decision engine
117-
- Background monitoring
117+
See [AUTONOMOUS_DEVELOPMENT_SUMMARY.md](AUTONOMOUS_DEVELOPMENT_SUMMARY.md) for details.
118+
119+
## Future Phases
118120

119-
**Phase 4: Advanced** (Months 4+)
120-
- Spiking neural networks
121-
- Reinforcement learning
122-
- On-device training
121+
**Phase 3: Integration & Training**
122+
- [ ] Integrate MLP with router (replace heuristics)
123+
- [ ] Replace bag-of-words with sentence-transformers
124+
- [ ] Train reservoir on real conversation data
125+
- [ ] Deploy SNN on DSP/NPU hardware
126+
127+
**Phase 4: Advanced Features**
128+
- [ ] Mixture of Experts (specialized models)
129+
- [ ] Bayesian decision engine
130+
- [ ] SQLite persistence
131+
- [ ] RAG system (document retrieval)
132+
- [ ] Knowledge graph (project relationships)
133+
- [ ] On-device fine-tuning
134+
- [ ] Reinforcement learning from user feedback
123135

124136
## Development
125137

@@ -163,12 +175,37 @@ just validate
163175

164176
### Documentation
165177

178+
**Core Documentation:**
179+
- [claude.md](claude.md) - Comprehensive architecture (10,000+ words)
180+
- [AUTONOMOUS_DEVELOPMENT_SUMMARY.md](AUTONOMOUS_DEVELOPMENT_SUMMARY.md) - Development progress and features
181+
182+
**Usage Guides:**
183+
- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Reservoir computing, MLP routing, SNN wake detection
184+
- [DEPLOYMENT.md](DEPLOYMENT.md) - Platform deployment (Android, iOS, Linux mobile)
185+
- [PERFORMANCE.md](PERFORMANCE.md) - Optimization techniques for constrained devices
186+
187+
**Examples:**
188+
```bash
189+
# Run basic usage example
190+
cargo run --example basic_usage
191+
192+
# Reservoir computing demo
193+
cargo run --example reservoir_demo
194+
195+
# MLP router demonstration
196+
cargo run --example mlp_router
197+
```
198+
199+
**API Documentation:**
166200
```bash
167201
# Generate API documentation
168202
cargo doc --open
203+
```
169204

170-
# Read architecture docs
171-
cat claude.md
205+
**Benchmarks:**
206+
```bash
207+
# Run performance benchmarks
208+
cargo bench
172209
```
173210

174211
## RSR Compliance

0 commit comments

Comments
 (0)