eggroll-trainer 0.1.0

A library for Evolution Strategy trainers in PyTorch, including the EGGROLL algorithm

Eggroll Trainer

A library for Evolution Strategy (ES) trainers in PyTorch, including the EGGROLL algorithm.

Documentation

📚 Full Documentation - Complete guide with examples, API reference, and research.

Installation

# Using pip
pip install eggroll-trainer

# Or using uv
uv add eggroll-trainer

# For examples with plotting:
pip install "eggroll-trainer[examples]"
# or
uv add eggroll-trainer --extra examples

For development/contributing, see CONTRIBUTING.md.

What is EGGROLL?

EGGROLL (Evolution Guided General Optimization via Low-rank Learning) is a novel ES algorithm that provides a hundredfold increase in training speed over naïve evolution strategies by using low-rank perturbations instead of full-rank ones.

Key innovation: For matrix parameters W ∈ R^(m×n), EGGROLL samples low-rank matrices A ∈ R^(m×r), B ∈ R^(n×r) where r << min(m,n), forming perturbations A @ B.T. This reduces:

• Memory: O(mn) → O(r(m+n))
• Computation: O(mn) → O(r(m+n))

Yet still achieves high-rank updates through population averaging!

Based on: Evolution Strategies at the Hyperscale

Usage

EGGROLL Trainer (Recommended)

import torch
import torch.nn as nn
from eggroll_trainer import EGGROLLTrainer

# Define a model
class SimpleModel(nn.Module):
    def __init__(self):
        super().__init__()
        self.fc1 = nn.Linear(10, 20)  # Matrix: uses LoRA updates
        self.fc2 = nn.Linear(20, 1)   # Matrix: uses LoRA updates
    
    def forward(self, x):
        return self.fc2(torch.relu(self.fc1(x)))

# Define fitness function (higher is better)
def fitness_fn(model):
    # Your evaluation logic
    return torch.randn(1).item()

# Create EGGROLL trainer
model = SimpleModel()
trainer = EGGROLLTrainer(
    model.parameters(),
    model=model,
    fitness_fn=fitness_fn,
    population_size=256,      # Large populations are efficient!
    learning_rate=0.01,
    sigma=0.1,
    rank=1,                   # Low-rank rank (1 is often sufficient)
    noise_reuse=0,            # 0 = no reuse, 2 = antithetic sampling
    group_size=0,             # 0 = global normalization
    freeze_nonlora=False,     # If True, only update matrix params
    seed=42,
)

# Train
trainer.train(num_generations=100)

Base ES Trainer

For custom ES algorithms, subclass ESTrainer:

from eggroll_trainer import ESTrainer
import torch

class MyESTrainer(ESTrainer):
    def sample_perturbations(self, population_size):
        param_dim = self.current_params.shape[0]
        return torch.randn(population_size, param_dim, device=self.device)
    
    def compute_update(self, perturbations, fitnesses):
        weights = (fitnesses - fitnesses.mean()) / fitnesses.std()
        return (weights[:, None] * perturbations).mean(dim=0)

Architecture

EGGROLLTrainer

The EGGROLLTrainer implements the actual EGGROLL algorithm:

• Low-rank perturbations for 2D parameters (matrices): Uses A @ B.T where A ∈ R^(m×r), B ∈ R^(n×r)
• Full-rank perturbations for 1D/3D+ parameters (biases, etc.)
• Per-layer updates: Handles each parameter tensor independently
• Fitness normalization: Supports global or group-based normalization
• Noise reuse: Optional antithetic sampling for efficiency

ESTrainer (Base Class)

The base ESTrainer class provides:

• Parameter flattening/unflattening utilities
• Training loop framework
• Fitness evaluation infrastructure
• History tracking

Subclasses implement:

• sample_perturbations(): How to sample perturbations
• compute_update(): How to compute parameter updates from fitnesses

Examples

See the examples/ directory:

• basic_example.py ⭐ START HERE - Side-by-side comparison of VanillaESTrainer and EGGROLLTrainer
• mnist_comparison.py - Full EGGROLL vs SGD comparison on MNIST with plots
• run_all_comparisons.py - Multi-architecture comparison (CNN, Transformer, MLP)
• comparison_framework.py - Reusable framework for comparing optimizers
• models.py - Shared model architectures
• utils.py - Shared utility functions
• Test suites: test_comprehensive.py, test_eggroll.py, test_mnist_eggroll.py

3D Reinforcement Learning Examples

Train agents in 3D MuJoCo environments:

See examples/README.md and examples/animals_3d/README.md for detailed documentation.

Key Features

• ✅ EGGROLL algorithm - Low-rank perturbations for massive speedup
• ✅ PyTorch native - Works with any PyTorch model
• ✅ Flexible - Supports custom ES algorithms via subclassing
• ✅ Efficient - Optimized for large population sizes
• ✅ Well-tested - Comprehensive test suite included

References

• EGGROLL Paper/Blog
• GitHub Implementation