Skip to content

Commit 79c91dd

Browse files
committed
update readme
1 parent bcf4db5 commit 79c91dd

File tree

1 file changed

+6
-52
lines changed

1 file changed

+6
-52
lines changed

README.md

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,9 @@ Test functions for benchmarking optimization algorithms in Python.
1919
<a href="https://codecov.io/gh/SimonBlanke/Surfaces"><img src="https://img.shields.io/codecov/c/github/SimonBlanke/Surfaces?style=flat-square" alt="Coverage"></a>
2020
</p>
2121

22-
<table align="center">
23-
<tr>
24-
<td align="right"><b>Documentation</b></td>
25-
<td align="center">▸</td>
26-
<td>
27-
<a href="https://github.com/SimonBlanke/Surfaces">Homepage</a> ·
28-
<a href="https://github.com/SimonBlanke/Surfaces#usage">User Guide</a> ·
29-
<a href="https://github.com/SimonBlanke/Surfaces#function-categories">API Reference</a> ·
30-
<a href="https://github.com/SimonBlanke/Surfaces#examples">Tutorials</a>
31-
</td>
32-
</tr>
33-
<tr>
34-
<td align="right"><b>On this page</b></td>
35-
<td align="center">▸</td>
36-
<td>
37-
<a href="#key-features">Features</a> ·
38-
<a href="#examples">Examples</a> ·
39-
<a href="#core-concepts">Concepts</a> ·
40-
<a href="#citation">Citation</a>
41-
</td>
42-
</tr>
43-
</table>
22+
| **Documentation**| [Homepage](https://github.com/SimonBlanke/Surfaces) · [User Guide](https://github.com/SimonBlanke/Surfaces#usage) · [API Reference](https://github.com/SimonBlanke/Surfaces#function-categories) · [Tutorials](https://github.com/SimonBlanke/Surfaces#examples) |
23+
| ---: | :--- |
24+
| **On this page**| [Features](#key-features) · [Examples](#examples) · [Concepts](#core-concepts) · [Citation](#citation) |
4425

4526
<br>
4627

@@ -85,36 +66,9 @@ pip install surfaces[full] # All optional features
8566

8667
## Key Features
8768

88-
<table>
89-
<tr>
90-
<td width="33%">
91-
<a href="#algebraic-functions"><b>30+ Algebraic Functions</b></a><br>
92-
<sub>Classic benchmarks from optimization literature: Sphere, Rastrigin, Ackley, Rosenbrock, and more. 1D, 2D, and N-dimensional variants.</sub>
93-
</td>
94-
<td width="33%">
95-
<a href="#machine-learning-functions"><b>ML Hyperparameter Surfaces</b></a><br>
96-
<sub>Real hyperparameter optimization landscapes using scikit-learn models with cross-validation on built-in datasets.</sub>
97-
</td>
98-
<td width="33%">
99-
<a href="#engineering-functions"><b>Engineering Problems</b></a><br>
100-
<sub>Constrained optimization from engineering literature: welded beams, pressure vessels, spring design, and truss structures.</sub>
101-
</td>
102-
</tr>
103-
<tr>
104-
<td width="33%">
105-
<a href="#using-modifiers"><b>Function Modifiers</b></a><br>
106-
<sub>Add noise, delays, or transformations to any function. Simulate real-world conditions for robust algorithm testing.</sub>
107-
</td>
108-
<td width="33%">
109-
<a href="#benchmark-suites"><b>BBOB and CEC Suites</b></a><br>
110-
<sub>Industry-standard benchmark suites used in optimization competitions. COCO/BBOB and CEC 2013/2014/2017.</sub>
111-
</td>
112-
<td width="33%">
113-
<a href="#integration-with-optimizers"><b>Optimizer Integration</b></a><br>
114-
<sub>Works with any optimizer that accepts a callable and search space. Native support for Hyperactive and Gradient-Free-Optimizers.</sub>
115-
</td>
116-
</tr>
117-
</table>
69+
| [**30+ Algebraic Functions**](#algebraic-functions)<br><sub>Classic benchmarks from optimization literature: Sphere, Rastrigin, Ackley, Rosenbrock, and more.</sub> | [**ML Hyperparameter Surfaces**](#machine-learning-functions)<br><sub>Real hyperparameter optimization landscapes using scikit-learn models with cross-validation.</sub> | [**Engineering Problems**](#engineering-functions)<br><sub>Constrained optimization from engineering literature: welded beams, pressure vessels, spring design.</sub> |
70+
| :--- | :--- | :--- |
71+
| [**Function Modifiers**](#using-modifiers)<br><sub>Add noise, delays, or transformations to any function. Simulate real-world conditions.</sub> | [**BBOB and CEC Suites**](#benchmark-suites)<br><sub>Industry-standard benchmark suites used in optimization competitions.</sub> | [**Optimizer Integration**](#integration-with-optimizers)<br><sub>Works with any optimizer that accepts a callable and search space.</sub> |
11872

11973
---
12074

0 commit comments

Comments
 (0)