Skip to content

Commit d740233

Browse files
committed
[DOC] add explanations + change title styling
1 parent 45b3daa commit d740233

7 files changed

Lines changed: 66 additions & 13 deletions

File tree

‎docs/source/_static/css/custom.css‎

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,17 @@ html[data-theme="dark"] {
132132
margin-top: 1.25rem;
133133
}
134134

135+
/* Remove vertical line from right sidebar */
136+
.bd-sidebar-secondary .toc-entry,
137+
.bd-sidebar-secondary nav.page-toc {
138+
border-left: none;
139+
}
140+
141+
/* Fixed position for right sidebar */
142+
.bd-sidebar-secondary {
143+
min-width: 200px;
144+
}
145+
135146
.pst-page-navigation-heading {
136147
margin-bottom: 0.5rem;
137148
}
@@ -930,14 +941,43 @@ hr {
930941
}
931942

932943
/* ============================================
933-
Section Headers - Clean without decorative underlines
944+
Section Headers - Subtle styling
934945
============================================ */
935-
h2 {
946+
947+
/* Page titles (h1 from ===) - subtle background highlight */
948+
/* Exclude home page by targeting pages with h1 that aren't in the hero */
949+
article h1:not(.hero-title) {
950+
background-color: rgba(93, 93, 122, 0.2);
951+
padding: 0.5rem 0.75rem;
952+
border-radius: 4px;
953+
width: fit-content;
954+
}
955+
956+
/* Home page h1s get h2 styling (underline, not background) */
957+
/* Target pages that contain .hero-section */
958+
article:has(.hero-section) h1 {
959+
background-color: transparent;
960+
padding: 0;
961+
border-radius: 0;
962+
width: auto;
963+
padding-bottom: 0.4rem;
964+
border-bottom: 1px solid var(--pst-color-border);
965+
}
966+
967+
/* Remove headerlink from affecting h1 width */
968+
article h1 a.headerlink {
969+
position: absolute;
970+
margin-left: 0.5rem;
971+
}
972+
973+
/* Section titles (h2 from ---) - subtle underline */
974+
article h2 {
936975
position: relative;
937-
padding-bottom: 0;
976+
padding-bottom: 0.4rem;
977+
border-bottom: 1px solid var(--pst-color-border);
938978
}
939979

940-
/* Remove the short underline pseudo-element */
980+
/* Remove any pseudo-element underlines */
941981
h2::after {
942982
display: none;
943983
}

‎docs/source/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ alongside direct interfaces to Optuna and scikit-learn optimizers.
6060
.. _features:
6161

6262
Features
63-
================
63+
========
6464

6565
What makes Hyperactive stand out for optimization tasks.
6666

@@ -136,7 +136,7 @@ What makes Hyperactive stand out for optimization tasks.
136136
----
137137

138138
Optimization Backends
139-
==================
139+
=====================
140140

141141
Hyperactive provides a unified interface to three powerful optimization backends.
142142
Choose the one that best fits your needs, or switch between them effortlessly.

‎docs/source/user_guide/experiments.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
Experiments
55
===========
66

7-
Define what to optimize.
7+
An experiment is the objective function that evaluates parameters and returns a score.
8+
It encapsulates your optimization problem separately from the optimizer, so you can
9+
swap algorithms without changing your evaluation code. Hyperactive supports custom
10+
functions and built-in classes for common ML tasks with cross-validation.
811

912
----
1013

‎docs/source/user_guide/integrations.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
Framework Integrations
55
======================
66

7-
Use Hyperactive with your favorite ML frameworks. These integrations provide
8-
drop-in replacements for tools like ``GridSearchCV``, letting you use any
9-
Hyperactive optimizer with minimal code changes.
7+
Hyperactive integrates with popular ML frameworks, providing drop-in replacements
8+
for tools like ``GridSearchCV``. Each ML framework has its own conventions for training and evaluation. The integration
9+
classes handle cross-validation setup, scoring metrics, and parameter translation, so
10+
you can use any optimizer with scikit-learn, sktime, skpro, or PyTorch models.
1011

1112
----
1213

‎docs/source/user_guide/introduction.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
Introduction
55
============
66

7-
Learn the fundamentals of Hyperactive and start optimizing in minutes.
7+
Optimization finds the best parameters from a set of possibilities. Evaluating every
8+
combination is usually impractical, so algorithms guide the search. Hyperactive provides
9+
a unified interface: define your problem once, then swap between different optimization
10+
algorithms without changing your code.
811

912
----
1013

‎docs/source/user_guide/optimizers/index.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@
44
Optimizers
55
==========
66

7-
Choose the right algorithm for your optimization problem.
87
Hyperactive provides 31 algorithms across 5 categories and 3 backends.
8+
Optimizers navigate the search space to find optimal parameters. Each implements a
9+
different strategy for balancing exploration (trying diverse regions) and exploitation
10+
(refining promising solutions). Local search methods like Hill Climbing work well for
11+
smooth landscapes. Population-based methods handle multiple local optima. Model-based
12+
methods like Bayesian Optimization minimize evaluations for expensive objective functions.
913

1014
----
1115

‎docs/source/user_guide/search_spaces.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Search Spaces
55
=============
66

7-
Define where to search for optimal parameters.
7+
The search space defines all configurations the optimizer can explore. Too narrow and
8+
you miss good solutions; too broad and the optimizer wastes iterations. In Hyperactive,
9+
search spaces are dictionaries mapping parameter names to lists of possible values.
810

911
----
1012

0 commit comments

Comments
 (0)