Skip to content

Commit 3ad724e

Browse files
committed
updated the docs
1 parent cd7b8a6 commit 3ad724e

4 files changed

Lines changed: 37 additions & 44 deletions

File tree

docs/source/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ on GitHub.
1919
examples/sequential_model_based
2020
examples/optuna_backend
2121
examples/sklearn_backend
22-
examples/skforecast_integration
22+
examples/skforecast_integration
2323
examples/integrations
2424
examples/other
2525
examples/interactive_tutorial

docs/source/examples/skforecast_integration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Example File
2121
- `skforecast_example.py <https://github.com/SimonBlanke/Hyperactive/blob/master/examples/skforecast/skforecast_example.py>`_
2222

2323

24-
Installation
25-
------------
24+
Skforecast Installation
25+
-----------------------
2626

2727
Install the optional integration dependency:
2828

docs/source/user_guide.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,6 @@ Guide Sections
117117
:link: user_guide/search_spaces
118118
:link-type: doc
119119

120-
:ref:`user_guide_integrations`
121-
Framework integrations for scikit-learn, sktime, skforecast, skpro, and PyTorch.
122-
Drop-in replacements for GridSearchCV and similar tools.
123-
124120
Best practices for parameter ranges,
125121
scaling, and granularity.
126122

docs/source/user_guide/integrations.rst

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -254,50 +254,47 @@ For deep learning hyperparameter optimization with PyTorch Lightning:
254254

255255
----
256256

257-
Tips
258-
----
259-
260-
.. grid:: 1 1 2 2
261-
:gutter: 3
257+
Choosing the Right Integration
258+
------------------------------
262259

263-
* - Framework
264-
- Integration Class
265-
- Use Case
266-
* - scikit-learn
267-
- ``OptCV``
268-
- Classification, regression, pipelines
269-
* - sktime
270-
- ``ForecastingOptCV``
271-
- Time series forecasting
272-
* - sktime
273-
- ``TSCOptCV``
274-
- Time series classification
260+
.. list-table::
261+
:header-rows: 1
262+
:widths: 25 25 50
263+
264+
* - Framework
265+
- Integration Class
266+
- Use Case
267+
* - scikit-learn
268+
- ``OptCV``
269+
- Classification, regression, pipelines
270+
* - sktime
271+
- ``ForecastingOptCV``
272+
- Time series forecasting
273+
* - sktime
274+
- ``TSCOptCV``
275+
- Time series classification
275276
* - skforecast
276277
- ``SkforecastOptCV``
277278
- Recursive time series forecasting
278-
* - skpro
279-
- ``SkproProbaRegExperiment``
280-
- Probabilistic regression
281-
* - PyTorch Lightning
282-
- ``TorchExperiment``
283-
- Deep learning models
284-
285-
.. grid-item-card:: Match the interface
279+
* - skpro
280+
- ``SkproProbaRegExperiment``
281+
- Probabilistic regression
282+
* - PyTorch Lightning
283+
- ``TorchExperiment``
284+
- Deep learning models
286285

287-
Use ``OptCV`` when you want sklearn-compatible behavior (fit/predict).
288-
Use experiment classes when you want more control over the optimization loop.
289286

290-
.. grid-item-card:: Consider evaluation cost
291-
292-
Deep learning experiments are expensive. Use efficient optimizers like
293-
``BayesianOptimizer`` with fewer iterations (10-50 instead of 100+).
287+
Tips for Using Integrations
288+
---------------------------
294289

295-
.. grid-item-card:: Use appropriate CV strategies
290+
1. **Match the interface**: Use ``OptCV`` when you want sklearn-compatible behavior
291+
(fit/predict). Use experiment classes when you want more control.
296292

297-
Match your cross-validation to your problem: ``TimeSeriesSplit`` for
298-
time series, stratified splits for imbalanced data.
293+
2. **Consider evaluation cost**: Deep learning experiments are expensive.
294+
Use efficient optimizers like ``BayesianOptimizer`` with fewer iterations.
299295

300-
.. grid-item-card:: Start simple
296+
3. **Use appropriate CV strategies**: Match your cross-validation to your problem
297+
(e.g., ``TimeSeriesSplit`` for time series, stratified splits for imbalanced data).
301298

302-
Begin with ``RandomSearch`` to establish baselines before using
303-
more sophisticated optimizers.
299+
4. **Start simple**: Begin with ``GridSearch`` or ``RandomSearch`` to establish
300+
baselines before using more sophisticated optimizers.

0 commit comments

Comments
 (0)