Merge branch 'main' into feature/add-scipy-backend

Author: SimonBlanke

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,19 +10,18 @@
 
 <!-- Mark the applicable option with [x] -->
 
-- [ ] `[Fix]` - Bug fix (non-breaking change fixing an issue)
-- [ ] `[Feature]` - New feature (non-breaking change adding functionality)
-- [ ] `[Refactor]` - Code refactoring (no functional changes)
-- [ ] `[Release]` - Release preparation
-- [ ] `[Hotfix]` - Critical fix for production
+- [ ] `[BUG]` - Bug fix (non-breaking change fixing an issue)
+- [ ] `[ENH]` - New feature (non-breaking change adding functionality)
+- [ ] `[DOC]` - Documentation changes
+- [ ] `[MNT]` - Maintenance
 
 ## How was this solved?
 
 <!-- Explain your approach to solving the issue -->
 
 ## Checklist
 
-- [ ] PR title includes appropriate tag: `[Fix]`, `[Feature]`, `[Refactor]`, `[Release]`, or `[Hotfix]`
+- [ ] PR title includes appropriate tag: `[BUG]`, `[ENH]`, `[DOC]` or `[MNT]`
 - [ ] Linked to related issue (if applicable)
 - [ ] Code passes `make check` (lint, format, isort)
 - [ ] Tests added/updated for changes (if applicable)

docs/source/_snippets/user_guide/introduction.py

@@ -13,6 +13,17 @@
 X = X_train
 y = y_train
 
+# [start:simplest_example]
+from hyperactive.opt.gfo import HillClimbing
+
+def score(p):
+    return -(p["x"] ** 2)  # Find x that minimizes x²
+
+opt = HillClimbing({"x": range(-10, 11)}, experiment=score)
+best = opt.solve()  # {"x": 0}
+# [end:simplest_example]
+
+
 # [start:simple_objective]
 def objective(params):
     x = params["x"]
@@ -35,6 +46,14 @@ def objective(params):
 # [end:sklearn_experiment_intro]
 
 
