docs/api_essentials.rst
HyperparameterHunter API Essentials
***********************************
This section exposes the API for all the HyperparameterHunter functionality that will be necessary for most users.
Environment
===========
.. autoclass:: hyperparameter_hunter.environment.Environment
:noindex:
:members:
Experimentation
===============
.. autoclass:: hyperparameter_hunter.experiments.CVExperiment
:noindex:
:members: __init__
Hyperparameter Optimization
===========================
.. autoclass:: hyperparameter_hunter.optimization.backends.skopt.protocols.BayesianOptPro
:noindex:
.. automethod:: __init__
:noindex:
.. automethod:: forge_experiment
:noindex:
.. automethod:: go
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.optimization.backends.skopt.protocols.GradientBoostedRegressionTreeOptPro
:noindex:
.. automethod:: __init__
:noindex:
.. automethod:: forge_experiment
:noindex:
.. automethod:: go
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.optimization.backends.skopt.protocols.RandomForestOptPro
:noindex:
.. automethod:: __init__
:noindex:
.. automethod:: forge_experiment
:noindex:
.. automethod:: go
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.optimization.backends.skopt.protocols.ExtraTreesOptPro
:noindex:
.. automethod:: __init__
:noindex:
.. automethod:: forge_experiment
:noindex:
.. automethod:: go
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.optimization.backends.skopt.protocols.DummyOptPro
:noindex:
.. automethod:: __init__
:noindex:
.. automethod:: forge_experiment
:noindex:
.. automethod:: go
:noindex:
Hyperparameter Space
====================
.. autoclass:: hyperparameter_hunter.space.dimensions.Real
:noindex:
.. automethod:: __init__
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.space.dimensions.Integer
:noindex:
.. automethod:: __init__
:noindex:
----------------------------------------
.. autoclass:: hyperparameter_hunter.space.dimensions.Categorical
:noindex:
.. automethod:: __init__
:noindex:
Feature Engineering
===================
.. autoclass:: hyperparameter_hunter.feature_engineering.FeatureEngineer
:noindex:
:members: __init__
----------------------------------------
.. autoclass:: hyperparameter_hunter.feature_engineering.EngineerStep
:noindex:
:members: __init__
Extras
======
.. autofunction:: hyperparameter_hunter.callbacks.bases.lambda_callback
:noindex:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`