@astermind/astermind-pro/dist/docs/DOCS_INDEX.md

Astermind Pro - Premium ML Toolkit with Advanced RAG, Reranking, Summarization, and Information Flow Analysis

# Astermind Pro Documentation Index

Complete documentation for Astermind Pro premium ML toolkit.

## 📚 Documentation Files

### Getting Started
- **[README.md](../README.md)** - Overview, installation, and quick start
- **[QUICK_REFERENCE.md](./guides/QUICK_REFERENCE.md)** - Quick reference for common operations

### Developer Resources
- **[DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md)** - Complete developer guide with:
  - Full API reference
  - Custom pipeline building patterns
  - Advanced usage patterns
  - Real-world use cases
  - Integration examples
  - Performance optimization

- **[EXAMPLES.md](./guides/EXAMPLES.md)** - 15+ practical code examples:
  - Simple search pipelines
  - Code documentation search
  - Multi-stage filtering
  - Adaptive quality control
  - Batch processing
  - Streaming results
  - Custom feature engineering
  - Vector DB integration
  - Real-time learning
  - And more...

### Feature Documentation
- **[PREMIUM_FEATURES.md](./features/PREMIUM_FEATURES.md)** - Complete list of all premium features:
  - Omega RAG System
  - OmegaRR Reranking
  - OmegaSumDet Summarization
  - Transfer Entropy Analysis
  - Advanced Numerical Methods
  - And more...

- **[ELM_VARIANTS_EXAMPLES.md](./features/ELM_VARIANTS_EXAMPLES.md)** - Technical examples for Advanced ELM Variants:
  - Multi-Kernel ELM examples
  - DeepELMPro examples with all features
  - Online Kernel ELM for streaming data
  - Multi-Task ELM for joint learning
  - Sparse ELM for high-dimensional data
  - Comparison guide for choosing the right variant

- **[ELM_VARIANTS_BUSINESS_EXAMPLES.md](./features/ELM_VARIANTS_BUSINESS_EXAMPLES.md)** - Real-world business examples across industries:
  - Finance & Banking (fraud detection, credit risk, trading, AML)
  - Healthcare (diagnosis, drug discovery, patient monitoring)
  - Retail & E-commerce (recommendations, demand forecasting, churn)
  - Manufacturing (quality control, predictive maintenance)
  - Legal & Compliance (contract analysis, compliance monitoring)
  - Marketing & Advertising (segmentation, ad performance)
  - Insurance (fraud detection, risk assessment)
  - Real Estate (property valuation)
  - Energy & Utilities (demand forecasting)
  - Telecommunications (network monitoring)
  - ROI summaries and business impact metrics

## 🚀 Quick Start Paths

### For New Users
1. Read [README.md](../README.md)
2. Check [QUICK_REFERENCE.md](./guides/QUICK_REFERENCE.md)
3. Try examples from [EXAMPLES.md](./guides/EXAMPLES.md)

### For Developers Building Pipelines
1. Read [DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md) - "Building Custom Pipelines"
2. Review [DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md) - "Real-World Use Cases"
3. Reference [DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md) - "API Reference"

### For Advanced Users
1. Study [DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md) - "Advanced Patterns"
2. Explore [PREMIUM_FEATURES.md](./features/PREMIUM_FEATURES.md) for feature details
3. Optimize with [DEVELOPER_GUIDE.md](./guides/DEVELOPER_GUIDE.md) - "Performance Optimization"

## 📖 Documentation Structure

```
Astermind Pro/
├── README.md              # Overview & installation
├── DEVELOPER_GUIDE.md     # Complete developer guide (1657+ lines)
├── QUICK_REFERENCE.md     # Quick reference (206 lines)
├── EXAMPLES.md                    # Code examples (432 lines)
├── ELM_VARIANTS_EXAMPLES.md       # Technical ELM variants examples
├── ELM_VARIANTS_BUSINESS_EXAMPLES.md # Business use cases across industries
├── PREMIUM_FEATURES.md            # Feature documentation
└── DOCS_INDEX.md                  # This file
```

## 🎯 Use Case Examples in Documentation

### Technical Documentation
- Code search and explanation
- API documentation search
- Technical Q&A systems

### Business Applications
- Customer support knowledge bases
- Legal document analysis
- E-commerce product search
- Medical information retrieval

### Research & Analysis
- Research paper summarization
- Literature review automation
- Information extraction

### Custom Pipelines
- Multi-stage reranking
- Adaptive quality control
- Streaming processing
- Real-time learning

## 🔧 API Categories

### Math & Numerical Methods
- Vector operations
- Kernel Ridge Regression
- Online Ridge Regression
- Random Fourier Features

### RAG & Retrieval
- Omega RAG System
- Hybrid retrieval (NEW: standalone modules!)
  - `buildIndex()` - Build vocabulary, IDF, and Nyström landmarks
  - `hybridRetrieve()` - Perform sparse + dense retrieval
  - `toTfidf()`, `cosineSparse()`, `projectToDense()` - Vector operations
- Custom retrieval pipelines
- Tokenization & stemming (`tokenize()`, `expandQuery()`)
- Markdown parsing (`parseMarkdownToSections()`, `flattenSections()`)
- Auto-tuning (`autoTune()`, `sampleQueriesFromCorpus()`)
- Model serialization (`exportModel()`, `importModel()`)

### Advanced ELM Variants (NEW!)
- Multi-Kernel ELM - Combines multiple kernels for better accuracy
- DeepELMPro - Improved Deep ELM with pretraining, regularization, batch norm
- Online Kernel ELM - Real-time learning for streaming data
- Multi-Task ELM - Joint learning across related tasks
- Sparse ELM - Efficiency and interpretability for high-dimensional data
- See [ELM_VARIANTS_EXAMPLES.md](./features/ELM_VARIANTS_EXAMPLES.md) for technical examples
- See [ELM_VARIANTS_BUSINESS_EXAMPLES.md](./features/ELM_VARIANTS_BUSINESS_EXAMPLES.md) for real-world business use cases

### Reranking
- OmegaRR reranking
- MMR filtering
- Feature engineering

### Summarization
- OmegaSumDet
- Intent-aware summarization
- Code-aware processing

### Information Flow
- Transfer Entropy
- InfoFlow graphs
- Closed-loop control

## 💡 Key Concepts

1. **Modular Architecture** - Use components independently
2. **No Private APIs** - Everything is public and extensible
3. **Pipeline Pattern** - Build custom processing pipelines
4. **Production Ready** - Optimized workers for inference
5. **Flexible** - Mix and match components as needed
6. **Reusable Modules** - Retrieval, tokenization, and utilities work outside workers!

## 📞 Support

For questions, see the documentation files above or contact AsterMind LLC.

---

**Total Documentation**: ~2,300 lines across 5 comprehensive guides