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.
🏃♂️ 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
- Start here: Audience Guide - Leadership
- Key concepts: Architecture Overview
- Success metrics: Evaluation Types and Metrics
- Start here: Audience Guide - Researchers
- Deep dive: Configuration Guide → NeMo Platform Integration
- Workflow: Task Orchestration
- Start here: Audience Guide - App Engineers
- Implementation: Data Logging for AI Apps → Dataset Validation
- API integration: API Reference
- Start here: Production Deployment
- Installation: Helm Installation
- Operations: Scripts Guide
| 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 |
| 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 |
| 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 |
| 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 |
| Document | Purpose | When to Read |
|---|---|---|
| API Reference | Complete API documentation | Building integrations |
| Limitations & Best Practices | Common issues and solutions | Troubleshooting, optimization |
- Architecture Overview (5 min - understand the big picture)
- Quickstart (30 min - get it running)
- Audience Guide (choose your role)
- Role-specific deep dive documents
- Configuration Guide (understand all options)
- Data Logging for AI Apps (instrument your app)
- Dataset Validation (ensure data quality)
- API Reference (integrate programmatically)
- Configuration Guide (plan your setup)
- Production Deployment (deployment architecture)
- Helm Installation (step-by-step install)
- Limitations & Best Practices (avoid common pitfalls)
- NeMo Platform Integration (advanced features)
- Task Orchestration (workflow customization)
- Evaluation Types and Metrics (interpret results)
- API Reference (programmatic access)
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
- 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! 🚀