Documentation

Module: epochly

Top-level module reference for the Epochly Python optimizer.


Module Import

import epochly

Exported Functions

FunctionDescription
configure(**kwargs)Configure Epochly settings
get_status()Get current optimization status
set_level(level)Set enhancement level (0-4)
get_level()Get current enhancement level
get_config()Get current configuration
is_enabled()Check if Epochly is enabled
get_metrics()Get performance metrics
get_license_info()Get license information
check_feature(feature)Check if feature is available

Exported Decorators

DecoratorDescription
@optimizeMain optimization decorator
@performance_monitorAdd performance monitoring
@jit_compileForce JIT compilation
@full_optimizeApply maximum optimization
@threading_optimizeApply threading optimization

Exported Context Managers

Context ManagerDescription
optimize_context()Optimization context
monitoring_context()Performance monitoring context
jit_context()JIT compilation context
threading_context()Threading optimization context
benchmark_context()Benchmarking context

Exported Classes

ClassDescription
EnhancementLevelEnum for optimization levels
EpochlyErrorBase exception class
EpochlyConfigErrorConfiguration error
EpochlyCompatibilityErrorCompatibility error

Quick Reference

import epochly
# Configure
epochly.configure(level=3, telemetry=True)
# Check status
status = epochly.get_status()
print(f"Level: {status['enhancement_level']}")
# Use decorator
@epochly.optimize
def my_function(data):
return process(data)
# Use context manager
with epochly.optimize_context(level=2):
result = compute(data)