BTB
0.4.0
Overview
Installation
Stable Release
From source
Quickstart
Prepare a scoring function
Define the tunable hyperparameters
Start the searching process
User Guides
Tuning
Defining a Tuning Problem
What is a Hyperparameter?
Creating a HyperParam
BooleanHyperParam
CategoricalHyperParam
FloatHyperParam
IntHyperParam
What is Tunable?
Creating a Tunable
Using HyperParam instances
Using a dict representation
What is a Tuner?
Using a Tuner
Creating a Tuner
Propose
Record
Tuning loop example
Implemented tuners
Leaderboard
Selection
What is a Selection problem?
What is a Selector ?
Using a Selector
Creating a Selector
Select
Selection loop example
BTBSession
What is BTBSession
Creating a BTBSession
Prepare a scoring function
Define the tunable hyperparameters
Create BTBSession instance
Using BTBSession
Run
Exploring the result
Resume session
Fitting the best solution
Benchmarking BTB
The Benchmarking process
Challenges
Machine Learning Challenges
Mathematical Optimization Challenges
Tuning Functions
Tuning functions under comparison
To introduce a new Tuning Function:
Running the Benchmarking
Install
System Requierements
Python installation
Runnig the Benchmarking using python
Benchmark Arguments
Tuners
Challenges
Iterations
Storing the results
Our latest Results
Kubernetes
Credits
Kubernetes
Requirements
Kubernetes Cluster
Admin Access
Dask Function
Benchmark Configuration
Configuration Format
run
dask_cluster
output
Configuration Examples
Run a function on Kubernetes.
Usage Example
Results
Resources
API Reference
btb.selection package
btb.selection.best module
btb.selection.custom_selector module
btb.selection.hierarchical module
btb.selection.pure module
btb.selection.recent module
btb.selection.selector module
btb.selection.ucb1 module
btb.selection.uniform module
btb.tuning package
btb.tuning.acquisition package
btb.tuning.acquisition.base module
btb.tuning.acquisition.expected_improvement module
btb.tuning.acquisition.predicted_score module
btb.tuning.hyperparams package
btb.tuning.hyperparams.base module
btb.tuning.hyperparams.boolean module
btb.tuning.hyperparams.categorical module
btb.tuning.hyperparams.numerical module
btb.tuning.metamodels package
btb.tuning.metamodels.base module
btb.tuning.metamodels.gaussian_process module
btb.tuning.tuners package
btb.tuning.tuners.base module
btb.tuning.tuners.gaussian_process module
btb.tuning.tuners.uniform module
btb.tuning.tunable module
btb.session module
Contributing
History
Credits
BTB
Docs
»
Index
Edit on GitHub
Index
_
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
N
|
P
|
R
|
S
|
T
|
U
_
_model (btb.tuning.metamodels.base.BaseMetaModel attribute)
_MODEL_CLASS (btb.tuning.metamodels.base.BaseMetaModel attribute)
(btb.tuning.metamodels.gaussian_process.GaussianCopulaProcessMetaModel attribute)
(btb.tuning.metamodels.gaussian_process.GaussianProcessMetaModel attribute)
(btb.tuning.metamodels.GaussianProcessMetaModel attribute)
_MODEL_KWARGS (btb.tuning.metamodels.base.BaseMetaModel attribute)
_model_kwargs (btb.tuning.metamodels.base.BaseMetaModel attribute)
_MODEL_KWARGS (btb.tuning.metamodels.gaussian_process.GaussianCopulaProcessMetaModel attribute)
(btb.tuning.metamodels.gaussian_process.GaussianProcessMetaModel attribute)
(btb.tuning.metamodels.GaussianProcessMetaModel attribute)
B
bandit() (btb.selection.selector.Selector method)
(btb.selection.UCB1 method)
(btb.selection.ucb1.UCB1 method)
BaseAcquisition (class in btb.tuning.acquisition.base)
BaseHyperParam (class in btb.tuning.hyperparams.base)
BaseMetaModel (class in btb.tuning.metamodels.base)
BaseMetaModelTuner (class in btb.tuning.tuners.base)
BaseTuner (class in btb.tuning.tuners.base)
best_proposal (btb.BTBSession attribute)
,
[1]
(btb.session.BTBSession attribute)
,
[1]
best_score (btb.BTBSession attribute)
,
[1]
(btb.session.BTBSession attribute)
,
[1]
BestKReward (class in btb.selection)
(class in btb.selection.best)
BestKVelocity (class in btb.selection)
(class in btb.selection.best)
BooleanHyperParam (class in btb.tuning)
(class in btb.tuning.hyperparams)
(class in btb.tuning.hyperparams.boolean)
btb (module)
btb.selection (module)
btb.selection.best (module)
btb.selection.custom_selector (module)
btb.selection.hierarchical (module)
btb.selection.pure (module)
btb.selection.recent (module)
btb.selection.selector (module)
btb.selection.ucb1 (module)
btb.selection.uniform (module)
btb.session (module)
btb.tuning (module)
btb.tuning.acquisition (module)
btb.tuning.acquisition.base (module)
btb.tuning.acquisition.expected_improvement (module)
btb.tuning.acquisition.predicted_score (module)
btb.tuning.hyperparams (module)
btb.tuning.hyperparams.base (module)
btb.tuning.hyperparams.boolean (module)
btb.tuning.hyperparams.categorical (module)
btb.tuning.hyperparams.numerical (module)
btb.tuning.metamodels (module)
btb.tuning.metamodels.base (module)
btb.tuning.metamodels.gaussian_process (module)
btb.tuning.tunable (module)
btb.tuning.tuners (module)
btb.tuning.tuners.base (module)
btb.tuning.tuners.gaussian_process (module)
btb.tuning.tuners.uniform (module)
BTBSession (class in btb)
(class in btb.session)
C
cardinality (btb.tuning.BooleanHyperParam attribute)
(btb.tuning.FloatHyperParam attribute)
(btb.tuning.hyperparams.base.BaseHyperParam attribute)
,
[1]
(btb.tuning.hyperparams.boolean.BooleanHyperParam attribute)
(btb.tuning.hyperparams.BooleanHyperParam attribute)
(btb.tuning.hyperparams.FloatHyperParam attribute)
(btb.tuning.hyperparams.numerical.FloatHyperParam attribute)
(btb.tuning.Tunable attribute)
,
[1]
(btb.tuning.tunable.Tunable attribute)
,
[1]
CategoricalHyperParam (class in btb.tuning)
(class in btb.tuning.hyperparams)
(class in btb.tuning.hyperparams.categorical)
compute_rewards() (btb.selection.best.BestKReward method)
(btb.selection.best.BestKVelocity method)
(btb.selection.BestKReward method)
(btb.selection.BestKVelocity method)
(btb.selection.pure.PureBestKVelocity method)
(btb.selection.PureBestKVelocity method)
(btb.selection.recent.RecentKReward method)
(btb.selection.recent.RecentKVelocity method)
(btb.selection.RecentKReward method)
(btb.selection.RecentKVelocity method)
(btb.selection.selector.Selector method)
CustomSelector (class in btb.selection.custom_selector)
D
default (btb.tuning.hyperparams.base.BaseHyperParam attribute)
dimensions (btb.tuning.BooleanHyperParam attribute)
(btb.tuning.hyperparams.base.BaseHyperParam attribute)
,
[1]
(btb.tuning.hyperparams.boolean.BooleanHyperParam attribute)
(btb.tuning.hyperparams.BooleanHyperParam attribute)
(btb.tuning.hyperparams.IntHyperParam attribute)
(btb.tuning.hyperparams.numerical.IntHyperParam attribute)
(btb.tuning.hyperparams.numerical.NumericalHyperParam attribute)
(btb.tuning.IntHyperParam attribute)
(btb.tuning.Tunable attribute)
(btb.tuning.tunable.Tunable attribute)
E
errors (btb.BTBSession attribute)
,
[1]
(btb.session.BTBSession attribute)
,
[1]
ExpectedImprovementAcquisition (class in btb.tuning.acquisition)
(class in btb.tuning.acquisition.expected_improvement)
F
FloatHyperParam (class in btb.tuning)
(class in btb.tuning.hyperparams)
(class in btb.tuning.hyperparams.numerical)
from_dict() (btb.tuning.Tunable class method)
(btb.tuning.tunable.Tunable class method)
G
GaussianCopulaProcessMetaModel (class in btb.tuning.metamodels.gaussian_process)
GaussianProcessMetaModel (class in btb.tuning.metamodels)
(class in btb.tuning.metamodels.gaussian_process)
GCPEiTuner (class in btb.tuning)
(class in btb.tuning.tuners)
(class in btb.tuning.tuners.gaussian_process)
GCPTuner (class in btb.tuning)
(class in btb.tuning.tuners)
(class in btb.tuning.tuners.gaussian_process)
get_defaults() (btb.tuning.Tunable method)
(btb.tuning.tunable.Tunable method)
GPEiTuner (class in btb.tuning)
(class in btb.tuning.tuners)
(class in btb.tuning.tuners.gaussian_process)
GPTuner (class in btb.tuning)
(class in btb.tuning.tuners)
(class in btb.tuning.tuners.gaussian_process)
H
handle_error() (btb.BTBSession method)
(btb.session.BTBSession method)
HierarchicalByAlgorithm (class in btb.selection)
(class in btb.selection.hierarchical)
hyperparams (btb.tuning.Tunable attribute)
,
[1]
(btb.tuning.tunable.Tunable attribute)
,
[1]
I
IntHyperParam (class in btb.tuning)
(class in btb.tuning.hyperparams)
(class in btb.tuning.hyperparams.numerical)
inverse_transform() (btb.tuning.hyperparams.base.BaseHyperParam method)
(btb.tuning.Tunable method)
(btb.tuning.tunable.Tunable method)
iterations (btb.BTBSession attribute)
,
[1]
(btb.session.BTBSession attribute)
,
[1]
N
names (btb.tuning.Tunable attribute)
(btb.tuning.tunable.Tunable attribute)
NO_DEFAULT (btb.tuning.CategoricalHyperParam attribute)
(btb.tuning.hyperparams.categorical.CategoricalHyperParam attribute)
(btb.tuning.hyperparams.CategoricalHyperParam attribute)
NumericalHyperParam (class in btb.tuning.hyperparams.numerical)
P
PredictedScoreAcquisition (class in btb.tuning.acquisition)
(class in btb.tuning.acquisition.predicted_score)
proposals (btb.BTBSession attribute)
,
[1]
(btb.session.BTBSession attribute)
,
[1]
propose() (btb.BTBSession method)
(btb.session.BTBSession method)
(btb.tuning.tuners.base.BaseTuner method)
PureBestKVelocity (class in btb.selection)
(class in btb.selection.pure)
R
raw_scores (btb.tuning.tuners.base.BaseTuner attribute)
RecentKReward (class in btb.selection)
(class in btb.selection.recent)
RecentKVelocity (class in btb.selection)
(class in btb.selection.recent)
record() (btb.BTBSession method)
(btb.session.BTBSession method)
(btb.tuning.tuners.base.BaseMetaModelTuner method)
(btb.tuning.tuners.base.BaseTuner method)
run() (btb.BTBSession method)
(btb.session.BTBSession method)
S
sample() (btb.tuning.BooleanHyperParam method)
(btb.tuning.CategoricalHyperParam method)
(btb.tuning.FloatHyperParam method)
(btb.tuning.hyperparams.base.BaseHyperParam method)
(btb.tuning.hyperparams.boolean.BooleanHyperParam method)
(btb.tuning.hyperparams.BooleanHyperParam method)
(btb.tuning.hyperparams.categorical.CategoricalHyperParam method)
(btb.tuning.hyperparams.CategoricalHyperParam method)
(btb.tuning.hyperparams.FloatHyperParam method)
(btb.tuning.hyperparams.IntHyperParam method)
(btb.tuning.hyperparams.numerical.FloatHyperParam method)
(btb.tuning.hyperparams.numerical.IntHyperParam method)
(btb.tuning.IntHyperParam method)
(btb.tuning.Tunable method)
(btb.tuning.tunable.Tunable method)
scores (btb.tuning.tuners.base.BaseMetaModelTuner attribute)
(btb.tuning.tuners.base.BaseTuner attribute)
select() (btb.selection.best.BestKReward method)
(btb.selection.BestKReward method)
(btb.selection.custom_selector.CustomSelector method)
(btb.selection.hierarchical.HierarchicalByAlgorithm method)
(btb.selection.HierarchicalByAlgorithm method)
(btb.selection.pure.PureBestKVelocity method)
(btb.selection.PureBestKVelocity method)
(btb.selection.recent.RecentKReward method)
(btb.selection.RecentKReward method)
(btb.selection.selector.Selector method)
(btb.selection.Uniform method)
(btb.selection.uniform.Uniform method)
Selector (class in btb.selection.selector)
StopTuning
,
[1]
T
transform() (btb.tuning.hyperparams.base.BaseHyperParam method)
(btb.tuning.Tunable method)
(btb.tuning.tunable.Tunable method)
trials (btb.tuning.tuners.base.BaseMetaModelTuner attribute)
(btb.tuning.tuners.base.BaseTuner attribute)
tunable (btb.tuning.tuners.base.BaseMetaModelTuner attribute)
(btb.tuning.tuners.base.BaseTuner attribute)
Tunable (class in btb.tuning)
(class in btb.tuning.tunable)
U
UCB1 (class in btb.selection)
(class in btb.selection.ucb1)
Uniform (class in btb.selection)
(class in btb.selection.uniform)
UniformTuner (class in btb.tuning)
(class in btb.tuning.tuners)
(class in btb.tuning.tuners.uniform)