|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to Hyperactive are documented in this file. |
| 4 | + |
| 5 | +## [Unreleased] |
| 6 | + |
| 7 | +### Documentation |
| 8 | +- Add missing torch entries in README and documentation (#239) |
| 9 | +- Update landing page and styling |
| 10 | +- Change formatting and key features in README |
| 11 | +- Rework entire README with mermaid diagram and updated links |
| 12 | +- Fix links, add overview diagram hover effect |
| 13 | +- Hide toc parents |
| 14 | + |
| 15 | +### Bug Fixes |
| 16 | +- Fix `_score_params` and add tests; fix errors masked by `try... except` block (#237) |
| 17 | +- Add `warnings` to exception and fix bug |
| 18 | +- Override `_predict_proba` |
| 19 | + |
| 20 | +### Maintenance |
| 21 | +- Fix formatting |
| 22 | +- Remove unused dependency |
| 23 | +- Remove workflow |
| 24 | +- Update CONTRIBUTING.md |
| 25 | +- Update PULL_REQUEST_TEMPLATE.md |
| 26 | +- Change `n_iter` in examples |
| 27 | + |
| 28 | + |
| 29 | +## [v5.0.3] - 2025-12-15 |
| 30 | + |
| 31 | +### Documentation |
| 32 | +- Preload font, add animation of right sidebar |
| 33 | +- Add explanations, change title styling, add links |
| 34 | +- Rework user-guide, add diagrams |
| 35 | +- Change API reference optimizer pages |
| 36 | +- Add light/dark logo, fix logo font/text |
| 37 | +- Cleanup README, update links |
| 38 | +- Add link to legacy docs |
| 39 | +- Add nav-bar logo, change title and sidebar |
| 40 | +- Rework landing page: Quick Install, Examples, Integrations, Optimization backends |
| 41 | +- Add multiple pages and small corrections |
| 42 | +- Separate examples pages |
| 43 | +- Add Python examples via `literalinclude` with tests |
| 44 | +- Dynamically get supported Python versions, update CSS |
| 45 | +- Add static content and readthedocs skeleton |
| 46 | + |
| 47 | +### Maintenance |
| 48 | +- Add keywords and classifiers to `pyproject.toml` |
| 49 | +- Ensure tests are not skipped |
| 50 | +- Remove custom Docker container from CI, add Dockerfile |
| 51 | +- Move doctests, add dependency, fix doctest |
| 52 | +- Add `--no-cache-dir` flag, run targeted tests first |
| 53 | +- Add auto-pr-label and draft-changelog workflows |
| 54 | +- Add PR template |
| 55 | +- Python 3.14 compatibility and Python 3.9 end-of-life (#202) |
| 56 | + |
| 57 | +### Enhancements |
| 58 | +- Add PyTorch Lightning integration (#203) |
| 59 | +- `skpro` integration (#200) |
| 60 | + |
| 61 | +### Bug Fixes |
| 62 | +- Fix cmaes optimizer tests |
| 63 | + |
| 64 | +### Dependencies |
| 65 | +- Bump pytest from 9.0.1 to 9.0.2 (#218) |
| 66 | +- Bump pytest from 8.4.2 to 9.0.1 (#206) |
| 67 | + |
| 68 | + |
| 69 | +## [v5.0.2] - 2025-09-20 |
| 70 | + |
| 71 | +### Bug Fixes |
| 72 | +- Fix `TSCOptCV` integration for metric function input (#190) |
| 73 | + |
| 74 | + |
| 75 | +## [v5.0.1] - 2025-09-19 |
| 76 | + |
| 77 | +### Enhancements |
| 78 | +- Add optuna optional import (#187) |
| 79 | + |
| 80 | +### Documentation |
| 81 | +- Minor improvements to README: white background for logo, link table formatting (#186) |
| 82 | + |
| 83 | + |
| 84 | +## [v5.0.0] - 2025-09-14 |
| 85 | + |
| 86 | +### Breaking Changes |
| 87 | +- Complete v5 API redesign (#185) |
| 88 | +- Change `BaseOptimizer.run` method to `BaseOptimizer.solve` (#159) |
| 89 | +- Rename `toy` module to `bench` (#164) |
| 90 | +- Experiments: uniform call signature and terminology (#178) |
| 91 | +- Refactor callbacks/catch parameter |
| 92 | +- Remove `add_search` method |
| 93 | + |
| 94 | +### Enhancements |
| 95 | +- `sktime` integration for time series classification (#173) |
| 96 | +- `sktime` integration for forecasters (#157) |
| 97 | +- `optuna` optimizer interface (#155) |
| 98 | +- Add optimization algorithms from GFO (#127) |
| 99 | +- Parallelization backends for grid and random search (#150, #162) |
| 100 | +- Allowing old function API to be passed as experiment (#152) |
| 101 | +- Sign handling in experiments and optimization (#142) |
| 102 | +- Quick testing utility `check_estimator` (#130) |
| 103 | +- Implement sklearn-approved experiment class |
| 104 | +- Add composite optimizer class (enabling parallel via `add` method) |
| 105 | + |
| 106 | +### Bug Fixes |
| 107 | +- Fix selection direction, scorer handling, and fit kwargs; resolve sktime doctest (#182) |
| 108 | +- Fix `params` ignored in `SktimeForecastingExperiment` (#175) |
| 109 | +- Fix docstrings of benchmark toy experiments (#171) |
| 110 | +- Fix sklearn v1.7 compatibility (#138) |
| 111 | + |
| 112 | +### Maintenance |
| 113 | +- Lint entire repository using `pre-commit` (#156) |
| 114 | +- Code quality job (#151) |
| 115 | +- Raise `scikit-learn` bound to `<1.8` (#145, #149) |
| 116 | +- Cleanup v4 (#165) |
| 117 | +- Change `master` to `main` (#166) |
| 118 | +- Restore sklearn integration tests (#167) |
| 119 | +- Change examples to v5 (#168) |
| 120 | + |
| 121 | +### Dependencies |
| 122 | +- Bump pytest from 8.4.0 to 8.4.2 (#129, #137, #181) |
| 123 | + |
| 124 | + |
| 125 | +## [v4.8.0] - 2024-08-14 |
| 126 | + |
| 127 | +### Enhancements |
| 128 | +- Add support for numpy v2 and pandas v2 |
| 129 | +- Add testing for Python 3.12 |
| 130 | + |
| 131 | +### Maintenance |
| 132 | +- Transfer `setup.py` to `pyproject.toml` |
| 133 | +- Change project structure to src-layout |
| 134 | +- Read version from pyproject file |
| 135 | + |
| 136 | + |
| 137 | +## [v4.7.0] - 2024-07-29 |
| 138 | + |
| 139 | +### Enhancements |
| 140 | +- Add Genetic Algorithm and Differential Evolution optimizers |
| 141 | +- Add constrained optimization example to README |
| 142 | + |
| 143 | +### Maintenance |
| 144 | +- Add linter |
| 145 | +- Remove Python 3.5, 3.6, 3.7 from supported versions |
| 146 | +- Update requirement files |
| 147 | + |
| 148 | + |
| 149 | +## [v4.6.0] - 2023-10-27 |
| 150 | + |
| 151 | +### Enhancements |
| 152 | +- Add constrained optimization support (constraints parameter in API) |
| 153 | +- Add constraint class with support in optimization strategies |
| 154 | + |
| 155 | +### Documentation |
| 156 | +- Add examples: constrained optimization, grid search, Lipschitz optimization, stochastic hill climbing, direct algorithm, downhill simplex, Powell's method, pattern search, spiral optimization |
| 157 | + |
| 158 | + |
| 159 | +## [v4.5.0] - 2023-08-27 |
| 160 | + |
| 161 | +### Enhancements |
| 162 | +- Add early stopping support in optimization strategies |
| 163 | +- Print additional results from the objective function |
| 164 | +- Pass `early_stopping` parameter to optimization backend |
| 165 | +- Add type hints for basic API |
| 166 | + |
| 167 | +### Bug Fixes |
| 168 | +- Log warning if getting max score fails (when all scores are NaN) |
| 169 | +- Fix verbosity for progress-bar |
| 170 | +- Remove empty lines on no verbosity (#71) |
| 171 | + |
| 172 | + |
| 173 | +## [v4.4.0] - 2023-03-01 |
| 174 | + |
| 175 | +### Enhancements |
| 176 | +- Add optimization strategy feature with custom strategies |
| 177 | +- Add tqdm progress-bar with description and postfix |
| 178 | +- Add SpiralOptimization and LipschitzOptimizer |
| 179 | +- Add Direct Algorithm |
| 180 | +- Add Ray support for parallelization |
| 181 | +- Add `times` parameter to `.search_data()` for eval and iter times |
| 182 | +- Add callbacks feature |
| 183 | +- Add exception handling (catch parameter) |
| 184 | +- Add `pass_through` parameter |
| 185 | +- Add SMBO warm start support in optimization strategies (#54) |
| 186 | + |
| 187 | +### Bug Fixes |
| 188 | +- Create deepcopy of optimizer (#62) |
| 189 | + |
| 190 | +### Maintenance |
| 191 | +- Extend Python versions to 3.11 |
| 192 | +- Add contributing.md |
| 193 | + |
| 194 | +### Dependencies |
| 195 | +- Bump GFO requirement version |
| 196 | + |
| 197 | + |
| 198 | +## [v4.0.0] - 2021-12-01 |
| 199 | + |
| 200 | +Initial v4 release. |
0 commit comments