Kubeflow Pipelines – SDK를 사용해서 파이프라인 만들기

Kubeflow Pipelines SDK를 사용하여 파이프라인과 컴포넌트를 구성하고, 빌드하는 방법에 대해서 알아보겠습니다. 그리고 SDK를 사용하여 파이프라인을 실행하는 방법과, Kubeflow Pipelines UI를 사용하여 파이프라인을 실행하는 방법에 대해서 알아보겠습니다.


Pipelines SDK 소개

Kubeflow Pipelines SDK는 머신 러닝 워크 플로우를 정의하고, 실행시킬 수 있는 파이썬 패키지 세트를 제공합니다. 파이프 라인은 워크 플로우의 단계를 구성하는 컴포넌트들과, 각 컴포넌트들이 서로 상호 작용하는 방식을 정의해 놓은 것입니다.

Kubeflow Pipelines SDK는 파이프 라인을 컴파일하고 실행하는 등의 여러 상호 작용 기능을 제공하고 있습니다. 그리고 파이프 라인의 구성 요소인 컴포넌트를 만들고 로드 하는 등의 기능도 제공하고 있습니다. 컴포넌트에서 사용할 컨테이너 이미지를 빌드 하는 기능도 제공하고 있습니다. 다만 Kubeflow Pipelines SDK에 포함되어 있는 컨테이너 빌더 기능은 Google Cloud Platform (GCP) 환경에서만 원활하게 사용할 수 있습니다.

SDK 패키지

