ejkernel 0.0.21__tar.gz

ejkernel-0.0.21/PKG-INFO

@@ -0,0 +1,711 @@
+Metadata-Version: 2.3
+Name: ejkernel
+Version: 0.0.21
+Summary: Accelerate, Optimize performance with streamlined training and serving options with JAX.
+Keywords: Deep Learning,Machine Learning,JAX,CUDA,XLA,Triton,Pallas
+Author: Erfan Zare Chavoshi
+Author-email: Erfan Zare Chavoshi <Erfanzare810@gmail.com>
+License: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: beartype>=0.22.2
+Requires-Dist: chex>=0.1.91
+Requires-Dist: einops>=0.8.1
+Requires-Dist: jax>=0.8.0
+Requires-Dist: jaxlib>=0.8.0
+Requires-Dist: jaxtyping>=0.3.2
+Requires-Dist: pydantic>=2.11.10
+Requires-Dist: triton==3.4.0
+Requires-Dist: jax[cuda12]>=0.8.0 ; extra == 'gpu'
+Requires-Dist: xprof>=2.20.6 ; extra == 'profile'
+Requires-Dist: tb-nightly>=2.21.0a20250820 ; extra == 'profile'
+Requires-Dist: xprof-nightly>=2.21.6a20250820 ; extra == 'profile'
+Requires-Dist: jax[tpu]>=0.8.0 ; extra == 'tpu'
+Requires-Python: >=3.11, <3.14
+Project-URL: Documentation, https://ejkernel.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/erfanzar/ejkernel
+Project-URL: Repository, https://github.com/erfanzar/ejkernel
+Provides-Extra: gpu
+Provides-Extra: profile
+Provides-Extra: tpu
+Description-Content-Type: text/markdown
+
+# ejKernel: High-Performance JAX Kernels for Deep Learning
+
+> *"The best optimization is the one you don't have to think about."*
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![JAX](https://img.shields.io/badge/JAX-0.8.0+-orange.svg)](https://github.com/google/jax)
+[![Documentation](https://img.shields.io/badge/docs-readthedocs-green.svg)](https://ejkernel.readthedocs.io/en/latest/)
+
+ejKernel is a production-grade kernel library for JAX that provides highly optimized implementations of deep learning operations with automatic multi-backend support. The library features a sophisticated configuration management system with autotuning, comprehensive type safety, and seamless execution across GPUs, TPUs, and CPUs.
+
+## Table of Contents
+
+- [Key Features](#key-features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Architecture Overview](#architecture-overview)
+- [Supported Operations](#supported-operations)
+- [Advanced Usage](#advanced-usage)
+- [Development](#development)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [Citation](#citation)
+- [License](#license)
+
+## Key Features
+
+### Intelligent Kernel Management
+
+- **7-Tier Configuration System**: Override → Overlay → Memory Cache → Persistent Cache → Autotune → Heuristics → Error
+- **Automatic Platform Detection**: Seamlessly selects optimal implementation based on hardware
+- **Priority-Based Registry**: Multi-backend support with intelligent fallback mechanisms
+- **Device Fingerprinting**: Hardware-specific configuration caching for optimal performance
+
+### State-of-the-Art Operations
+
+- **15+ Attention Mechanisms**: Flash Attention v2, Ring Attention, Page Attention, Block Sparse, GLA, Lightning, Ragged Page Attention, and more
+- **Memory Efficiency**: Custom VJP implementations with O(N) memory complexity for attention
+- **Distributed Support**: Full shard_map integration for model and data parallelism
+- **Mixed Precision**: Comprehensive dtype support with automatic gradient conversion
+
+### Production-Ready Infrastructure
+
+- **Type Safety**: Full jaxtyping annotations with runtime validation via beartype
+- **Comprehensive Testing**: Cross-backend validation, performance benchmarks, integration tests
+- **Atomic Persistence**: Thread-safe configuration storage with automatic optimization
+- **Profiling Integration**: Built-in support for JAX profiling and performance monitoring
+
+## Installation
+
+### Basic Installation
+
+```bash
+pip install ejkernel
+```
+
+### Platform-Specific Installation
+
+```bash
+# GPU Support (CUDA/ROCm)
+pip install ejkernel[gpu]
+
+# TPU Support
+pip install ejkernel[tpu]
+
+# Development Installation
+git clone https://github.com/erfanzar/ejkernel.git
+cd ejkernel
+pip install -e ".[dev]"
+```
+
+### Dependencies
+
+- Python 3.11-3.13
+- JAX >= 0.8.0
+- Triton == 3.4.0 (for GPU)
+- jaxtyping >= 0.3.2
+- beartype >= 0.22.2
+
+## Quick Start
+
+### Simple API with Automatic Optimization
+
+```python
+import jax.numpy as jnp
+from ejkernel.modules import flash_attention
+
+# Basic usage - automatic configuration selection
+output = flash_attention(
+    query, key, value,
+    causal=True,
+    dropout_prob=0.1
+)
+
+# With advanced features
+output = flash_attention(
+    query, key, value,
+    causal=True,
+    sliding_window=128,        # Local attention window
+    logits_soft_cap=30.0,      # Gemma-2 style soft capping
+    attention_mask=mask,       # Custom attention pattern
+)
+```
+
+### Custom Configuration
+
+```python
+from ejkernel.modules import FlashAttentionConfig
+from ejkernel.ops.utils.datacarrier import FwdParams, BwdParams
+
+# Create optimized configuration
+config = FlashAttentionConfig(
+    fwd_params=FwdParams(
+        q_blocksize=256,
+        kv_blocksize=256,
+        num_warps=8,
+        num_stages=2
+    ),
+    bwd_params=BwdParams(
+        q_blocksize=128,
+        kv_blocksize=128,
+        num_warps=4
+    ),
+    platform="triton",  # Force specific backend
+    backend="gpu"
+)
+
+output = flash_attention(query, key, value, cfg=config)
+```
+
+### Direct Kernel Registry Access
+
+```python
+from ejkernel import kernel_registry, Platform, Backend
+
+# Get specific implementation
+kernel = kernel_registry.get(
+    algorithm="flash_attention",
+    platform=Platform.TRITON,
+    backend=Backend.GPU
+)
+
+# Direct execution
+output = kernel(query, key, value, causal=True)
+```
+
+### Distributed Execution
+
+```python
+import jax
+from jax.sharding import Mesh, PartitionSpec as P
+from ejkernel.modules import flash_attention
+
+# Setup mesh for distributed execution
+devices = jax.devices()
+mesh = Mesh(devices, axis_names=("data", "model"))
+
+# Run distributed attention
+output = flash_attention(
+    query, key, value,
+    causal=True,
+    mesh=mesh,
+    in_specs=(P("data", None), P("data", None), P("data", None)),
+    out_specs=P("data", None)
+)
+```
+
+## Architecture Overview
+
+### System Design
+
+ejKernel employs a sophisticated layered architecture that separates concerns while maintaining high performance:
+
+```md
+┌─────────────────────────────────────────────────────┐
+│              Public API (modules/)                   │
+│         Simple functions with sensible defaults      │
+├─────────────────────────────────────────────────────┤
+│            Operations Layer (ops/)                   │
+│    Configuration management, autotuning, caching     │
+├─────────────────────────────────────────────────────┤
+│          Kernel Registry (kernels/)                  │
+│      Platform routing, signature validation          │
+├─────────────────────────────────────────────────────┤
+│      Backend Implementations (kernels/_*)            │
+│         Triton, Pallas, XLA, CUDA kernels           │
+└─────────────────────────────────────────────────────┘
+```
+
+### Project Structure
+
+```md
+ejkernel/
+├── kernels/                          # Low-level kernel implementations
+│   ├── _triton/                      # Triton kernels (GPU)
+│   │   ├── flash_attention/
+│   │   ├── page_attention/
+│   │   ├── ragged_page_attention_v2/
+│   │   ├── gated_linear_attention/
+│   │   ├── lightning_attn/
+│   │   ├── mean_pooling/
+│   │   ├── native_sparse_attention/
+│   │   ├── recurrent/
+│   │   └── blocksparse_attention/
+│   ├── _pallas/
+│   │   ├── tpu/                      # TPU-specific implementations
+│   │   │   ├── flash_attention/
+│   │   │   ├── ring_attention/
+│   │   │   ├── page_attention/
+│   │   │   ├── ragged_page_attention_v2/
+│   │   │   ├── ragged_page_attention_v3/
+│   │   │   ├── blocksparse_attention/
+│   │   │   ├── grouped_matmul/
+│   │   │   └── ragged_decode_attention/
+│   │   └── gpu/                      # GPU Pallas implementations
+│   ├── _xla/                         # XLA implementations (universal)
+│   │   ├── attention/
+│   │   ├── flash_attention/
+│   │   ├── gated_linear_attention/
+│   │   ├── grouped_matmul/
+│   │   ├── lightning_attn/
+│   │   ├── mean_pooling/
+│   │   ├── native_sparse_attention/
+│   │   ├── page_attention/
+│   │   ├── ragged_decode_attention/
+│   │   ├── ragged_page_attention_v2/
+│   │   ├── ragged_page_attention_v3/
+│   │   ├── recurrent/
+│   │   ├── ring_attention/
+│   │   └── scaled_dot_product_attention/
+│   ├── _cuda/                        # CUDA implementations (dev)
+│   └── _registry.py                  # Kernel registry system
+│
+├── modules/                          # High-level API
+│   └── operations/
+│       ├── flash_attention.py
+│       ├── ring_attention.py
+│       ├── page_attention.py
+│       ├── ragged_page_attention_v2.py
+│       ├── ragged_page_attention_v3.py
+│       ├── blocksparse_attention.py
+│       ├── gated_linear_attention.py
+│       ├── lightning_attention.py
+│       ├── native_sparse_attention.py
+│       ├── recurrent.py
+│       ├── grouped_matmul.py
+│       ├── pooling.py
+│       ├── attention.py
+│       ├── multi_head_latent_attention.py
+│       ├── ragged_decode_attention.py
+│       ├── scaled_dot_product_attention.py
+│       └── configs.py
+│
+├── ops/                              # Configuration & execution framework
+│   ├── config/                       # Configuration management
+│   │   ├── cache.py                  # In-memory config cache
+│   │   ├── persistent.py             # Disk-based persistence
+│   │   └── selection.py              # Config selection chain
+│   ├── core/                         # Base kernel class
+│   ├── execution/                    # Execution orchestration
+│   │   └── tuning.py                 # Autotuning framework
+│   ├── registry.py                   # Operation invocation tracking
+│   └── utils/                        # Utilities (fingerprinting, etc)
+│
+├── xla_utils/                        # XLA-specific utilities
+│   ├── cumsum.py                     # Cumulative sum operations
+│   ├── shardings.py                  # Sharding utilities
+│   └── utils.py                      # Sequence length utilities
+│
+├── types/                            # Type definitions
+│   └── mask.py                       # MaskInfo for attention masking
+│
+├── callib/                           # Calling library
+│   ├── _ejit.py                      # Enhanced JIT
+│   ├── _triton_call.py               # Triton kernel calling
+│   └── _pallas_call.py               # Pallas kernel calling
+│
+└── utils.py                          # General utilities
+```
+
+### Core Components
+
+#### Kernel Registry
+
+The registry provides automatic platform-specific kernel selection:
+
+```python
+@kernel_registry.register("my_operation", Platform.TRITON, Backend.GPU, priority=100)
+def my_operation_gpu(x, y):
+    # GPU-optimized implementation
+    pass
+
+@kernel_registry.register("my_operation", Platform.XLA, Backend.ANY, priority=50)
+def my_operation_fallback(x, y):
+    # Universal fallback
+    pass
+
+# Automatic selection based on available hardware
+impl = kernel_registry.get("my_operation")
+```
+
+#### Configuration Management
+
+Multi-tier configuration system with intelligent fallback:
+
+```python
+class ConfigSelectorChain:
+    """
+    Selection hierarchy:
+    1. Override - Explicit user configuration
+    2. Overlay - Temporary context overrides
+    3. Memory Cache - In-memory lookup
+    4. Persistent Cache - Disk-based storage
+    5. Autotune - Performance benchmarking
+    6. Heuristics - Intelligent defaults
+    7. Error - Clear failure message
+    """
+```
+
+#### Custom VJP System
+
+All performance-critical kernels implement memory-efficient gradients:
+
+```python
+@jax.custom_vjp
+def kernel_with_custom_grad(inputs):
+    return forward(inputs)
+
+def kernel_fwd(inputs):
+    output, residuals = forward_with_residuals(inputs)
+    return output, residuals
+
+def kernel_bwd(residuals, grad_output):
+    return efficient_backward(residuals, grad_output)
+
+kernel_with_custom_grad.defvjp(kernel_fwd, kernel_bwd)
+```
+
+## Supported Operations
+
+### Attention Mechanisms
+
+| Algorithm | Description | Memory | Key Features |
+|-----------|-------------|--------|--------------|
+| **Flash Attention v2** | Memory-efficient exact attention | O(N) | Causal masking, dropout, sliding windows, soft capping |
+| **Ring Attention** | Distributed sequence parallelism | O(N/P) | Ultra-long sequences, communication overlap |
+| **Page Attention** | KV-cache optimized inference | O(N) | Block-wise memory, continuous batching |
+| **Block Sparse Attention** | Configurable sparse patterns | O(N√N) | Local+global, custom patterns |
+| **GLA** | Gated Linear Attention | O(N) | Linear complexity, gated updates |
+| **Lightning Attention** | Layer-dependent decay | O(N) | Exponential moving average |
+| **MLA** | Multi-head Latent Attention | O(N) | Compressed KV representation |
+| **Ragged Page Attention v2** | Variable-length paged attention | O(N) | Ragged sequences with page caching |
+| **Ragged Page Attention v3** | Enhanced ragged page attention | O(N) | Attention sinks support, improved handling |
+| **Ragged Decode Attention** | Variable-length decoding | O(N) | Efficient batched inference |
+| **Scaled Dot-Product Attention** | Standard attention | O(N²) | Basic reference implementation |
+
+### Other Operations
+
+| Operation | Description | Use Case |
+|-----------|-------------|----------|
+| **Grouped MatMul** | Efficient batched matrix operations | Expert models, MoE |
+| **Grouped MatMul v2** | Enhanced with shard_map support | Distributed expert models |
+| **Mean Pooling** | Variable-length sequence aggregation | Sentence embeddings |
+| **Recurrent** | Optimized RNN/LSTM/GRU operations | Sequential modeling |
+| **Native Sparse** | Block-sparse matrix computations | Sparse attention patterns |
+
+### Platform Support Matrix
+
+| Operation | Triton (GPU) | Pallas (TPU) | XLA (Universal) |
+|-----------|:------------:|:------------:|:---------------:|
+| Flash Attention v2 | ✅ | ✅ | ✅ |
+| Ring Attention | ✅ | ✅ | ✅ |
+| Page Attention | ✅ | ✅ | ✅ |
+| Block Sparse Attention | ✅ | ✅ | ✅ |
+| Ragged Page Attention v2 | ✅ | ✅ | ✅ |
+| Ragged Page Attention v3 | - | ✅ | ✅ |
+| Ragged Decode Attention | ✅ | ✅ | ✅ |
+| GLA | ✅ | - | ✅ |
+| Lightning Attention | ✅ | - | ✅ |
+| MLA | ✅ | 🚧 | - |
+| Recurrent | ✅ | - | ✅ |
+| Mean Pooling | ✅ | - | ✅ |
+| Grouped MatMul | - | ✅ | ✅ |
+| Grouped MatMul v2 | - | ✅ | - |
+| Native Sparse Attention | ✅ | - | ✅ |
+
+✅ = Production ready | 🚧 = Under development | - = Not available
+
+## Advanced Usage
+
+### Page Attention for KV-Cache Inference
+
+```python
+from ejkernel.modules import page_attention, PageAttentionConfig
+
+# Configure paged attention for inference
+config = PageAttentionConfig(
+    platform="auto",
+    backend="gpu"
+)
+
+output = page_attention(
+    query=q,
+    key_cache=k_cache,
+    value_cache=v_cache,
+    block_table=block_table,
+    cache_seqlens=cache_seqlens,
+    cfg=config
+)
+```
+
+### Ragged Page Attention for Variable-Length Batches
+
+```python
+from ejkernel.modules import ragged_page_attention_v3, RaggedPageAttentionv3Config
+
+# For variable-length sequences with attention sinks
+config = RaggedPageAttentionv3Config(
+    platform="pallas",
+    backend="tpu"
+)
+
+output = ragged_page_attention_v3(
+    query=q,
+    key_pages=k_pages,
+    value_pages=v_pages,
+    lengths=seq_lengths,
+    page_indices=page_indices,
+    cfg=config
+)
+```
+
+### Performance Optimization
+
+```python
+# Force autotuning for optimal configuration
+import os
+os.environ["EJKERNEL_AUTOTUNE_POLICY"] = "autotune"
+os.environ["EJKERNEL_LOG_AUTOTUNE"] = "1"
+
+# Enable profiling
+os.environ["EJKERNEL_OPS_STAMP"] = "json"  # Detailed metadata
+os.environ["EJKERNEL_OPS_RECORD"] = "1"    # Record invocations
+```
+
+### Custom Kernel Development
+
+```python
+from ejkernel.ops.core import Kernel
+from ejkernel.modules.operations.configs import BaseOperationConfig
+from dataclasses import dataclass
+
+@dataclass
+class MyConfig(BaseOperationConfig):
+    param1: int = 128
+    param2: float = 0.1
+
+class MyKernel(Kernel[MyConfig, Array]):
+    def __init__(self):
+        super().__init__(op_id="my_kernel")
+
+    def run(self, x, cfg: MyConfig):
+        impl = kernel_registry.get("my_kernel", cfg.platform)
+        return impl(x, param1=cfg.param1, param2=cfg.param2)
+
+    def heuristic_cfg(self, inv):
+        # Return default configuration
+        return MyConfig(param1=256)
+
+    def candidate_cfgs(self, inv):
+        # Return autotuning candidates
+        return [MyConfig(param1=p) for p in [64, 128, 256]]
+```
+
+### Integration with Flax Models
+
+```python
+import flax.linen as nn
+from ejkernel.modules import flash_attention
+
+class TransformerBlock(nn.Module):
+    num_heads: int = 8
+    head_dim: int = 64
+
+    @nn.compact
+    def __call__(self, x, mask=None):
+        # Project to Q, K, V
+        q = nn.Dense(self.num_heads * self.head_dim)(x)
+        k = nn.Dense(self.num_heads * self.head_dim)(x)
+        v = nn.Dense(self.num_heads * self.head_dim)(x)
+
+        # Reshape for attention
+        shape = (x.shape[0], x.shape[1], self.num_heads, self.head_dim)
+        q, k, v = map(lambda t: t.reshape(shape), (q, k, v))
+
+        # Apply ejKernel Flash Attention
+        attn_output = flash_attention(
+            q, k, v,
+            causal=True,
+            attention_mask=mask
+        )
+
+        # Project output
+        return nn.Dense(x.shape[-1])(attn_output.reshape(x.shape))
+```
+
+## Development
+
+### Setting Up Development Environment
+
+```bash
+# Clone repository
+git clone https://github.com/erfanzar/ejkernel.git
+cd ejkernel
+
+# Create virtual environment
+python -m venv .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Code Style
+
+The project uses:
+
+- **black** for code formatting (line length: 121)
+- **ruff** for linting
+- **mypy/pyright** for type checking
+- **pre-commit** for automated checks
+
+### Adding New Kernels
+
+1. **Implement the kernel** in appropriate backend directory:
+
+```python
+# ejkernel/kernels/_triton/my_kernel/_interface.py
+@kernel_registry.register("my_kernel", Platform.TRITON, Backend.GPU)
+def my_kernel_triton(x, config):
+    # Implementation
+    pass
+```
+
+1. **Create module wrapper**:
+
+```python
+# ejkernel/modules/operations/my_kernel.py
+class MyKernel(Kernel[MyKernelConfig, Array]):
+    # Module implementation
+    pass
+```
+
+1. **Add tests**:
+
+```python
+# test/kernels/_triton/test_my_kernel.py
+class TestMyKernel(unittest.TestCase):
+    # Test implementation
+    pass
+```
+
+1. **Update documentation**
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest test/
+
+# Platform-specific tests
+pytest test/kernels/_xla/          # XLA implementations
+pytest test/kernels/_triton/       # Triton implementations
+pytest test/kernels/_pallas/       # Pallas implementations
+
+# Specific test patterns
+pytest -k "flash_attention"
+pytest --verbose --failfast
+
+# Module operations tests
+pytest test/test_module_operations.py
+```
+
+### Test Categories
+
+- **Unit Tests**: Individual component testing
+- **Integration Tests**: End-to-end workflows
+- **Comparison Tests**: Cross-backend consistency
+- **Performance Tests**: Regression detection
+
+## Benchmarking
+
+Run benchmarks to compare performance across backends:
+
+```bash
+# General attention benchmarks
+python benchmarks/benchmark_attention.py
+
+# Ragged page attention benchmarks
+python benchmarks/benchmark_ragged_page_attn.py
+```
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Priority Areas
+
+- TPU/Pallas implementations for existing algorithms
+- CUDA native kernels for maximum performance
+- New attention mechanisms from recent papers
+- Performance optimizations and kernel fusion
+- Documentation and examples
+
+### Contribution Process
+
+1. Fork the repository
+1. Create a feature branch
+1. Implement your changes with tests
+1. Ensure all tests pass
+1. Submit a pull request
+
+## Documentation
+
+Comprehensive documentation available at [ejkernel.readthedocs.io](https://ejkernel.readthedocs.io/en/latest/)
+
+- **[API Reference](https://ejkernel.readthedocs.io/en/latest/api/)**: Complete API documentation
+- **[Tutorials](https://ejkernel.readthedocs.io/en/latest/tutorials/)**: Step-by-step guides
+- **[Architecture](https://ejkernel.readthedocs.io/en/latest/architecture/)**: Design documentation
+- **[Benchmarks](https://ejkernel.readthedocs.io/en/latest/benchmarks/)**: Performance analysis
+
+## Citation
+
+If you use ejKernel in your research, please cite:
+
+```bibtex
+@software{ejkernel2024,
+  author = {Erfan Zare Chavoshi},
+  title = {ejKernel: High-Performance JAX Kernels for Deep Learning},
+  year = {2024},
+  url = {https://github.com/erfanzar/ejkernel},
+  note = {Production-grade kernel library with multi-backend support}
+}
+```
+
+## License
+
+ejKernel is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
+
+## Acknowledgments
+
+ejKernel builds upon excellent work from:
+
+- [JAX](https://github.com/google/jax) - Composable transformations of Python+NumPy programs
+- [Triton](https://github.com/openai/triton) - GPU kernel programming language
+- [Pallas](https://github.com/google/jax/tree/main/jax/experimental/pallas) - JAX kernel language
+- [Flash Attention](https://github.com/Dao-AILab/flash-attention) - Memory-efficient attention
+- [EasyDeL](https://github.com/erfanzar/EasyDeL) - Parent framework for JAX deep learning
+
+## Community
+
+- **GitHub Issues**: [Bug reports and feature requests](https://github.com/erfanzar/ejkernel/issues)
+- **Discussions**: [Community forum](https://github.com/erfanzar/ejkernel/discussions)
+- **Email**: <Erfanzare810@gmail.com>
+
+---
+
+**ejKernel** - Production-grade kernels for JAX deep learning