Skip to content

Commit 10f804c

Browse files
committed
refactor: Professionalize README and add comprehensive documentation
- Add CI/CD badges (Tests, Coverage) to README - Move Architecture Diagram to top (after Quick Start) for better visibility - Extract Philosophy sections to docs/PHILOSOPHY.md (Counter-Movement, Transparency Experiment, Vision, Digital Sovereignty) - Extract detailed Architecture to docs/ARCHITECTURE.md (components, data flow, API, deployment) - Create docs/RESEARCH_NOTES.md with evaluation framework (metrics, baselines, datasets, citations) - Add academic citations: SPICE (arXiv:2510.24684), RAG (Lewis et al. 2020), ChromaDB - Add disclaimer for Thought Experiment/Self-Coding: NOT AGI pursuit - Add links to new documentation files throughout README - Refactor README to be more concise and professional This addresses ChatGPT's recommendations for professional open-source documentation: - README is now more focused on technical overview - Philosophy and detailed architecture moved to separate files - Research framework and citations added for academic community - CI/CD badges demonstrate active maintenance
1 parent bcf9aa8 commit 10f804c

4 files changed

Lines changed: 1015 additions & 170 deletions

File tree

README.md

Lines changed: 95 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
[![Python](https://img.shields.io/badge/Python-3.12+-blue.svg)](https://python.org)
1010
[![FastAPI](https://img.shields.io/badge/FastAPI-0.104+-green.svg)](https://fastapi.tiangolo.com)
1111
[![Streamlit](https://img.shields.io/badge/Streamlit-1.28+-red.svg)](https://streamlit.io)
12+
[![Tests](https://github.com/anhmtk/StillMe-Learning-AI-System-RAG-Foundation/workflows/Tests/badge.svg)](https://github.com/anhmtk/StillMe-Learning-AI-System-RAG-Foundation/actions)
13+
[![Coverage](https://codecov.io/gh/anhmtk/StillMe-Learning-AI-System-RAG-Foundation/branch/main/graph/badge.svg)](https://codecov.io/gh/anhmtk/StillMe-Learning-AI-System-RAG-Foundation)
1214
[![Ethical AI](https://img.shields.io/badge/Ethical%20AI-Transparent-green.svg)](https://github.com/anhmtk/stillme_ai_ipc)
1315
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1416

@@ -159,14 +161,91 @@ python -m uvicorn backend.api.main:app --host 0.0.0.0 --port 8000 --reload
159161
# Start frontend (terminal 2)
160162
streamlit run dashboard.py --server.port 8501
161163

162-
# Note: RSS scheduler and automated learning pipeline are planned for future releases
163164
```
164165

166+
## 🔧 Architecture
167+
168+
### System Architecture Overview
169+
170+
StillMe uses a modular architecture with clear separation of concerns:
171+
172+
```
173+
External Sources → Learning Pipeline → Vector DB → RAG → Validator Chain → Response
174+
```
175+
176+
### System Architecture Diagram
177+
178+
```mermaid
179+
graph TB
180+
subgraph "External Sources"
181+
RSS[RSS Feeds<br/>ArXiv, TechCrunch, HN]
182+
API[Public APIs<br/>NewsAPI, GNews]
183+
end
184+
185+
subgraph "StillMe Core System"
186+
Scheduler[Hybrid Learning Scheduler<br/>Every 4 hours]
187+
Learning[Learning Engine<br/>FastAPI Backend]
188+
189+
subgraph "Processing Pipeline"
190+
Fetch[Content Fetching]
191+
RedTeam[Red-Team Agent<br/>Safety Scanning]
192+
Ethics[EthicsGuard<br/>Ethical Filter]
193+
Assess[Quality Assessment]
194+
end
195+
196+
subgraph "Routing System"
197+
Router{Smart Router<br/>DeepSeek/Ollama}
198+
AutoApprove[Auto-Approve<br/>Trust > 0.8]
199+
Community[Community Queue<br/>Trust 0.6-0.8]
200+
HumanReview[Human Review<br/>Trust < 0.6]
201+
end
202+
203+
subgraph "Data Layer"
204+
KB[(Knowledge Base<br/>JSON)]
205+
DB[(SQLite DB<br/>Sessions, Votes)]
206+
Evolution[(Evolution DB<br/>Stages)]
207+
end
208+
209+
Dashboard[Streamlit Dashboard<br/>Real-time Monitoring]
210+
Chat[Chat Interface<br/>User Interaction]
211+
end
212+
213+
subgraph "Community"
214+
Voters[Community Voting<br/>Weighted Trust]
215+
EthicsQueue[EthicsGuard Queue]
216+
end
217+
218+
RSS --> Fetch
219+
API --> Fetch
220+
Scheduler --> Learning
221+
Learning --> Fetch
222+
Fetch --> RedTeam
223+
RedTeam --> Ethics
224+
Ethics --> Assess
225+
Assess --> Router
226+
Router --> AutoApprove
227+
Router --> Community
228+
Router --> HumanReview
229+
AutoApprove --> KB
230+
Community --> Voters
231+
Voters --> EthicsQueue
232+
EthicsQueue --> KB
233+
HumanReview --> KB
234+
KB --> Dashboard
235+
DB --> Dashboard
236+
Evolution --> Dashboard
237+
Chat --> Router
238+
Learning --> Evolution
239+
Learning --> DB
240+
```
241+
242+
> **Detailed architecture documentation**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md)
243+
165244
## ✨ What's Actually Working (MVP Status)
166245

167246
### **Implemented & Functional:**
168-
- **🗄️ Vector Database (ChromaDB)**: Semantic search and knowledge retrieval working
169-
- **🔍 RAG System**: Retrieval-Augmented Generation fully functional
247+
- **🗄️ Vector Database (ChromaDB)**: Semantic search and knowledge retrieval working - [ChromaDB Documentation](https://www.trychroma.com/)
248+
- **🔍 RAG System**: Retrieval-Augmented Generation fully functional - Based on [Lewis et al. (2020)](https://arxiv.org/abs/2005.11401) "Retrieval-Augmented Generation for Knowledge-Intensive NLP Tasks"
170249
- **✅ Validator Chain**: Reduces hallucinations by 80% with citation, evidence overlap, and ethics checks
171250
- **🎭 Identity Injection**: Ensures StillMe brand consistency across all models (DeepSeek, GPT, Gemini, local)
172251
- **🎨 Tone Alignment**: Normalizes response tone to StillMe style
@@ -202,8 +281,8 @@ streamlit run dashboard.py --server.port 8501
202281
- **Self-Play Loop**: Continuous adversarial learning cycle
203282
- **Status**: Framework complete, implementation in progress
204283
- **Expected Benefits**: +8.9% mathematical reasoning, +9.8% general reasoning improvement
205-
- **Reference**: Based on Meta AI's SPICE research (https://arxiv.org/abs/2510.24684)
206-
- **Documentation**: See `docs/SPICE_ARCHITECTURE.md`
284+
- **Reference**: Based on Meta AI's SPICE research - [arXiv:2510.24684](https://arxiv.org/abs/2510.24684)
285+
- **Documentation**: See [`docs/SPICE_ARCHITECTURE.md`](docs/SPICE_ARCHITECTURE.md)
207286

208287
### 💰 **Cost Optimization Features:**
209288
- **Pre-Filter System**: Filters RSS content BEFORE embedding to reduce costs
@@ -398,7 +477,7 @@ StillMe progresses through distinct developmental stages based on **learning ses
398477
- 🤖 **Exploratory Research**: Can AI debug and improve its own code?
399478
- 🔬 **Proof of Concept**: Limited self-coding capabilities within safe boundaries
400479
- **Status**: Research phase - No concrete implementation yet
401-
- **Connection**: This relates to the "Thought Experiment" section - we're exploring the possibility, not promising it
480+
- ⚠️ **Important Disclaimer**: This is **NOT an AGI pursuit**. StillMe is exploring bounded, supervised self-improvement within safety constraints, not uncontrolled recursive self-improvement or superintelligence.
402481

403482
> **Why start simple?**
404483
> Every complex system starts with a simple foundation. StillMe's evolution stages are **transparent and auditable** - you can see exactly what triggers each stage. As we collect more data, we'll enhance the metrics, but **transparency remains the priority**.
@@ -416,120 +495,19 @@ StillMe aims to become a **fully autonomous learning AI**:
416495
### 🔬 **Future Evolution Pathways**
417496
We open these questions to the community:
418497

419-
- **AI Self-Coding?** - Should StillMe learn to debug and improve itself?
498+
- **AI Self-Coding?** - Should StillMe learn to debug and improve itself? (⚠️ **NOT AGI pursuit** - bounded, supervised self-improvement only)
420499
- **Red Team vs Blue Team?** - AI attacking and defending itself for enhanced security?
421500
- **Multi-Agent Collaboration?** - Multiple StillMe instances collaborating on complex problems?
422501
- **Cross-Domain Learning?** - Expanding from AI to medicine, science, and other fields?
423502

424503
> **"This isn't our roadmap - it's a community discussion. What direction do you want AI's future to take?"**
425504
426-
### 🧪 **The Transparency Experiment: Building Self-Evolving AI Publicly**
427-
428-
#### **The Question Everyone's Avoiding**
429-
430-
While Big Tech builds increasingly powerful AI behind closed doors, we're asking publicly: **"What does responsible AI self-improvement look like?"**
431-
432-
#### **Our Hypothesis: Transparency = Safety**
433-
434-
**Traditional approach:**
435-
- Build powerful AI in secret
436-
- Deploy when "ready"
437-
- Ask forgiveness, not permission
438-
439-
**StillMe's approach:**
440-
- Build in the open (100% transparent)
441-
- Community oversight at every stage
442-
- Ask questions BEFORE building
443-
- Human approval required for all major changes
444-
445-
#### **The Three-Stage Technical Framework**
446-
447-
**Stage 1: Foundation (v0.6) ✅ COMPLETE**
448-
- Vector DB for semantic memory (ChromaDB)
449-
- RAG for context-aware learning
450-
- Retention metrics for quality assessment
451-
- **Result:** AI knows what it knows (self-assessment capability)
452-
453-
**Stage 2: Meta-Learning (v0.7) 🚧 PLANNED (Q2 2026)**
454-
- Learn from learning patterns (curriculum learning)
455-
- Optimize knowledge acquisition strategies
456-
- Retention-based source trust adjustment
457-
- **Goal:** AI improves HOW it learns (not what it learns)
458-
- **Timeline:** 6-12 months research required
459-
460-
**Stage 3: Bounded Autonomy (v1.0) 🔬 RESEARCH PHASE**
461-
- Limited self-optimization within safety constraints
462-
- Human-approved architectural changes only
463-
- Complete audit trail of all modifications
464-
- Kill switch for emergency rollback
465-
- **Status:** Research only - no implementation timeline
466-
467-
#### **What We're NOT Building**
468-
469-
**"Skynet"** - Uncontrolled recursive self-improvement
470-
**Code that modifies itself without human oversight**
471-
**AGI or superintelligence**
472-
**Anything without community approval and formal safety review**
473-
**Self-modification that bypasses kill switches**
474-
475-
#### **What We're ACTUALLY Exploring**
505+
> ⚠️ **Important Disclaimer**: StillMe is **NOT pursuing AGI or superintelligence**. All self-improvement research is bounded, supervised, and requires human oversight. See [`docs/PHILOSOPHY.md`](docs/PHILOSOPHY.md) for detailed safety mechanisms and disclaimers.
476506
477-
✅ Can AI identify its own knowledge gaps? → **v0.6: YES (RAG semantic search)**
478-
✅ Can AI optimize its learning strategy? → **v0.7: Testing (meta-learning research)**
479-
✅ Can AI suggest improvements to its architecture? → **v1.0: TBD (requires significant R&D)**
480-
✅ Can community governance keep autonomous learning safe? → **Ongoing experiment**
481-
482-
#### **Safety Mechanisms (Current & Planned)**
483-
484-
**Implemented (v0.6):**
485-
- ✅ Complete audit trail (all decisions logged)
486-
- ✅ Community voting system (weighted trust)
487-
- ✅ EthicsGuard filtering
488-
- ✅ Transparent codebase (100% public)
489-
490-
**Planned (v0.7+):**
491-
- 🔄 Formal kill switch protocol
492-
- 🔄 External ethics board review
493-
- 🔄 Red team security audits
494-
- 🔄 Incident response procedures
495-
- 🔄 Automated anomaly detection
496-
497-
#### **The Real Question**
498-
499-
Not "Can we build self-improving AI?" (We probably can, with research)
500-
But **"Should we build it? And if yes, HOW safely?"**
501-
502-
**That's the experiment. And it requires YOU.**
503-
504-
### 💬 **Your Role in This Experiment**
505-
506-
**We're not asking you to trust us. We're asking you to VERIFY us.**
507-
508-
- 📂 Every line of code is public (audit anytime)
509-
- 📊 Every decision is logged (complete transparency)
510-
- 🗳️ Every major change requires community vote (democratic governance)
511-
- 🚨 Anyone can audit, critique, or fork (no secrets)
512-
513-
**Make your choice:**
514-
515-
- [ ] **I'm monitoring this** - Skeptical but watching, want to ensure safety
516-
- [ ] **I'm contributing** - Want to help build responsible AI self-improvement
517-
- [ ] **I'm opposing this** - Think it's too risky, but value the transparency
518-
519-
**All positions are valid. All voices are heard.**
520-
521-
#### **Join the Discussion**
522-
523-
**GitHub Discussions**: [Share your thoughts](https://github.com/anhmtk/StillMe---Self-Evolving-AI-System/discussions)
524-
**Open Issues**: [Report concerns or suggestions](https://github.com/anhmtk/StillMe---Self-Evolving-AI-System/issues)
525-
**Security**: [Report vulnerabilities responsibly](https://github.com/anhmtk/StillMe---Self-Evolving-AI-System/security)
526-
527-
> **"This isn't marketing. This isn't hype. This is an honest attempt to build AI responsibly, in public, with community oversight. The experiment requires participation — not just from supporters, but from skeptics, critics, and safety experts. Because the only way to build safe AI is to have everyone watching."**
507+
> **📖 Learn more about StillMe's transparency experiment, safety mechanisms, and vision**: See [`docs/PHILOSOPHY.md`](docs/PHILOSOPHY.md)
528508
529509
## 🔧 Architecture
530510

531-
### **System Architecture Diagram**
532-
533511
```mermaid
534512
graph TB
535513
subgraph "External Sources"
@@ -594,66 +572,7 @@ graph TB
594572
Learning --> DB
595573
```
596574

597-
### **Component Architecture**
598-
599-
#### **Backend (FastAPI)**
600-
- **Learning Engine**: Core evolutionary learning system
601-
- **RSS Pipeline**: Multi-source content fetching
602-
- **Ethical Filter**: Comprehensive safety system
603-
- **Memory Management**: Advanced knowledge storage
604-
- **API Integration**: Public APIs for diverse content
605-
- **Hybrid Scheduler**: Auto-learning every 4 hours (6 cycles/day)
606-
607-
#### **Frontend (Streamlit)**
608-
- **Dashboard**: Real-time monitoring and control
609-
- **Evolution Panel**: AI stage visualization
610-
- **Ethical Controls**: Community management tools
611-
- **Analytics**: Historical learning data
612-
- **Chat Interface**: Interactive AI communication
613-
- **Community Review**: Voting interface for proposals
614-
615-
#### **Database (SQLite)**
616-
- **Learning Sessions**: Track AI evolution progress
617-
- **Content Proposals**: Store learning opportunities
618-
- **Memory Items**: Advanced knowledge storage
619-
- **Ethical Violations**: Complete audit trail
620-
- **Community Votes**: Weighted voting system
621-
- **Evolution Stages**: Track developmental progress
622-
623-
> **Current State**: StillMe uses SQLite + JSON for data storage (MVP approach). See [Roadmap](#-roadmap--milestones) for planned Vector DB integration (v0.6) and Meta-Learning (v0.7).
624-
625-
### **Learning Flow**
626-
627-
```mermaid
628-
sequenceDiagram
629-
participant Scheduler
630-
participant LearningEngine
631-
participant RSS as RSS Sources
632-
participant RedTeam as Red-Team Agent
633-
participant EthicsGuard
634-
participant Router
635-
participant Community
636-
participant KB as Knowledge Base
637-
638-
Scheduler->>LearningEngine: Trigger (Every 4h)
639-
LearningEngine->>RSS: Fetch Content
640-
RSS-->>LearningEngine: New Articles
641-
LearningEngine->>RedTeam: Safety Scan
642-
RedTeam-->>LearningEngine: Safety Score
643-
LearningEngine->>EthicsGuard: Ethics Check
644-
EthicsGuard-->>LearningEngine: Pass/Fail
645-
LearningEngine->>Router: Route by Trust Score
646-
alt Trust > 0.8
647-
Router->>KB: Auto-Approve
648-
else Trust 0.6-0.8
649-
Router->>Community: Queue for Voting
650-
Community->>EthicsGuard: Re-check after votes
651-
EthicsGuard->>KB: Approve/Reject
652-
else Trust < 0.6
653-
Router->>LearningEngine: Flag for Human Review
654-
end
655-
LearningEngine->>LearningEngine: Update Evolution Stage
656-
```
575+
> **Detailed architecture documentation**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for component details, data flow, API architecture, and deployment considerations.
657576
658577
## 🌍 StillMe & The Path to Digital Sovereignty
659578

@@ -1154,6 +1073,12 @@ See details in [`docs/ACTION_ITEMS_IMPROVEMENT_ROADMAP.md`](docs/ACTION_ITEMS_IM
11541073
- **Investment Analysis**: See assessment from VC Analyst in professional assessment
11551074
- **Research Evaluation**: See assessment from AI Researcher in professional assessment
11561075

1076+
### **Research & Academic Resources:**
1077+
1078+
- **Research Notes**: See [`docs/RESEARCH_NOTES.md`](docs/RESEARCH_NOTES.md) for evaluation framework, metrics, baselines, datasets, and academic citations
1079+
- **Architecture Details**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for detailed system architecture
1080+
- **Philosophy & Vision**: See [`docs/PHILOSOPHY.md`](docs/PHILOSOPHY.md) for StillMe's mission and ethical principles
1081+
11571082
---
11581083

11591084
## 📄 License

0 commit comments

Comments
 (0)