Kubeflow Pipelines SDK에는 다음과 같은 패키지가 포함되어 있습니다.

  • kfp.compiler : 파이프 라인을 컴파일 할 수 있는 기능을 제공하고 있습니다. 이 패키지의 주요 사용 메소드는 다음과 같습니다
    • kfp.compiler.Compiler.compile : Python DSL 코드를 Kubeflow Pipelines 서비스가 처리 할 수 있는 단일 정적 구성 (YAML 형식)으로 컴파일합니다. Kubeflow Pipelines 서비스는 정적 구성을 실행을 위해 Kubernetes 리소스 세트로 변환합니다. (현재는 컴파일하면 Argo Workflows 형태로 변환합니다.)
  • kfp.component : 파이프 라인 컴포넌트와 상호 작용하기 위한 기능을 제공하고 있습니다. 이 패키지의 주요 사용 메소드는 다음과 같습니다.
    • kfp.components.func_to_container_op : Python 함수를 파이프 라인 컴포넌트로 변환하고 팩토리 함수를 리턴합니다. 그런 다음 팩토리 함수를 호출하여 컨테이너에서 원래 함수를 실행하는 파이프 라인 태스크 (ContainerOp)의 인스턴스를 구성 할 수 있습니다.
    • kfp.components.load_component_from_file : 파일에서 파이프 라인 컴포넌트를 로드하고 팩토리 함수를 리턴합니다. 그런 다음 팩토리 함수를 호출하여 컴포넌트 컨테이너 이미지를 실행하는 파이프 라인 태스크 (ContainerOp)의 인스턴스를 구성 할 수 있습니다.
    • kfp.components.load_component_from_url : URL에서 파이프 라인 컴포넌트를 로드하고 팩토리 함수를 리턴합니다. 그런 다음 팩토리 함수를 호출하여 컴포넌트 컨테이너 이미지를 실행하는 파이프 라인 태스크 (ContainerOp)의 인스턴스를 구성 할 수 있습니다.
  • kfp.containers : 컴포넌트 컨테이너 이미지를 빌드하는 기능을 제공하고 있습니다. 이 패키지의 주요 사용 메소드는 다음과 같습니다
    • build_image_from_working_dir : 파이썬 작업 디렉토리를 사용하여 새 컨테이너 이미지를 빌드하고 푸시합니다. Python 컨테이너 이미지를 기본 이미지로 사용하는 Dockerfile을 생성하고, requirements.txt 파일 있는 경우 패키지를 설치하고 대상 Python 파일을 컨테이너 이미지에 복사합니다. 작업 디렉토리의 루트에 사용자 정의 Dockerfile을 만들어서 대체 할 수 있습니다. (현재는 Google Cloud Platform (GCP) 환경에서만 사용할 수 있습니다.)
  • kfp.dsl : 파이프 라인 및 컴포넌트를 정의하고 상호 작용하는 데 사용할 수있는 DSL (Domain-Specific Language)이 포함되어 있습니다. 이 패키지의 주요 사용 메소드는 다음과 같습니다.
    • kfp.dsl.ContainerOp : 컨테이너 이미지로 구현 된 파이프 라인 작업을 나타냅니다.
    • kfp.dsl.PipelineParam 한 파이프 라인 컴포넌트에서 다른 파이프 라인 컴포넌트로 전달할 수있는 파이프 라인 파라미터를 나타냅니다.
    • kfp.dsl.component : 파이프 라인 컴포넌트를 반환하는 DSL 함수의 데코레이터입니다. (ContainerOp).
    • kfp.dsl.pipeline : 파이프 라인을 반환하는 Python 함수의 데코레이터입니다.
    • kfp.dsl.python_component: 파이프 라인 컴포넌트 메타 데이터를 함수 객체에 추가하는 Python 함수의 데코레이터입니다.
    • kfp.dsl.types:  Kubeflow Pipelines SDK에서 사용하는 타입들이 정의되어 있습니다. 타입에는 String, Integer, Float 및 Bool과 같은 기본 타입과 GCPProjectID 및 GCRPath와 같은 도메인 별 타입이 있습니다. DSL 정적 유형 검사에 대해서는 안내서를 참조하실 수 있습니다.
    • kfp.dsl.ResourceOp : 쿠버네티스 리소스를 직접 조작할 수 작업을 나타냅니다.(creategetapply 등 ).
    • kfp.dsl.VolumeOp : 쿠버네티스 PersistentVolumeClaim 을 생성하는 파이프 라인 작업 을 나타냅니다.
    • kfp.dsl.VolumeSnapshotOp : 새로운 볼륨 스냅 샷을 생성하는 파이프 라인 작업을 나타냅니다.
    • kfp.dsl.PipelineVolume : 파이프 라인의 단계간에 데이터를 전달하기 위해 사용하는 볼륨을 나타냅니다.
  • kfp.Client : Kubeflow Pipelines API 용 Python 클라이언트 라이브러리가 포함되어 있습니다. 이 패키지의 주요 사용 메소드는 다음과 같습니다.
    • kfp.Client.create_experiment : 파이프 라인 experiment 을 만들고, experiment  개체를 반환합니다.
    • kfp.Client.run_pipeline 파이프 라인을 실행(run)하고 실행(run) 개체를 반환합니다.
  • KFP extension modules : Kubeflow Pipelines에서 사용할 수 있는 특정 플랫폼에 대한 기능을 가지고 있습니다. 온 프레미스, Google Cloud Platform (GCP), Amazon Web Services (AWS) 및 Microsoft Azure에 대한 유틸리티 기능을 제공하고 있습니다.

KFP CLI tool

