Lightweight, model-agnostic hyperparameter tuning. Works standalone or alongside KANBoost.
Project description
Kantun
A lightweight, model-agnostic hyperparameter tuning library.
Built as a companion to KANBoost, but with zero
hard dependency on it — Kantun works with any estimator that follows a
scikit-learn-like fit/predict/predict_proba interface. Use it with
KANBoost, with RandomForestClassifier, with your own custom model —
your choice.
Why a separate package?
Not everyone using KANBoost needs hyperparameter search, and not everyone doing hyperparameter search needs KANBoost. Splitting them keeps each library's dependency footprint minimal and lets Kantun be useful on its own.
Install
pip install -r requirements.txt
pip install -e .
To also tune KANBoost models, install it separately:
pip install -e ../kanboost_project # local, or: pip install kanboost (once published to PyPI)
# repo: https://github.com/tuamah/kanboost
Quickstart
from kantun import KantunSearch
from kanboost import KANBoostClassifier
param_space = {
"n_estimators": [30, 60, 100],
"learning_rate": [0.1, 0.2, 0.3],
"kan_hidden": [3, 4, 6],
"kan_grid": [2, 3],
}
search = KantunSearch(
KANBoostClassifier,
param_space,
n_iter=10,
cv=3,
scoring="auc",
)
search.fit(X, y)
print(search.best_params_, search.best_score_)
best_model = search.best_estimator_ # ready to use
results_df = search.results_dataframe() # sorted leaderboard
Works with any sklearn-style estimator, not just KANBoost
from sklearn.ensemble import RandomForestClassifier
from kantun import KantunSearch
search = KantunSearch(
RandomForestClassifier,
{"n_estimators": [50, 100], "max_depth": [3, 5, None]},
n_iter=5, cv=3, scoring="f1",
use_eval_set=False, # RandomForestClassifier.fit() has no eval_set kwarg
)
search.fit(X, y)
How it decides whether to use early stopping
KantunSearch inspects the target model class's fit() signature. If
it finds an eval_set parameter (as KANBoost's estimators do), it
automatically passes eval_set=(X_val, y_val) on each fold so early
stopping kicks in during the search itself. You can override this with
use_eval_set=True/False explicitly.
Supported scoring
- Classification:
"auc"(default),"f1","accuracy" - Regression:
"neg_mse"(default),"neg_mae"
Search types
search_type="random"(default): samplesn_iterrandom combinationssearch_type="grid": tries every combination inparam_distributions
License
MIT — see LICENSE.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kantun-0.0.1.tar.gz.
File metadata
- Download URL: kantun-0.0.1.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76ffaaf67ca9b76b1981fc96443ce58b33d5b1907df863f8ca864fdf0c439539
|
|
| MD5 |
76461652dd920a9d831b6e4964aef191
|
|
| BLAKE2b-256 |
1105ea3914024750816dab191bfe17f44ee702ec5218105fc4109c9adf9fce90
|
File details
Details for the file kantun-0.0.1-py3-none-any.whl.
File metadata
- Download URL: kantun-0.0.1-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44b42f411c707f323e155e5d6159a834ce4f63ffd0f0736b8126857ec31c7d0c
|
|
| MD5 |
b5ebfe25b0189191de965897e21b350b
|
|
| BLAKE2b-256 |
fdbacf4df59018f61ba3fbf896c20601456aa1da90deada7a6f4d3c62011d11d
|