+# [start:sklearn_3_lines]
+from hyperactive.experiment.integrations import SklearnCvExperiment
+from sklearn.ensemble import GradientBoostingClassifier
+
+experiment = SklearnCvExperiment(GradientBoostingClassifier(), X, y, cv=5)
+# [end:sklearn_3_lines]
+
+
 # [start:optimizer_imports]
 from hyperactive.opt.gfo import (
     HillClimbing,           # Local search
@@ -118,6 +137,67 @@ def my_objective(params):
 # [end:warm_starting]
 
 
+# [start:swap_hill_climbing]
+from hyperactive.opt.gfo import HillClimbing
+
+optimizer = HillClimbing(search_space, experiment=experiment)
+best = optimizer.solve()
+# [end:swap_hill_climbing]
+
+
+# [start:swap_bayesian]
+from hyperactive.opt.gfo import BayesianOptimizer
+
+optimizer = BayesianOptimizer(search_space, experiment=experiment)
+best = optimizer.solve()
+# [end:swap_bayesian]
+
+
+# [start:swap_genetic]
+from hyperactive.opt.gfo import GeneticAlgorithmOptimizer
+
+optimizer = GeneticAlgorithmOptimizer(search_space, experiment=experiment)
+best = optimizer.solve()
+# [end:swap_genetic]
+
+
+# [start:complete_example]
+import numpy as np
+from sklearn.datasets import load_iris
+from sklearn.ensemble import RandomForestClassifier
+from hyperactive.experiment.integrations import SklearnCvExperiment
+from hyperactive.opt.gfo import BayesianOptimizer
+
+# 1. Load your data
+X, y = load_iris(return_X_y=True)
+
+# 2. Define the experiment (what to optimize)
+experiment = SklearnCvExperiment(
+    estimator=RandomForestClassifier(),
+    X=X, y=y, cv=5,
+)
+
+# 3. Define the search space (where to search)
+search_space = {
+    "n_estimators": list(range(10, 200, 10)),
+    "max_depth": [3, 5, 10, 20, None],
+    "min_samples_split": [2, 5, 10],
+}
+
+# 4. Choose an optimizer (how to search)
+optimizer = BayesianOptimizer(
+    search_space=search_space,
+    n_iter=50,
+    experiment=experiment,
+    random_state=42,
+)
+
+# 5. Run and get the best parameters
+best_params = optimizer.solve()
+print(f"Best parameters: {best_params}")
+# [end:complete_example]
+
+
 if __name__ == "__main__":
     # The actual test code runs here
     print("Introduction snippet file is importable!")

docs/source/_static/css/custom.css

@@ -1,10 +1,8 @@
 /* Custom CSS for Hyperactive documentation */
 /* Purple/Violet theme matching the Hyperactive logo */
 
-/* ============================================
-   Google Font Import for Hero Title
-   ============================================ */
-@import url('https://fonts.googleapis.com/css2?family=Raleway:wght@300;400;600;700&display=swap');
+/* NOTE: Raleway font is loaded via layout.html with preload for better performance.
+   This prevents the Flash of Unstyled Text (FOUT) on the hero title. */
 
 /* ============================================
    PyData Theme Color Overrides (purple theme)
@@ -132,6 +130,29 @@ html[data-theme="dark"] {
     margin-top: 1.25rem;
 }
 
+/* Remove vertical line from right sidebar */
+.bd-sidebar-secondary .toc-entry,
+.bd-sidebar-secondary nav.page-toc {
+    border-left: none;
+}
+
+/* Right sidebar slide-in animation on page load */
+@keyframes slideInFromLeft {
+    from {
+        opacity: 0;
+        transform: translateX(-20px);
+    }
+    to {
+        opacity: 1;
+        transform: translateX(0);
+    }
+}
+
+.bd-sidebar-secondary {
+    min-width: 200px;
+    animation: slideInFromLeft 0.3s ease forwards;
+}
+
 .pst-page-navigation-heading {
     margin-bottom: 0.5rem;
 }
@@ -273,6 +294,11 @@ html[data-theme="dark"] .back-to-top-sidebar a:hover {
     background: var(--pst-color-background);
 }
 
+a.stat-item {
+    text-decoration: none;
+    color: inherit;
+}
+
 .stat-value {
     font-size: 1.75rem;
     font-weight: 700;
@@ -925,14 +951,43 @@ hr {
 }
 
 /* ============================================
-   Section Headers - Clean without decorative underlines
+   Section Headers - Subtle styling
    ============================================ */
-h2 {
+
+/* Page titles (h1 from ===) - subtle background highlight */
+/* Exclude home page by targeting pages with h1 that aren't in the hero */
+article h1:not(.hero-title) {
+    background-color: rgba(93, 93, 122, 0.2);
+    padding: 0.5rem 0.75rem;
+    border-radius: 4px;
+    width: fit-content;
+}
+
+/* Home page h1s get h2 styling (underline, not background) */
+/* Target pages that contain .hero-section */
+article:has(.hero-section) h1 {
+    background-color: transparent;
+    padding: 0;
+    border-radius: 0;
+    width: auto;
+    padding-bottom: 0.4rem;
+    border-bottom: 1px solid var(--pst-color-border);
+}
+
+/* Remove headerlink from affecting h1 width */
+article h1 a.headerlink {
+    position: absolute;
+    margin-left: 0.5rem;
+}
+
+/* Section titles (h2 from ---) - subtle underline */
+article h2 {
     position: relative;
-    padding-bottom: 0;
+    padding-bottom: 0.4rem;
+    border-bottom: 1px solid var(--pst-color-border);
 }
 
-/* Remove the short underline pseudo-element */
+/* Remove any pseudo-element underlines */
 h2::after {
     display: none;
 }
@@ -1298,3 +1353,23 @@ html[data-theme="dark"] .segmented-tab-btn.active {
         padding: 0.5rem 0.75rem;
     }
 }
+
+/* ============================================
+   Theme-Aware Diagrams
+   ============================================ */
+
+/* Container for theme-aware images */
+.theme-aware-diagram {
+    width: 100%;
+    text-align: center;
+}
+
+.theme-aware-diagram img {
+    max-width: 100%;
+    height: auto;
+}
+
+/* Override pydata theme's white background for diagram images */
+html[data-theme="dark"] .theme-aware-diagram img.only-dark {
+    background-color: transparent !important;
+}