KFP CLI 도구를 사용하면 커맨드 라인에서 직접 Kubeflow Pipelines SDK의 일부분을 사용할 수 있습니다. KFP CLI 도구는 다음과 같은 명령을 제공합니다.

  • kfp diagnose_me : 지정된 파라미터로 환경 진단을 실행합니다
    • --json : 명령 실행 결과를 JSON으로 반환하도록 합니다. 별도로 설정하지 않으면, 결과는 사람이 읽을 수 있는 형식으로 반환됩니다.
    • --namespace TEXT : 대상 쿠버네티스 네임스페이스를 지정합니다. 별도로 설정하지 않으면, 모든 네임스페이스를 대상으로 합니다.
  • kfp pipeline <COMMAND> : 파이프 라인을 관리하는 데 도움이 되는 명령을 제공합니다.
    • get : Kubeflow Pipelines 클러스터의 Kubeflow 파이프 라인에 대한 상세한 정보를 조회합니다.
    • list : Kubeflow Pipelines 클러스터에 업로드 된 파이프 라인 목록을 조회 합니다.
    • upload : Kubeflow Pipelines 클러스터에 파이프 라인을 업로드합니다.
  • kfp run <COMMAND> 파이프 라인 실행을 관리하는 데 도움이 되는 명령을 제공합니다.
    • get : 파이프 라인 실행의 상세한 정보를 조회합니다.
    • list : 최근 실행한 파이프 라인 실행 목록을 조회 합니다.
    • submit – 파이프 라인을 실행 시킵니다.

파이프 라인과 컴포넌트 만들기

SDK를 사용하여 파이프 라인과 컴포넌트를 만드는 방법에 대해서 알아 보도록 하겠습니다.

컴포넌트 만드는 방법

파이프라인은 컴포넌트로 구성되어 있습니다. 그래서 파이프라인을 만들기 위해서는 사용할 컴포넌트를 먼저 만들어야합니다. 이미 만들어 놓은 컴포넌트가 있으면 재사용할 수도 있습니다.

컴포넌트를 만드는 단계는 다음과 같습니다.

가 . 컴포넌트 프로그램 작성 : 컴포넌트에서 사용할 프로그램을 작성해야 합니다. 프로그램은 다른 컴포넌트로부터 데이터를 받기 위해서, 파일이나 명령행 인수를 사용해야 합니다.

나. 컴포넌트 컨테이너화 : 작성한 프로그램을 컨테이너 이미지로 만들어야 합니다.

다. 컴포넌트 스펙 작성 : 컴포넌트의 데이터 모델을 정의하기 위해서 YAML 형식의 파일을 작성해야 합니다. 재사용 가능한 컴포넌트를 만들때는 스펙을 작성하는 것이 좋지만, 생략 가능합니다. 컴포넌트 스펙 파일이 있는 경우에는 스펙 파일을 로드해서 컴포넌트를 생성할 수 있습니다. 자세한 내용은 “재사용 가능한 컴포넌트”를 참고 하시기 바랍니다.

파이프라인 만드는 방법

컴포넌트를 이용해 파이프라인을 만들 수 있습니다. 파이프라인을 만들기 위해서 파이프라인 파이썬 코드를 작성해야 합니다.

파이프라인을 만드는 단계는 다음과 같습니다.

가. Kubeflow Pipelines DSL을 사용하여 파이프라인 함수와 컴포넌트 함수를 작성합니다.

나. 파이프 라인을 컴파일 하여 압축 된 YAML 파일을 생성합니다.

파이프 라인을 컴파일 하기 위한 방법은 두 가지가 있습니다.

  • kfp.compiler.Compiler.compile 메소드를 사용하는 방법 kfp.compiler.Compiler().compile(my_pipeline, 'my_pipeline.zip')
  • 커맨드 라인에서 dsl-compile 커맨드를 사용하는 방법 dsl-compile --py [path/to/python/file] --output my_pipeline.zip

다. 파이프 라인을 업로드하고, 실행합니다.

파이프 라인을 실행하는 방법은 두 가지가 있습니다.

  • Kubeflow Pipelines SDK 를 사용하는 방법
client = kfp.Client()
my_experiment = client.create_experiment(name='demo')
my_run = client.run_pipeline(my_experiment.id, 'my-pipeline', 
  'my_pipeline.zip')
  • Kubeflow Pipelines UI를 사용하는 방법

컴포넌트 만들기

프로그램이 포함된 컨테이너 이미지를 사용하여 컴포넌트를 생성하는 방법에 대해서 알아 보도록 하겠습니다. 생성한 컴포넌트는 파이프라인을 작성하는데 사용됩니다.

