Back to Ruflo

ReasoningBank Models - Complete Index

v2/docs/reasoningbank/models/INDEX.md

3.6.3010.1 KB
Original Source

ReasoningBank Models - Complete Index

📚 Quick Navigation

DocumentDescriptionAudience
README.mdModel overview and quick startEveryone
HOW-TO-USE.mdInstallation and usage guideUsers
HOW-TO-TRAIN.mdCreate your own modelsDevelopers
_docs/Technical documentationDevelopers
_scripts/Utility scriptsDevelopers

🎯 Models

ModelPatternsBest ForDirectory
SAFLA2,000Self-learning systemssafla/
Google Research3,000Research best practicesgoogle-research/
Code Reasoning2,500Software developmentcode-reasoning/
Problem Solving2,000General reasoningproblem-solving/
Domain Expert1,500Technical expertisedomain-expert/

📖 Documentation by Topic

Getting Started

  1. Quick Start (30 seconds)
  2. Choose Your Model
  3. Install Model
  4. First Query

Using Models

  1. Installation Methods - 4 ways to install
  2. Model Selection Guide - Which model for what?
  3. Usage Examples - CLI, JavaScript, Python
  4. Integration Patterns - With agentic-flow, Claude Code
  5. Troubleshooting - Common issues

Training Models

  1. Quick Start Training - 100 patterns in minutes
  2. Training Architecture - How it works
  3. Step-by-Step Guide - Complete walkthrough
  4. Benchmarking & Validation - Quality assurance
  5. Advanced Techniques - Parallel training, merging

Tools & Scripts

ScriptPurposeUsage
schema-validator.cjsValidate/fix database schemanode _scripts/schema-validator.cjs <db> fix
validation-suite.cjsComprehensive quality checksnode _scripts/validation-suite.cjs <model> <name>
benchmark-all.cjsPerformance benchmarksnode _scripts/benchmark-all.cjs
training-coordinator.cjsMulti-agent trainingUsed by training agents

See _scripts/README.md for detailed documentation.

🎓 Tutorials

Tutorial 1: Install and Use a Model (5 minutes)

bash
# 1. Choose model
cd /workspaces/claude-code-flow/docs/reasoningbank/models/safla

# 2. Copy to claude-flow
cp memory.db ~/.swarm/memory.db

# 3. Try it
npx claude-flow@alpha memory query "API optimization best practices"

Tutorial 2: Merge Multiple Models (10 minutes)

See HOW-TO-USE.md - Method 2: Merge Multiple Models

Tutorial 3: Create Custom Model (30 minutes)

See HOW-TO-TRAIN.md - Create a Simple Model

Tutorial 4: Integrate with Agentic-Flow (15 minutes)

See HOW-TO-USE.md - Pattern 1: Agentic-Flow Integration

📊 Model Details

SAFLA (Self-Aware Feedback Loop Algorithm)

Pattern Categories:

  • Self-learning patterns (400)
  • Feedback loop optimization (400)
  • Confidence adjustment (400)
  • Success/failure distillation (400)
  • Recursive improvement (400)

Google Research (Strategy-Level Memory)

Pattern Categories:

  • Success strategies (600)
  • Failure learnings (600)
  • MaTTS parallel (600)
  • MaTTS sequential (600)
  • Closed-loop learning (600)

Code Reasoning (Programming Best Practices)

Pattern Categories:

  • Design patterns & architecture (500)
  • Algorithm optimization (500)
  • Code quality & refactoring (500)
  • Language-specific practices (500)
  • Debugging & error handling (500)

Problem Solving (Cognitive Diversity)

Pattern Categories:

  • Convergent thinking (400)
  • Divergent thinking (400)
  • Lateral thinking (400)
  • Systems thinking (400)
  • Critical thinking (400)

Domain Expert (Multi-Domain Expertise)

Domains:

  • DevOps & Infrastructure (300)
  • Data Engineering & ML (300)
  • Security & Compliance (300)
  • API Design & Integration (300)
  • Performance & Scalability (300)

🎯 Use Case Matrix

Your NeedRecommended Model(s)Why
AI agent that learnsSAFLASelf-improvement without retraining
Follow research best practicesGoogle ResearchBased on latest AI research paper
Code generationCode Reasoning2,500 programming patterns
Code reviewCode ReasoningDesign patterns, anti-patterns
Algorithm optimizationCode ReasoningO(n) improvements, caching
Complex problem solvingProblem Solving5 cognitive approaches
DebuggingCode ReasoningCommon bugs, edge cases
API developmentDomain Expert + Code ReasoningCombined expertise
DevOps/InfrastructureDomain ExpertKubernetes, CI/CD, monitoring
Security implementationDomain ExpertGDPR, encryption, auth
Performance tuningDomain ExpertCaching, load balancing
Multi-step reasoningProblem SolvingTask trajectories
Strategic planningGoogle ResearchStrategy-level memory

🔧 Common Tasks

Task: Install a model

Guide: HOW-TO-USE.md - Quick Start Time: 30 seconds

Task: Query patterns

Guide: HOW-TO-USE.md - Usage Examples Example:

bash
npx claude-flow@alpha memory query "JWT authentication" --reasoningbank

Task: Merge models

Guide: HOW-TO-USE.md - Merge Multiple Models Time: 5 minutes

Task: Train custom model

Guide: HOW-TO-TRAIN.md - Quick Start Time: 30-60 minutes

Task: Validate model quality

Command: node _scripts/validation-suite.cjs <model-dir> <model-name> Time: 1 minute

Task: Benchmark performance

Command: node _scripts/benchmark-all.cjs Time: 2-3 minutes

🚀 Advanced Topics

Parallel Training with Agents

See HOW-TO-TRAIN.md - Parallel Training

Memory Coordination

See HOW-TO-TRAIN.md - Memory Coordination

Incremental Training

See HOW-TO-TRAIN.md - Incremental Training

Custom Embeddings

See HOW-TO-TRAIN.md - Step 3: Create Embeddings

Pattern Linking

See HOW-TO-TRAIN.md - Step 4: Create Pattern Links

📈 Performance Standards

All models meet these production criteria:

MetricStandardTypical Performance
Query Latency<5ms0.05-2ms ✅
Storage Efficiency<10 KB/pattern2-6 KB/pattern ✅
Avg Confidence>70%83-91% ✅
Embedding Coverage100%100% ✅
Pattern Count>1,0001,500-3,000 ✅
Domain Coverage>3 domains5-6 domains ✅

🤝 Contributing

Want to contribute a model? We'd love to have it!

Requirements:

  1. ✅ Minimum 1,000 unique patterns
  2. ✅ 100% embedding coverage
  3. ✅ >70% average confidence
  4. ✅ <10 KB per pattern
  5. ✅ Comprehensive README.md
  6. ✅ Validation report
  7. ✅ Training script included

Submission Process:

  1. Create model using HOW-TO-TRAIN.md
  2. Run validation: node _scripts/validation-suite.cjs your-model your-model-name
  3. Create PR with model directory
  4. Include README.md and validation report

📝 License

All models are MIT licensed and free for commercial/non-commercial use.

💡 Support

  • Documentation Issues: Open issue on GitHub
  • Model Questions: See model-specific README.md
  • Training Help: HOW-TO-TRAIN.md
  • Usage Help: HOW-TO-USE.md

Last Updated: 2025-10-15 Total Models: 5 Total Patterns: 11,000 Total Storage: 29.17 MB


Happy reasoning! 🧠✨