Data Flywheel Blueprint Documentation

Deprecation notice (Apr 2026): This project is deprecated. It is no longer actively maintained, and new production use is not recommended. The blueprint is retained for reference only.

Welcome to the Data Flywheel Blueprint documentation! This guide helps you navigate our comprehensive documentation to find exactly what you need.

🚀 Quick Start Paths

I want to...

🏃‍♂️ Get up and running quickly → Start with Getting Started (Quickstart)

🔧 Configure for my environment
→ Jump to Configuration Guide

🏢 Deploy in production
→ Go to Production Deployment or Helm Installation

📊 Understand evaluation results
→ Read Evaluation Types and Metrics

🔌 Integrate my application
→ Check out Data Logging for AI Apps

🚨 Troubleshoot issues
→ See Limitations & Best Practices

---

👥 Documentation by Role

For Leadership & Product Teams

• Start here: Audience Guide - Leadership
• Key concepts: Architecture Overview
• Success metrics: Evaluation Types and Metrics

For ML Engineers & Researchers

• Start here: Audience Guide - Researchers
• Deep dive: Configuration Guide → NeMo Platform Integration
• Workflow: Task Orchestration

For Application Engineers

• Start here: Audience Guide - App Engineers
• Implementation: Data Logging for AI Apps → Dataset Validation
• API integration: API Reference

For DevOps & Platform Teams

• Start here: Production Deployment
• Installation: Helm Installation
• Operations: Scripts Guide

---

📚 Complete Documentation Index

Getting Started

Document	Purpose	When to Read
Quickstart	End-to-end setup guide	First time setup, demos
Architecture Overview	High-level system design	Understanding components
Audience Guide	Role-specific guidance	Finding your starting point

Configuration & Setup

Document	Purpose	When to Read
Configuration Guide	Complete configuration reference	Setting up models, evaluation, training
Data Logging for AI Apps	Application instrumentation	Integrating your AI application
Dataset Validation	Data quality requirements	Troubleshooting data issues

Advanced Topics

Document	Purpose	When to Read
Evaluation Types and Metrics	Understanding results	Interpreting model performance
Task Orchestration	Workflow internals	Debugging, customizing workflows
NeMo Platform Integration	Advanced NeMo features	Deep NeMo customization

Deployment & Operations

Document	Purpose	When to Read
Production Deployment	Kubernetes production setup	Production deployments
Helm Installation	Helm chart deployment	Kubernetes with Helm
Scripts Guide	Utility scripts reference	Development, maintenance

Reference & Troubleshooting

Document	Purpose	When to Read
API Reference	Complete API documentation	Building integrations
Limitations & Best Practices	Common issues and solutions	Troubleshooting, optimization

---

🗺️ Common Reading Paths

🆕 First-Time Users

1. Architecture Overview (5 min - understand the big picture)
2. Quickstart (30 min - get it running)
3. Audience Guide (choose your role)
4. Role-specific deep dive documents

🔧 Setting Up for Your Use Case

1. Configuration Guide (understand all options)
2. Data Logging for AI Apps (instrument your app)
3. Dataset Validation (ensure data quality)
4. API Reference (integrate programmatically)

🏢 Production Deployment

1. Configuration Guide (plan your setup)
2. Production Deployment (deployment architecture)
3. Helm Installation (step-by-step install)
4. Limitations & Best Practices (avoid common pitfalls)

🔬 Research & Development

1. NeMo Platform Integration (advanced features)
2. Task Orchestration (workflow customization)
3. Evaluation Types and Metrics (interpret results)
4. API Reference (programmatic access)

---

🔗 How Documents Connect

graph TD
    A[README.md<br/>Start Here] --> B[Audience Guide<br/>Find Your Role]
    A --> C[Quickstart<br/>Get Running]
    
    B --> D[Configuration Guide<br/>Setup Details]
    C --> D
    
    D --> E[Data Logging<br/>App Integration]
    D --> F[Production Deploy<br/>or Helm Install]
    
    E --> G[Dataset Validation<br/>Data Quality]
    E --> H[API Reference<br/>Integration]
    
    F --> I[Scripts Guide<br/>Operations]
    F --> J[Best Practices<br/>Troubleshooting]
    
    D --> K[Advanced Topics:<br/>NeMo Integration,<br/>Workflow Orchestration,<br/>Evaluation Metrics]
    
    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0

---

🤝 Getting Help

• Deprecation (Apr 2026): This project is no longer actively maintained; see the notice at the top of this page.
• GitHub Issues: Report bugs or request features
• Documentation Issues: Found something unclear? Let us know!
• Community: Join discussions and share experiences

---

Ready to get started? Choose your path above or dive into the Quickstart Guide! 🚀