Files
55550f8df5 Adding out of the box support to TrainJob (#2560)
* Out-of-the-box support TrainJob

Signed-off-by: Ram Lau <[email protected]>

* Example for Pytorch Distributed

Signed-off-by: Ram Lau <[email protected]>

* Update examples/v1beta1/kubeflow-training-operator/trainjob-pytorch.yaml

Co-authored-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Ram Lau <[email protected]>

* Create folder for Trainer as suggested

Signed-off-by: Ram Lau <[email protected]>

* Movethe exmaple of trainjob to the new folder

Signed-off-by: Ram Lau <[email protected]>

* Ref the primaryContainerName to that of ClusterTrainingRuntime

Signed-off-by: Ram Lau <[email protected]>

* tenzen-y steps down from Katib approver role (#2561)

Signed-off-by: Yuki Iwai <[email protected]>
Signed-off-by: Ram Lau <[email protected]>

* Set Default value for TrainJob Success, Failure Condition and PrimaryPodLabels in the trial Template

Signed-off-by: Ram Lau <[email protected]>

* Enchance Handling for default value of Success, Fail Cond & Pod Label

Signed-off-by: Ram Lau <[email protected]>

* Bug fix for default value condition

Signed-off-by: Ram Lau <[email protected]>

* code format by hack/update-gofmt.sh

Signed-off-by: Ram Lau <[email protected]>

* add TrainJob trial Resources to cert manager config

Signed-off-by: Ram Lau <[email protected]>

* add trainjob to controller rbac

Signed-off-by: Ram Lau <[email protected]>

* Grant JobSet permission to Katib controller

Signed-off-by: Andrey Velichkevich <[email protected]>

* Remove create/delete RBAC for TrainJob

Signed-off-by: Andrey Velichkevich <[email protected]>

* Fix docker build with libpcre2

Signed-off-by: Andrey Velichkevich <[email protected]>

---------

Signed-off-by: Ram Lau <[email protected]>
Signed-off-by: Yuki Iwai <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Co-authored-by: Andrey Velichkevich <[email protected]>
Co-authored-by: Yuki Iwai <[email protected]>
2025-08-23 00:01:07 +00:00
..
2022-05-19 15:43:56 +00:00

Katib Examples

Katib is an open source project which uses Kubernetes CRD to run Automated Machine Learning (AutoML) tasks. To know more about Katib follow the official guides.

This directory contains examples of Katib Experiments in action. To install Katib on your Kubernetes cluster check the setup guide. You can use various Katib interfaces to run these examples.

For a complete description of the Katib Experiment specification follow the configuration guide

Local Cluster Example

Get started with Katib Experiments from your local laptop and Kind cluster by following this example.

AutoML Algorithms

The following examples show various AutoML algorithms in Katib.

Hyperparameter Tuning

Check the Hyperparameter Tuning Experiments for the following algorithms:

Check the Neural Architecture Search Experiments for the following algorithms:

Early Stopping

Improve your Hyperparameter Tuning Experiments with the following Early Stopping algorithms:

Katib Python SDK Examples

To learn more about Katib Python SDK check this directory.

Resume Katib Experiments

You can use different resume policies in Katib Experiments. Follow this guide to know more about it. Check the following examples:

Metrics Collector

Katib supports the various metrics collectors and metrics strategies. Check the official guide to know more about it. In this directory you can find the following examples:

Trial Template

You can specify different settings for your Trial template. To know more about it follow this guide. Check the following examples:

Trial Images

Check the following images for the Trial containers:

Katib with Kubeflow Training Operator

Katib has out of the box support for the Kubeflow Training Operators to perform Trial's Worker job. Check the following examples for the various distributed operators:

Katib with Kubeflow Pipelines

To run Katib with Kubeflow Pipelines check these examples.

Katib with Argo Workflows

To know more about using Argo Workflows in Katib check this directory.

Katib with Tekton Pipelines

To know more about using Tekton Pipelines in Katib check this directory.

FPGA Support in Katib Experiments

You can run Katib Experiments on FPGA based instances. For more information check these examples.