Skip to content

Commit b558859

Browse files
committed
[DOC] add static content to docs
1 parent 1f329ab commit b558859

19 files changed

Lines changed: 3554 additions & 156 deletions

docs/source/_static/css/custom.css

Lines changed: 419 additions & 1 deletion
Large diffs are not rendered by default.
180 KB
Loading
180 KB
Loading

docs/source/about.rst

Lines changed: 90 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
About
55
=====
66

7-
.. note::
8-
9-
This page is under construction. Content will be added in the future.
7+
Hyperactive is an optimization and data collection toolbox for convenient and fast
8+
prototyping of computationally expensive models.
109

1110
.. toctree::
1211
:maxdepth: 1
@@ -15,7 +14,94 @@ About
1514
about/history
1615
about/license
1716

17+
1818
About Hyperactive
1919
-----------------
2020

21-
*Coming soon: Information about the Hyperactive project.*
21+
Hyperactive provides a unified interface for hyperparameter optimization using
22+
various gradient-free optimization algorithms. It supports optimization for
23+
scikit-learn, sktime, skpro, and PyTorch Lightning models, as well as custom
24+
objective functions.
25+
26+
27+
Mission
28+
^^^^^^^
29+
30+
Hyperactive aims to make hyperparameter optimization accessible and practical for
31+
machine learning practitioners. By providing a unified API across many optimization
32+
algorithms and ML frameworks, it reduces the barrier to finding optimal model
33+
configurations.
34+
35+
36+
Key Features
37+
^^^^^^^^^^^^
38+
39+
- **20+ Optimization Algorithms**: From simple hill climbing to advanced Bayesian
40+
optimization, population methods, and Optuna integration.
41+
42+
- **Experiment-Based Architecture**: Clean separation between what to optimize
43+
(experiments) and how to optimize (algorithms).
44+
45+
- **Framework Integrations**: First-class support for scikit-learn, sktime, skpro,
46+
and PyTorch Lightning.
47+
48+
- **Flexible Search Spaces**: Discrete, continuous, and mixed parameter spaces
49+
using familiar NumPy/list syntax.
50+
51+
- **Production Ready**: Battle-tested since 2019 with comprehensive testing and
52+
active maintenance.
53+
54+
55+
Related Projects
56+
^^^^^^^^^^^^^^^^
57+
58+
Hyperactive is part of a larger ecosystem:
59+
60+
.. list-table::
61+
:header-rows: 1
62+
:widths: 30 70
63+
64+
* - Project
65+
- Description
66+
* - `Gradient-Free-Optimizers <https://github.com/SimonBlanke/Gradient-Free-Optimizers>`_
67+
- Core optimization algorithms used by Hyperactive
68+
* - `Search-Data-Collector <https://github.com/SimonBlanke/search-data-collector>`_
69+
- Save search data during optimization to CSV files
70+
* - `Search-Data-Explorer <https://github.com/SimonBlanke/search-data-explorer>`_
71+
- Visualize search data with Plotly in a Streamlit dashboard
72+
73+
74+
Sponsorship
75+
^^^^^^^^^^^
76+
77+
Hyperactive is sponsored by the
78+
`German Center for Open Source AI (GC.OS) <https://gc-os-ai.github.io/>`_.
79+
80+
.. image:: https://img.shields.io/badge/GC.OS-Sponsored%20Project-orange.svg?style=for-the-badge&colorA=0eac92&colorB=2077b4
81+
:target: https://gc-os-ai.github.io/
82+
:alt: GC.OS Sponsored
83+
84+
85+
Citing Hyperactive
86+
^^^^^^^^^^^^^^^^^^
87+
88+
If you use Hyperactive in your research, please cite it:
89+
90+
.. code-block:: bibtex
91+
92+
@Misc{hyperactive2021,
93+
author = {{Simon Blanke}},
94+
title = {{Hyperactive}: An optimization and data collection toolbox
95+
for convenient and fast prototyping of computationally
96+
expensive models.},
97+
howpublished = {\url{https://github.com/SimonBlanke}},
98+
year = {since 2019}
99+
}
100+
101+
102+
Community
103+
^^^^^^^^^
104+
105+
- **GitHub**: `SimonBlanke/Hyperactive <https://github.com/SimonBlanke/Hyperactive>`_
106+
- **Discord**: `Join the community <https://discord.gg/7uKdHfdcJG>`_
107+
- **LinkedIn**: `German Center for Open Source AI <https://www.linkedin.com/company/german-center-for-open-source-ai>`_

docs/source/about/history.rst

Lines changed: 101 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,109 @@
44
History
55
=======
66

7-
.. note::
7+
This page documents the history and evolution of Hyperactive.
88

9-
This page is under construction. Content will be added in the future.
109

1110
Project History
1211
---------------
1312

14-
*Coming soon: The history and evolution of Hyperactive.*
13+
Hyperactive was created in 2018 by Simon Blanke to address the need for a flexible,
14+
unified interface for hyperparameter optimization in machine learning workflows.
15+
16+
17+
Timeline
18+
^^^^^^^^
19+
20+
**2018 - Project Creation**
21+
Hyperactive was first released as an open-source project, providing a collection
22+
of gradient-free optimization algorithms accessible through a simple Python API.
23+
24+
**2019 - Growing Adoption**
25+
The project gained traction in the machine learning community, with users
26+
appreciating its straightforward interface and variety of optimization algorithms.
27+
28+
**2020-2021 - Ecosystem Expansion**
29+
Related projects were developed to complement Hyperactive:
30+
31+
- **Gradient-Free-Optimizers**: The optimization backend was extracted into its
32+
own package, allowing for more modular development.
33+
- **Search-Data-Collector**: Tools for saving optimization results.
34+
- **Search-Data-Explorer**: Visualization dashboard for exploring search data.
35+
36+
**2022-2023 - Continued Development**
37+
Active maintenance continued with bug fixes, new algorithms, and improved
38+
documentation. The user base continued to grow.
39+
40+
**2024 - Version 5.0 Redesign**
41+
Major architecture redesign introducing:
42+
43+
- **Experiment-based architecture**: Clean separation between optimization
44+
problems (experiments) and optimization algorithms (optimizers).
45+
- **Enhanced integrations**: Improved support for scikit-learn, sktime, skpro,
46+
and PyTorch Lightning.
47+
- **Optuna backend**: Integration with Optuna's optimization algorithms.
48+
- **Modern Python support**: Support for Python 3.10 through 3.14.
49+
50+
**2024 - GC.OS Sponsorship**
51+
Hyperactive became a sponsored project of the German Center for Open Source AI
52+
(GC.OS), ensuring continued development and maintenance.
53+
54+
55+
Version History
56+
---------------
57+
58+
Major Versions
59+
^^^^^^^^^^^^^^
60+
61+
.. list-table::
62+
:header-rows: 1
63+
:widths: 15 85
64+
65+
* - Version
66+
- Highlights
67+
* - v5.0
68+
- Experiment-based architecture, Optuna integration, modern Python support
69+
* - v4.x
70+
- Improved API stability, additional optimizers
71+
* - v3.x
72+
- Search data collection features, expanded algorithm library
73+
* - v2.x
74+
- Multi-processing support, warm starting
75+
* - v1.x
76+
- Initial public release with core optimization algorithms
77+
78+
79+
Breaking Changes
80+
^^^^^^^^^^^^^^^^
81+
82+
Major version updates (e.g., v4 → v5) may include breaking API changes.
83+
If you're upgrading from an older version:
84+
85+
1. Check the `GitHub releases <https://github.com/SimonBlanke/Hyperactive/releases>`_
86+
for migration guides.
87+
2. Update your code to use the new API patterns.
88+
3. Alternatively, pin your version to continue using the old API.
89+
90+
.. code-block:: bash
91+
92+
# Upgrade to latest
93+
pip install hyperactive --upgrade
94+
95+
# Or pin to specific version
96+
pip install hyperactive==4.x.x
97+
98+
99+
Future Roadmap
100+
--------------
101+
102+
Hyperactive continues to evolve. Planned improvements include:
103+
104+
- Additional optimization algorithms
105+
- Enhanced visualization tools
106+
- Improved distributed computing support
107+
- More framework integrations
108+
- Performance optimizations
109+
110+
For the latest roadmap, see the
111+
`GitHub Issues <https://github.com/SimonBlanke/Hyperactive/issues>`_ and
112+
`Discussions <https://github.com/SimonBlanke/Hyperactive/discussions>`_.

docs/source/about/license.rst

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,96 @@
44
License
55
=======
66

7-
.. note::
7+
Hyperactive is open-source software released under the MIT License.
88

9-
This page is under construction. Content will be added in the future.
109

1110
MIT License
1211
-----------
1312

14-
*Coming soon: Full text of the MIT License.*
13+
.. code-block:: text
14+
15+
MIT License
16+
17+
Copyright (c) 2018 Simon Blanke
18+
19+
Permission is hereby granted, free of charge, to any person obtaining a copy
20+
of this software and associated documentation files (the "Software"), to deal
21+
in the Software without restriction, including without limitation the rights
22+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
23+
copies of the Software, and to permit persons to whom the Software is
24+
furnished to do so, subject to the following conditions:
25+
26+
The above copyright notice and this permission notice shall be included in all
27+
copies or substantial portions of the Software.
28+
29+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35+
SOFTWARE.
36+
37+
38+
What This Means
39+
---------------
40+
41+
The MIT License is a permissive open-source license that allows you to:
42+
43+
**You Can:**
44+
45+
- Use Hyperactive for commercial projects
46+
- Modify the source code
47+
- Distribute copies
48+
- Use it in private projects
49+
- Sublicense the code
50+
51+
**Requirements:**
52+
53+
- Include the copyright notice and license text in any copies or substantial
54+
portions of the software
55+
56+
**Limitations:**
57+
58+
- The software is provided "as is" without warranty
59+
- The authors are not liable for any damages
60+
61+
62+
Third-Party Licenses
63+
--------------------
64+
65+
Hyperactive depends on several third-party packages, each with their own licenses:
66+
67+
.. list-table::
68+
:header-rows: 1
69+
:widths: 30 30 40
70+
71+
* - Package
72+
- License
73+
- Purpose
74+
* - NumPy
75+
- BSD-3-Clause
76+
- Numerical operations
77+
* - pandas
78+
- BSD-3-Clause
79+
- Data manipulation
80+
* - scikit-learn
81+
- BSD-3-Clause
82+
- Machine learning integration
83+
* - Gradient-Free-Optimizers
84+
- MIT
85+
- Core optimization algorithms
86+
* - tqdm
87+
- MIT/MPL-2.0
88+
- Progress bars
89+
90+
All dependencies use permissive open-source licenses compatible with commercial use.
91+
92+
93+
Questions
94+
---------
95+
96+
For questions about licensing or usage rights, please contact:
97+
98+
- **Email**: simon.blanke@yahoo.com
99+
- **GitHub Issues**: `Report an issue <https://github.com/SimonBlanke/Hyperactive/issues>`_

0 commit comments

Comments
 (0)