Automated Machine Learning on Kubernetes
Go to file
Yuki Iwai fe7a35dffa
tenzen-y steps down from Katib approver role (#2561)
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
2025-07-28 13:27:49 +00:00
.github [GSoC] Add e2e test for `tune` api with LLM hyperparameter optimization (#2420) 2025-06-26 14:13:16 +00:00
cmd [CI] optimize katib ui dockerfile (#2505) 2025-02-01 20:42:33 +00:00
conformance Fix Istio sidecar injection by moving from annotations to labels (#2527) 2025-05-09 17:52:41 +00:00
docs Fix Istio sidecar injection by moving from annotations to labels (#2527) 2025-05-09 17:52:41 +00:00
examples/v1beta1 Fix Istio sidecar injection by moving from annotations to labels (#2527) 2025-05-09 17:52:41 +00:00
hack chore: Upgrade Go version to 1.23 (#2526) 2025-07-16 19:17:38 +00:00
manifests/v1beta1 New fixing kustomize5 warning (#2549) 2025-05-13 04:31:20 +00:00
pkg Bump brace-expansion in /pkg/ui/v1beta1/frontend (#2551) 2025-06-12 04:40:51 +00:00
scripts/v1beta1 [feature] move manifest image references to ghcr (#2529) 2025-03-24 17:11:50 +00:00
sdk/python/v1beta1 [GSoC] Add e2e test for `tune` api with LLM hyperparameter optimization (#2420) 2025-06-26 14:13:16 +00:00
test [GSoC] Add e2e test for `tune` api with LLM hyperparameter optimization (#2420) 2025-06-26 14:13:16 +00:00
.dockerignore [UI] Remove Deprecated Katib UI (#2179) 2023-07-25 09:53:29 +00:00
.flake8 Enhance pre-commit hooks with flake8 and black (#2407) 2024-08-16 10:13:28 +00:00
.gcloudignore reduce build time (#84) 2018-05-15 06:24:27 -07:00
.gitignore [SDK] Support PyTorchJob as a Trial Worker (#2512) 2025-02-13 11:10:36 +00:00
.pre-commit-config.yaml Changes isort profile to black, to be fully compatible and adds 'pkg' dir for black and flake8 (#2413) 2024-08-22 15:33:57 +00:00
ADOPTERS.md Add PITS Global Data Recovery Services to the adopters list (#2160) 2023-05-26 15:44:21 +00:00
CHANGELOG.md chore(docs): Add Changelog Katib v0.18.0 (#2537) 2025-03-29 21:48:31 +00:00
CITATION.cff feat: add `CITATION.cff` file (#2547) 2025-04-18 16:47:24 +00:00
CONTRIBUTING.md chore: supporting the listen-address parameter on db-manager (#2465) 2025-01-22 00:03:41 +00:00
Dockerfile.conformance Fix conformance docker image (#2147) 2023-04-16 18:17:19 +00:00
LICENSE Initial commit 2018-04-03 10:07:13 -07:00
Makefile chore: Upgrade Go version to 1.23 (#2526) 2025-07-16 19:17:38 +00:00
OWNERS tenzen-y steps down from Katib approver role (#2561) 2025-07-28 13:27:49 +00:00
PROJECT Upgrade the kubebuilder to v3.2.0 and Kubernetes Go libraries to v1.22.2 (#1861) 2022-05-22 18:33:00 +00:00
README.md chore(docs): Add OpenSSF Badge (#2555) 2025-07-13 22:06:21 +00:00
ROADMAP.md Add Katib ROADMAP 2022/2023 (#2153) 2023-08-24 22:40:54 +00:00
SECURITY.md feat(docs): Guide to report security vulnerabilities (#2556) 2025-07-15 16:29:38 +00:00
go.mod Bump golang.org/x/crypto from 0.31.0 to 0.35.0 (#2543) 2025-07-16 20:08:39 +00:00
go.sum Bump golang.org/x/crypto from 0.31.0 to 0.35.0 (#2543) 2025-07-16 20:08:39 +00:00

README.md

Kubeflow Katib

Build Status Coverage Status Go Report Card Releases Slack Status OpenSSF Best Practices

logo

Kubeflow Katib is a Kubernetes-native project for automated machine learning (AutoML). Katib supports Hyperparameter Tuning, Early Stopping and Neural Architecture Search.

Katib is the project which is agnostic to machine learning (ML) frameworks. It can tune hyperparameters of applications written in any language of the users choice and natively supports many ML frameworks, such as TensorFlow, PyTorch, XGBoost, and others.

Katib can perform training jobs using any Kubernetes Custom Resources with out of the box support for Kubeflow Training Operator, Argo Workflows, Tekton Pipelines and many more.

Katib stands for secretary in Arabic.

Search Algorithms

Katib supports several search algorithms. Follow the Kubeflow documentation to know more about each algorithm and check the this guide to implement your custom algorithm.

Hyperparameter Tuning Neural Architecture Search Early Stopping
Random Search ENAS Median Stop
Grid Search DARTS
Bayesian Optimization
TPE
Multivariate TPE
CMA-ES
Sobol's Quasirandom Sequence
HyperBand
Population Based Training

To perform the above algorithms Katib supports the following frameworks:

Prerequisites

Please check the official Kubeflow documentation for prerequisites to install Katib.

Installation

Please follow the Kubeflow Katib guide for the detailed instructions on how to install Katib.

Installing the Control Plane

Run the following command to install the latest stable release of Katib control plane:

kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=v0.17.0"

Run the following command to install the latest changes of Katib control plane:

kubectl apply -k "github.com/kubeflow/katib.git/manifests/v1beta1/installs/katib-standalone?ref=master"

For the Katib Experiments check the complete examples list.

Installing the Python SDK

Katib implements a Python SDK to simplify creation of hyperparameter tuning jobs for Data Scientists.

Run the following command to install the latest stable release of Katib SDK:

pip install -U kubeflow-katib

Getting Started

Please refer to the getting started guide to quickly create your first hyperparameter tuning Experiment using the Python SDK.

Community

The following links provide information on how to get involved in the community:

Contributing

Please refer to the CONTRIBUTING guide.

Citation

If you use Katib in a scientific publication, we would appreciate citations to the following paper:

A Scalable and Cloud-Native Hyperparameter Tuning System, George et al., arXiv:2006.02085, 2020.

Bibtex entry:

@misc{george2020katib,
    title={A Scalable and Cloud-Native Hyperparameter Tuning System},
    author={Johnu George and Ce Gao and Richard Liu and Hou Gang Liu and Yuan Tang and Ramdoot Pydipaty and Amit Kumar Saha},
    year={2020},
    eprint={2006.02085},
    archivePrefix={arXiv},
    primaryClass={cs.DC}
}