Kubeflow Katib

Kubeflow Katib 是一个原生运行于 Kubernetes 上的自动化机器学习（AutoML）项目。 Katib 支持 超参数调优、 早停法 和 神经架构搜索。

Katib 是一个与机器学习框架无关的项目。 它可以对用户选择的任何语言编写的应用程序进行超参数调优，并且原生支持多种机器学习框架，例如 TensorFlow、 PyTorch、 XGBoost 等等。

Katib 可以使用任何 Kubernetes 自定义资源 来执行训练任务，并且开箱即用地支持 Kubeflow Training Operator、 Argo Workflows、 Tekton Pipelines 以及其他许多工具。

“Katib”在阿拉伯语中意为“秘书”。

搜索算法

Katib 支持多种搜索算法。请参阅 Kubeflow 文档 以了解每种算法的详细信息，并查看 此指南 以实现您自定义的算法。

超参数调优	神经架构搜索	早停法
随机搜索	ENAS	中位数停止规则
网格搜索	DARTS
贝叶斯优化
TPE
多变量 TPE
CMA-ES
索博尔准随机序列
HyperBand
基于人群的训练

为了执行上述算法，Katib 支持以下框架：

• Goptuna
• Hyperopt
• Optuna
• Scikit Optimize

先决条件

请查阅 官方 Kubeflow 文档 以了解安装 Katib 的先决条件。

安装

请按照 Kubeflow Katib 指南 中的详细说明来安装 Katib。

安装控制平面

运行以下命令以安装 Katib 控制平面的最新稳定版本：

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

运行以下命令以安装 Katib 控制平面的最新更改：

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

有关 Katib 实验，请参阅 完整示例列表。

安装 Python SDK

Katib 实现了 Python SDK， 以简化数据科学家创建超参数调优作业的过程。

运行以下命令以安装 Katib SDK 的最新稳定版本：

pip install -U kubeflow-katib

入门

请参阅入门指南，使用 Python SDK 快速创建您的第一个超参数调优实验。

社区

以下链接提供了有关如何参与社区的信息：

• 参加每两周一次的 AutoML 和训练工作组社区会议。
• 加入我们的 #kubeflow-katib Slack 频道。
• 查看哪些组织正在使用 Katib 以及关于 Katib 项目的演讲。

贡献

请参阅贡献指南。

引用

如果您在科学出版物中使用 Katib，我们非常感谢您引用以下论文：

可扩展且云原生的超参数调优系统, George 等, arXiv:2006.02085, 2020。

BibTeX 条目如下：

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

Kubeflow Katib 快速上手指南

Kubeflow Katib 是一个云原生的自动化机器学习（AutoML）项目，专注于超参数调优、早期停止和神经网络架构搜索。它不依赖特定的机器学习框架，支持 TensorFlow、PyTorch、XGBoost 等，并能在任意 Kubernetes Custom Resources 上运行训练任务。

环境准备

在开始之前，请确保满足以下前置条件：

• Kubernetes 集群：需要一个正常运行的 Kubernetes 集群（版本建议 1.23+）。
• kubectl 工具：已安装并配置好与集群的通信。
• Python 环境：若使用 Python SDK，需安装 Python 3.8+ 及 pip。
• 前置依赖：详细的前置要求请参考 Kubeflow 官方文档。

提示：国内用户若拉取 GitHub 资源或 Docker 镜像较慢，建议配置国内镜像加速器或使用代理。

安装步骤

1. 安装控制平面 (Control Plane)

使用 kubectl 直接部署最新稳定版（v0.17.0）的 Katib 控制平面：

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

若需体验最新开发版功能，可执行：

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

安装完成后，可通过以下命令检查 Pod 状态（通常在 kubeflow 命名空间下）：

kubectl get pods -n kubeflow

2. 安装 Python SDK

为了方便数据科学家创建调优实验，推荐安装官方 Python SDK：

pip install -U kubeflow-katib

国内加速建议：如果 pip 下载速度慢，可使用清华或阿里源：

pip install -U kubeflow-katib -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下是最简单的使用示例，展示如何通过 Python SDK 创建一个随机搜索（Random Search）的超参数调优实验。

示例：简单的超参数调优

假设你有一个训练脚本 train.py，该脚本接受 --lr (学习率) 和 --num-layers (层数) 参数。

from kubeflow.katib import KFClient
from kubeflow.katib.constants import constants

# 初始化客户端
kf_client = KFClient()

# 定义实验名称和命名空间
experiment_name = "hp-tuning-example"
namespace = "kubeflow"

# 定义超参数搜索空间
parameters = [
    {
        "name": "--lr",
        "parameterType": "double",
        "feasibleSpace": {"min": "0.01", "max": "0.1"},
    },
    {
        "name": "--num-layers",
        "parameterType": "int",
        "feasibleSpace": {"min": "2", "max": "5"},
    },
]

# 定义试验模板 (Trial Template)
# 这里假设使用 PyTorchJob 或其他支持的 CRD，此处以通用容器命令为例
trial_template = {
    "goTemplate": {
        "rawTemplate": """
apiVersion: batch/v1
kind: Job
metadata:
  name: {{.Trial}}
  namespace: {{.Namespace}}
spec:
  template:
    spec:
      containers:
        - name: training-container
          image: python:3.8
          command:
            - "python"
            - "/opt/train.py"
            - "--lr=${trialParameters.learningRate}"
            - "--num-layers=${trialParameters.numberLayers}"
          volumeMounts:
            - mountPath: /opt
              name: training-code
      volumes:
        - name: training-code
          configMap:
            name: train-script-config
      restartPolicy: Never
        """
    },
    "trialParameters": [
        {"name": "learningRate", "description": "Learning rate for the training model", "reference": "--lr"},
        {"name": "numberLayers", "description": "Number of layers for the training model", "reference": "--num-layers"},
    ],
}

# 创建实验
kf_client.create_experiment(
    name=experiment_name,
    namespace=namespace,
    parameters=parameters,
    trial_template=trial_template,
    algorithm="random",  # 使用随机搜索算法
    max_trial_count=12,  # 最大试验次数
    parallel_trial_count=3,  # 并行试验数
    objective={
        "type": "maximize",
        "goal": 0.99,
        "metricName": "accuracy",
    },
)

print(f"Experiment {experiment_name} has been created.")

查看结果

实验提交后，可以使用以下命令查看实验状态和最佳超参数组合：

kubectl get experiments -n kubeflow
kubectl describe experiment <experiment-name> -n kubeflow

或者在 Python 中获取结果：

kf_client.get_experiment(experiment_name, namespace)

更多复杂的算法（如贝叶斯优化、TPE、NAS 等）和高级配置，请参考 Kubeflow 官方文档。