katib

module
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2025 License: Apache-2.0

README

Kubeflow Katib

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

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}
}

Directories

Path Synopsis
cmd
katib-controller/v1beta1 command
Katib-controller is a controller (operator) for Experiments and Trials
Katib-controller is a controller (operator) for Experiments and Trials
ui/v1beta1 command
hack
swagger command
pkg
apis/config/v1beta1
Package v1beta1 contains API Schema definitions for the config v1beta1 API group +kubebuilder:object:generate=true +groupName=config.kubeflow.org
Package v1beta1 contains API Schema definitions for the config v1beta1 API group +kubebuilder:object:generate=true +groupName=config.kubeflow.org
apis/controller
Package apis contains Kubernetes API groups.
Package apis contains Kubernetes API groups.
apis/controller/common
Package experiment contains experiment API versions
Package experiment contains experiment API versions
apis/controller/common/v1beta1
Package v1beta1 contains API Schema definitions for the common v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=common.kubeflow.org
Package v1beta1 contains API Schema definitions for the common v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=common.kubeflow.org
apis/controller/experiments
Package experiments contains experiment API versions
Package experiments contains experiment API versions
apis/controller/experiments/v1beta1
Package v1beta1 contains API Schema definitions for the experiment v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=experiment.kubeflow.org
Package v1beta1 contains API Schema definitions for the experiment v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=experiment.kubeflow.org
apis/controller/suggestions
Package suggestions contains suggestion API versions
Package suggestions contains suggestion API versions
apis/controller/suggestions/v1beta1
Package v1beta1 contains API Schema definitions for the suggestion v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=suggestion.kubeflow.org
Package v1beta1 contains API Schema definitions for the suggestion v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=suggestion.kubeflow.org
apis/controller/trials
Package trials contains trial API versions
Package trials contains trial API versions
apis/controller/trials/v1beta1
Package v1beta1 contains API Schema definitions for the trial v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=trial.kubeflow.org
Package v1beta1 contains API Schema definitions for the trial v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1 +k8s:defaulter-gen=TypeMeta +kubebuilder:subresource:status +groupName=trial.kubeflow.org
client/controller/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/controller/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/controller/clientset/versioned/typed/experiments/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/controller/clientset/versioned/typed/experiments/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/controller/clientset/versioned/typed/suggestions/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/controller/clientset/versioned/typed/suggestions/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/controller/clientset/versioned/typed/trials/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/controller/clientset/versioned/typed/trials/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
mock/v1beta1/api
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/db
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/experiment/manifest
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/experiment/suggestion
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/suggestion/suggestionclient
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/trial/managerclient
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
mock/v1beta1/util/katibclient
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL