A minimal framework for running hyperparameter tuning
Project description
hpt
This repository is under construction :construction:
A minimal hyperparameter tuning framework to help you train hundreds of models.
It's essentially a set of helpful wrappers over optuna.
Install
Install package from PyPI:
pip install hyperparameter-tuning
Getting started
from hpt.tuner import ObjectiveFunction, OptunaTuner
obj_func = ObjectiveFunction(
X_train, y_train, X_test, y_test,
hyperparameter_space=HYPERPARAM_SPACE_PATH,
eval_metric='accuracy',
s_train=s_train,
s_val=s_test,
threshold=0.50,
)
tuner = OptunaTuner(obj_func) # NOTE: can pass other useful study kwargs here (e.g. storage)
# Then just run optimize as you would for an optuna.Study object
tuner.optimize(n_trials=20, n_jobs=4)
# Results are stored in tuner.results
tuner.results
Defining a hyperparameter space
The hyperparameter space is provided either path to a YAML file, or as a dict
with the same structure.
Example hyperparameter spaces here and
here.
The YAML file must follow this structure:
# One or more top-level algorithms
DT:
# Full classpath of algorithm's constructor
classpath: sklearn.tree.DecisionTreeClassifier
# One or more key-word arguments to be passed to the constructor
kwargs:
# Kwargs may be sampled from a distribution
max_depth:
type: int # either 'int' or 'float'
range: [ 10, 100 ] # minimum and maximum values
log: True # (optionally) whether to use logarithmic scale
# Kwargs may be sampled from a fixed set of categories
criterion:
- 'gini'
- 'entropy'
# Kwargs may be a pre-defined value
min_samples_split: 4
# You may explore multiple algorithms at once
LR:
classpath: sklearn.linear_model.LogisticRegression
kwargs:
# An example of a float hyperparameter
C:
type: float
range: [ 0.01, 1.0 ]
log: True
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hyperparameter-tuning-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc6efa7e15e92e03971ddd0b7bebf1443e82d5b4a7483021acb228e0293f108e |
|
MD5 | 3a7d850779433290c4636a341f5fc2eb |
|
BLAKE2b-256 | cfcd6fc27afd42097e96c47c37255a6c9e895af96d71600a392a1ba6e3179228 |
Close
Hashes for hyperparameter_tuning-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9335f0e943b602a31cc0e34204a3ad0a580fdb518df7c4c65dcd912223fc9bb2 |
|
MD5 | dfce414bdcccac8dc268a7dcda63e689 |
|
BLAKE2b-256 | c61c9e7eb13f744736ac2473b117090c96c1976bbe923db2dc0a162e6d06b01b |