가. 프로그램 코드를 작성합니다.

mnist-simple.py

from __future__ import absolute_import, division, print_function, unicode_literals

import tensorflow as tf
import numpy as np


def train():
    print("TensorFlow version: ", tf.__version__)

    mnist = tf.keras.datasets.mnist

    (x_train, y_train), (x_test, y_test) = mnist.load_data()
    x_train, x_test = x_train / 255.0, x_test / 255.0

    # Reserve 10,000 samples for validation
    x_val = x_train[-10000:]
    y_val = y_train[-10000:]
    x_train = x_train[:-10000]
    y_train = y_train[:-10000]

    model = tf.keras.models.Sequential([
      tf.keras.layers.Flatten(input_shape=(28, 28)),
      tf.keras.layers.Dense(128, activation='relu'),
      tf.keras.layers.Dropout(0.2),
      tf.keras.layers.Dense(10, activation='softmax')
    ])

    model.compile(optimizer='adam',
                  loss='sparse_categorical_crossentropy',
                  metrics=['accuracy'])

    print("Training...")
    training_history = model.fit(x_train, y_train, epochs=5, validation_data=(x_val, y_val))

    print("Average test loss: ", np.average(training_history.history['loss']))


if __name__ == '__main__':
    train()

나. 프로그램 코드가 포함된 컨테이너 이미지를 생성하고, 컨테이너 이미지 레지스트리에 업로드 합니다.

Dockerfile을 생성합니다.

Dockerfile

FROM tensorflow/tensorflow:2.1.0-py3

RUN mkdir -p /app
ADD mnist-simple.py /app/

컨테이너 이미지를 빌드하겠습니다.

docker build -t kangwoo/mnist-simple:kfp .

빌드한 컨테이너 이미지를 컨테이너 이미지 레지스트리에 업로드 합니다.

docker push kangwoo/mnist-simple:kfp

SDK를 사용하여 파이프라인을 만들고 실행하기

생성한 컴포넌트를 이용해 파이프라인을 만들어 보겠습니다. 파이프라인을 만들기 위해서 파이프라인 파이썬 코드를 작성해야 합니다.

가. Kubeflow Pipelines DSL을 사용하여 컴포넌트 함수를 작성합니다. image 파라미터에 컴포넌트에서 사용하는 컨테이너 이미지를 정의합니다. 컴포넌트 함수는 kfp.dsl.ContainerOp를 리턴해야합니다. 선택적으로 kfp.dsl.component 라는 데코레이터를 사용하여 DSL 컴파일러에서 정적 타입 검사를 활성화 할 수 있습니다. 데코레이터를 사용하려면 @kfp.dsl.component 어노테이션을 컴포넌트 함수에 추가 하면 됩니다.

@kfp.dsl.component
def train_component_op():
    return kfp.dsl.ContainerOp(
        name='mnist-train',
        image='kangwoo/kfp-mnist:kfp'
    )

나. Kubeflow Pipelines DSL을 사용하여 파이프 라인 함수를 작성합니다. 파이프 라인을 정의하는 함수에 사용할 컴포넌트들을 추가합니다. 파이프 라인 함수에서 파이프 라인을 빌드하기 위해서 kfp.dsl.pipeline 데코레이터를 사용합니다. 데코레이터를 사용하려면 @kfp.dsl.pipeline 어노테이션을 파이프 라인 함수에 추가 하면 됩니다.

@dsl.pipeline(
    name='My pipeline',
    description='My machine learning pipeline'
)
def my_pipeline():
    train_task = train_component_op()

다. 파이프 라인을 컴파일하여 압축 된 YAML 파일을 생성하겠습니다. YAML 파일에는 파이프 라인 실행을 위한 쿠버네티스 리소스들이 정의되어 있습니다. kfp.compiler.Compiler.compile 메소드를 사용하는 컴파일 하겠습니다.

