User Guide

Epochly User Guide: Level Configuration Guide

Detailed guide to configuring each enhancement level including thresholds, constraints, and per-function overrides.

This guide explains how to tune Epochly's optimization levels for your specific workloads.

Overview of Enhancement Levels

Epochly uses a progressive enhancement model with five levels:

Level	Name	Optimization Type	Best For
0	Monitor	None (baseline)	Diagnostics
1	Threading	Thread pool for I/O	I/O-bound tasks
2	JIT	Just-in-time compilation	Numerical computation
3	Multicore	Full parallelism	CPU-bound tasks
4	GPU	GPU acceleration	Large array operations

Configuration Methods

Epochly supports configuration through:

Environment variables (recommended for deployment)
TOML configuration files (for complex setups)
Runtime API (for level changes only)

Environment Variable Reference

Variable	Purpose	Values
`EPOCHLY_LEVEL`	Set target enhancement level	0-4
`EPOCHLY_MODE`	Operating mode	`off`, `monitor`, `conservative`, `balanced`, `aggressive`
`EPOCHLY_MAX_WORKERS`	Maximum worker processes	Integer (default: CPU count)
`EPOCHLY_JIT_ENABLED`	Enable/disable JIT compilation	`true`, `false`
`EPOCHLY_GPU_ENABLED`	Enable/disable GPU	`true`, `false`
`EPOCHLY_MEMORY_LIMIT`	Memory limit (MB)	Integer
`EPOCHLY_TELEMETRY`	Enable telemetry	`true`, `false`
`EPOCHLY_LOG_LEVEL`	Log level	`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`

Runtime API

import epochly
# Check current status
status = epochly.get_status()
print(f"Current level: {status['enhancement_level']}")
print(f"Workers: {status.get('worker_count', 'N/A')}")
# Set enhancement level programmatically
epochly.set_level(3)  # Set to Level 3 (Full optimization)

Level 1: Threading Configuration

What It Does

Level 1 introduces a thread pool executor for I/O-bound operations:

File reads/writes
Network requests
Database queries
Any operation that waits on external resources

Tuning Level 1

# Set maximum workers via environment variable
export EPOCHLY_MAX_WORKERS=32
python your_script.py

#### Recommended Settings

Workload Type	Recommended Workers
Light I/O (< 10 concurrent ops)	4-8
Medium I/O (10-50 concurrent ops)	8-16
Heavy I/O (> 50 concurrent ops)	16-32
Memory constrained	2-4

Level 2: JIT Configuration

Tuning Level 2

#### JIT Configuration

# Enable JIT compilation
export EPOCHLY_JIT_ENABLED=true
export EPOCHLY_LEVEL=2
python your_script.py
# Disable JIT compilation
export EPOCHLY_JIT_ENABLED=false
python your_script.py

Level 3: Multicore Configuration

Tuning Level 3

#### Worker Count

# Check current workers
python -c "import epochly; print(epochly.get_status())"
# Adjust worker count
export EPOCHLY_MAX_WORKERS=8
python your_script.py

#### Shared Memory Size

# Increase shared memory for large data transfers
export EPOCHLY_MEMORY_SHARED_SIZE=134217728  # 128MB
python your_script.py
# Decrease for memory-constrained environments
export EPOCHLY_MEMORY_SHARED_SIZE=33554432  # 32MB
python your_script.py

Level 4: GPU Configuration

Tuning Level 4

# Enable GPU acceleration
export EPOCHLY_LEVEL=4
export EPOCHLY_GPU_ENABLED=true
python your_script.py
# Set memory limit (MB)
export EPOCHLY_MEMORY_LIMIT=4096
python your_script.py

Common Configuration Patterns

Web Server (I/O Heavy)

export EPOCHLY_LEVEL=1
export EPOCHLY_MAX_WORKERS=64
export EPOCHLY_JIT_ENABLED=false
python server.py

Data Science (Numerical Heavy)

export EPOCHLY_LEVEL=3
export EPOCHLY_MAX_WORKERS=8
export EPOCHLY_GPU_ENABLED=true
python analysis.py

Batch Processing (CPU Heavy)

export EPOCHLY_LEVEL=3
export EPOCHLY_MAX_WORKERS=16
export EPOCHLY_MEMORY_SHARED_SIZE=268435456  # 256MB
python batch_job.py

Memory Constrained

export EPOCHLY_LEVEL=2
export EPOCHLY_MAX_WORKERS=4
python constrained_app.py

TOML Configuration File

For complex setups, create an epochly.toml file:

[epochly]
mode = "balanced"
enhancement_level = 3
max_workers = 8
telemetry = true
[epochly.jit]
backend = "auto"
cache_enabled = true
hot_path_threshold = 1000
[epochly.memory]
pool_type = "shared"
shared_memory_size = 134217728  # 128MB
numa_aware = false
[epochly.gpu]
enabled = true
memory_limit = 4096
workload_threshold = 1000000

Place this file in:

Current directory (./epochly.toml)
User config directory (~/.config/epochly/epochly.toml)
System config (/etc/epochly/epochly.toml)

Files are loaded in priority order (current directory wins).