Examples#
Code examples demonstrating how to use Surfaces for optimization benchmarking. All examples are tested and can be run as standalone scripts.
Example Categories#
Getting Started
First steps with Surfaces. Basic usage, input formats, and core concepts.
Test Functions
Working with different function categories: Algebraic, BBOB, CEC, ML, Engineering.
Integrations
Using Surfaces with scipy, Optuna, SMAC, Ray Tune, GFO, and Hyperactive.
Visualization
Creating surface plots, contour plots, and optimization trajectories.
Quick Links#
Most Popular:
Basic Usage - Your first test function
scipy - scipy.optimize integration
Optuna - Optuna hyperparameter tuning
Running Examples#
All examples can be run as standalone Python scripts:
# Clone the repository
git clone https://github.com/SimonBlanke/Surfaces.git
cd Surfaces
# Install with examples dependencies
pip install -e ".[examples]"
# Run an example
python docs/examples/getting_started/basic_usage.py