Expand description
OptiRS Benchmarking Library
This crate provides comprehensive benchmarking, profiling, performance analysis, and regression detection tools for ML optimization algorithms in the OptiRS ecosystem.
§Features
- Performance Benchmarking: Compare optimizers across standard test functions
- Gradient Flow Analysis: Monitor optimization dynamics and convergence patterns
- Memory Profiling: Track memory usage, detect leaks, and optimize allocation
- Regression Detection: Detect performance regressions across different versions
- Cross-Platform Testing: Validate optimizers across different hardware and OS
- Security Auditing: Scan for security vulnerabilities and compliance issues
- CI/CD Integration: Automated testing and reporting for continuous integration
- Visualization Tools: Generate plots and reports for optimization analysis
§Architecture
The crate is organized into several main modules:
benchmarking
: Core benchmarking functionality and test suitesmemory
: Memory profiling, leak detection, and optimizationregression
: Performance regression detection and alertingsecurity
: Security auditing and vulnerability scanningvisualization
: Plotting and reporting toolsci_cd_automation
: Continuous integration and deployment automationcross_platform
: Cross-platform testing and validation
§Usage
use optirs_bench::{
OptimizerBenchmark, GradientFlowAnalyzer,
visualization::OptimizerStateVisualizer,
};
use scirs2_core::ndarray_ext::{Array1, Ix1};
// Create a benchmark suite
let mut benchmark = OptimizerBenchmark::<f64>::new();
benchmark.add_standard_test_functions();
// Set up gradient flow analysis
let mut analyzer = GradientFlowAnalyzer::<f64, Ix1>::new(1000);
// Set up state visualization
let mut visualizer = OptimizerStateVisualizer::<f64, Ix1>::new(500);
Modules§
- advanced_
cross_ platform_ orchestrator - advanced_
leak_ detectors - advanced_
memory_ leak_ detector - advanced_
pattern_ detection - automated_
test_ runners - ci_
cd_ automation - comprehensive_
security_ auditor - cross_
framework - cross_
platform_ tester - documentation_
analyzer - enhanced_
memory_ monitor - error
- memory_
leak_ detector - memory_
optimizer - performance_
profiler - performance_
regression_ detector - prelude
- Prelude module for common imports
- regression_
tester - security_
auditor - visualization
- Optimizer state visualization tools
Structs§
- Benchmark
Report - Comprehensive benchmark report
- Benchmark
Result - Result of a single benchmark run
- Comparison
Metric - Metric for comparing optimizers
- Gradient
Flow Analyzer - Gradient flow analyzer for understanding optimization dynamics
- Gradient
Flow Stats - Statistics about gradient flow
- Optimizer
Benchmark - Optimizer benchmark suite
- Optimizer
Comparison - Comparison between two optimizers
- Optimizer
Dashboard - Dashboard for multiple optimizer comparison
- Optimizer
Performance - Performance summary for an optimizer
- Optimizer
State Snapshot - Snapshot of optimizer internal state
- Optimizer
State Visualizer - Optimizer state visualizer
- Parameter
Group Stats - Statistics for a single parameter group
- Test
Function - Test function for optimization benchmarking
- Visualization
Data - Data structure for visualization
- Visualization
Export - Exported data for visualization
Enums§
- Optim
Error - Error type for ML optimization operations
Type Aliases§
- Gradient
Function - Type alias for gradient function
- Objective
Function - Type alias for objective function
- Result
- Result type for ML optimization operations