kfp.compiler.Compiler().compile(my_pipeline, 'my_pipeline.zip')

라. 파이프 라인을 업로드하고, 실행합니다. Kubeflow Pipelines SDK 를 사용하여 파이프라인을 업로드하고 실행하겠습니다.

client = kfp.Client()
my_experiment = client.create_experiment(name='Basic Experiment')
my_run = client.run_pipeline(my_experiment.id, 'my_pipeline', 
  'my_pipeline.zip')

다음은 파이프라인 전체 코드 입니다.

import kfp
from kfp import dsl


@kfp.dsl.component
def train_component_op():
    return kfp.dsl.ContainerOp(
        name='mnist-train',
        image='kangwoo/kfp-mnist:kfp'
    )


@dsl.pipeline(
    name='My pipeline',
    description='My machine learning pipeline'
)
def my_pipeline():
    train_task = train_component_op()


if __name__ == '__main__':
    # Compile
    pipeline_package_path = 'my_pipeline.zip'
    kfp.compiler.Compiler().compile(my_pipeline, pipeline_package_path)

    # Run
    client = kfp.Client()
    my_experiment = client.create_experiment(name='Basic Experiment')
    my_run = client.run_pipeline(my_experiment.id, 'my_pipeline', pipeline_package_path)

파이프라인 코드를 실행합니다.

python my_pipeline.py

파이프라인 코드가 실행되면, 파이프라인 패키지가 컴파일 됩니다. 그리고 컴파일된 패키지를 Kubeflow Pipelines 에 전달하여 실행 시킵니다. 실행 결과는 Kubeflow Pipelines UI를 통해서 확인할 수 있습니다.

파이프라인 실행 결과 확인 하기

Kubeflow 파이프라인 UI에서 실행 결과를 확인하려면, 다음 절차대로 진행하시면 됩니다.

  1. Kubeflow 대시보드 화면의 왼쪽 메뉴에서 Pipelines를 클릭합니다.
  2. Kubeflow Pipelines UI 화면의 왼쪽 메뉴에서 Experiments 클릭하여, 현재 파이프 라인 실험 목록을 조회합니다.
  3. 보려는 실험(Experiment)의 ‘실험 이름’을 클릭합니다.
  4. 보려는 실행(Run)의 “실행 이름”을 클릭합니다.
  5. Graph 탭에서 보려는 파이프 라인 컴포넌트를 나타내는 단계를 클릭합니다. 단계 세부 사항이 Artifacts  탭을 표시하며 슬라이드 됩니다.

“Kubeflow Pipelines – SDK를 사용해서 파이프라인 만들기”에 대한 4개의 댓글

  1. 좋은 정보 감사합니다. 따라해보니 잘되네요. 질문 하나 있는데, pipeline metric 사용 간단한 예제도 가능하시면 연재 부탁드립니다.

    1. 안녕하세요. 현재 파이프라인 메트릭과 출력 뷰어에 대해서도 정리할 예정입니다. 주말에만 작업하는지라 시간이 좀 걸리네요. 빠르면 이번주 늦어도 다음주까지 정리가 될거 같아요.

      1. 정리 감사드립니다. 한가지 더 질문드리면, kubeflow 페이지를 봐도 샘플을 만드는 것이 쉽지 않습니다. kubeflow 샘플을 만들려면 어떤자료/사이트를 참고하면 좋을지요? ( 예로 이곳을 보고서야 pipeline을 구성할수 있었는데, 이곳과 같이 샘플이 좋은 참조할 만한 사이트(영문도 ok)가 있는지요? )

        1. 불행히도 그런 친절한 사이트는 찾지 못했습니다. 한 땀 한 땀 테스트 해보면서 만드는 수 밖에 없는거 같아요.

댓글 남기기

이메일은 공개되지 않습니다. 필수 입력창은 * 로 표시되어 있습니다