TFX – 시카고 택시

TFX의 시카고 택시의 예제를 이용하여 파이프라인을 실행해 보겠습니다.

TFX(TensorFlow Extended)는 프로덕션 머신러닝 파이프라인을 배포하기 위한 엔드 투 엔드 플랫폼으로서, 텐서플로우를 기반으로 하고 있습니다. 머신 러닝 시스템을 실행 하고 모니터링하는 데 필요한 프레임워크와 공통 라이브러리를 제공하고 있습니다.

TFX의 시카고 택시 예제는 엔드 투 엔드 워크플로우와 데이터 분석, 검증 및 변환, 모델 훈련, 성능 분석 및 서비스에 필요한 단계를 보여주고 있습니다. 그래서 워크플로우와 파이프라인을 구성하는데 좋은 참고가 될 수 있습니다.

이 예제에서는 다음과 같은 TFX 컴포넌트를 사용합니다.

  • ExampleGen 입력 데이터 세트의 수집 및 분할.
  • StatisticsGen 데이터 세트에 대한 통계 계산.
  • SchemaGen examines the statistics and creates a data schema.
  • ExampleValidator 통계를 검사하고 데이터 스키마를 생성함.
  • Transform 데이터 세트를 가지고 피처 엔지니어링을 수행.
  • Trainer TensorFlow Estimators 또는 Keras를 사용하여 모델을 학습.
  • Evaluator 학습 결과에 대한 심층 분석 수행.
  • Pusher 모델을 서비스 인프라에 배포.

다음 그림은 컴포넌트 간의 데이터 흐름을 보여 줍니다.

출처 : https://www.tensorflow.org/tfx

TFX 라이브러리

TFX는 라이브러리와 파이프라인 컴포넌트를 모두 포함하고 있습니다. 다음 그림은 TFX 라이브러리와 파이프라인 컴포넌트 사이의 관계를 설명하고 있습니다.

출처 : https://www.tensorflow.org/tfx

TFX는 파이프라인 컴포넌트를 만드는 데 사용할 수 있는 파이썬 라이브러리를 제공하고 있습니다. 이 라이브러리를 사용하여 파이프라인의 컴포넌트를 생성하면, 보다 쉽게 파이프라인을 구성할 수 있으며, 사용자는 사용자 코드를 작성하는데 보다 더 집중할 수 있습니다.

TFX 라이브러리는 다음과 같습니다.

  • TensorFlow Data Validation (TFDV) : TFDV는 머신러닝 데이터를 분석하고 검증하는 것을 도와주는 라이브러리 입니다. 확장성이 뛰어나고 텐서플로우, TFX와 잘 작동하도록 설계되었습니다. TFDV는 다음을 포함하고 있습니다.
    • 학습 및 테스트 데이터의 요약 통계에 대한 계산.
    • 데이터 분산 및 통계를 위한 뷰어와의 통합 및 데이터 세트 쌍(Facets)의 측면 비교.
    • 필요한 값, 범위 및 어휘와 같은 데이터에 대한 기대치를 설명하는 자동화된 데이터 스키마 생성
    • 스키마를 검사하는 데 도움이 되는 스키마 뷰어.
    • 누락된 피처, 범위를 벗어난 값 또는 잘못된 기능 유형과 같은 이상 징후를 식별하기 위한 이상 징후 탐지.
    • 이상 징후 뷰어를 통해 이상 징후가 있는 피처를 확인.
  • TensorFlow Transform (TFT) : TFT는 TensorFlow로 데이터를 사전 처리하는 라이브러리 입니다. TFT는 다음과 같이 전체 데이터를 변환할 때 유용합니다.
    • 평균 및 표준 편차로 입력 값을 정규화.
    • 모든 입력 값에 대한 어휘를 생성하여 문자열을 정수로 변환.
    • 관측된 데이터 분포를 기반으로 소수 데이터를 정수로 변환.
  • TensorFlow : 텐서플로우는 TFX에서 모델을 학습할 때 사용합니다. 학습 데이터와 모델링 코드를 가지고, SavedModel 이라는 결과를 생성합니다.
  • TensorFlow Model Analysis (TFMA) : TFMA는 텐서플로우 모델을 평가하기 위한 라이브러리 입니다. 텐서플로우로 EvalSavedModel을 생성하는데 사용되며, 이는 분석의 기반이 됩니다. 사용자들은 학습에 정의된 것과 동일한 지표를 사용하여, 분산된 방식으로 대량의 데이터에 대한 모델을 평가할 수 있습니다. 이러한 측정지표는 여러 조각의 데이터를 통해 계산할 수 있으며 주피터 노트북에서 시각화할 수 있습니다.
  • TensorFlow Metadata (TFMD) : TFMD는 텐서플로우로 머신러닝 모델을 학습할 때 유용한 메타데이터에 대한 표준 표현을 제공합니다. 메타데이터는 입력 데이터 분석 중에 생성할 수 있으며, 데이터 검증, 탐색 및 변환을 위해 사용될 수 있습니다. 메타데이터 직렬화 형식은 다음과 같습니다.
    • 표 형식의 데이터를 설명하는 스키마 (예 tf.Examples)
    • 데이터 세트에 대한 통계 요약 모음
  • ML Metadata (MLMD) : MLMD는 머신 러닝 개발자 및 데이터 사이언티스트가 워크플로우와 관련된 메타데이터를 기록하고 검색하기 위한 라이브러리입니다. 대부분의 메타데이터는 TFMD 표현을 사용합니다. MLMD는 SQL-Lite, MySQL 같은 데이터 저장소를 사용하여 데이터를 저장합니다.

데이터 세트

예제에서 사용한 데이터 세트는 시카고 시가 발표한 택시 여행 데이터 세트 입니다. 해당 사이트는 애플리케이션에서 데이터를 사용하기 위해, 원본 데이터를 수정한 데이터를 제공하고 있습니다. 원본 소스는 시카고 시의 공식 웹사이트인 www.cityofchicago.org 에서 확인할 수 있습니다.

Kubeflow에서 TFX 파이프라인 실행하기

TFX는 다양한 환경에서 실행할 수 있습니다. 로컬에서도 실행할 수 있고, Airflow 환경에서 실행할 수 있으며, Kubeflow 에서도 실행할 수 있습니다. 예제에서는 Kubeflow 환경에서 시카고 택시 파이프라인을 실행해 볼 것입니다. 만약 다양환 환경에 대해 관심 있으면, “Chicago Taxi Example” 페이지를 참고하시기 바랍니다.

TFX 컴포넌트 사용하기

설정

필요한 패키지를 추가하고, 사용할 데이터를 다운로드하겠습니다.

먼저 주피터 노트북을 생성하겠습니다.

패키지 설치하기

tfx 패키지를 설치합니다.

In []:

!pip install "tfx>=0.21.1,<0.22"  --user

패키지 추가하기

TFX 컴포넌트와 필요한 패키지를 추가합니다.

In []:

import os
import pprint
import tempfile
import urllib

import absl
import tensorflow as tf
import tensorflow_model_analysis as tfma
tf.get_logger().propagate = False
pp = pprint.PrettyPrinter()

import tfx
from tfx.components import CsvExampleGen
from tfx.components import Evaluator
from tfx.components import ExampleValidator
from tfx.components import Pusher
from tfx.components import ResolverNode
from tfx.components import SchemaGen
from tfx.components import StatisticsGen
from tfx.components import Trainer
from tfx.components import Transform
from tfx.components.base import executor_spec
from tfx.components.trainer.executor import GenericExecutor
from tfx.dsl.experimental import latest_blessed_model_resolver
from tfx.orchestration import metadata
from tfx.orchestration import pipeline
from tfx.orchestration.experimental.interactive.interactive_context import InteractiveContext
from tfx.proto import pusher_pb2
from tfx.proto import trainer_pb2
from tfx.types import Channel
from tfx.types.standard_artifacts import Model
from tfx.types.standard_artifacts import ModelBlessing
from tfx.utils.dsl_utils import external_input

%load_ext tfx.orchestration.experimental.interactive.notebook_extensions.skip

라이브러리 버전을 확인해 보겠습니다.

In []:

print('TensorFlow version: {}'.format(tf.__version__))
print('TFX version: {}'.format(tfx.__version__))
TensorFlow version: 2.1.0
TFX version: 0.21.4

파이프라인 경로 설정 이동 or 삭제

In []:

# This is the root directory for your TFX pip package installation.
_tfx_root = tfx.__path__[0]

# This is the directory containing the TFX Chicago Taxi Pipeline example.
_taxi_root = os.path.join(_tfx_root, 'examples/chicago_taxi_pipeline')

# This is the path where your model will be pushed for serving.

# Set up logging.
absl.logging.set_verbosity(absl.logging.INFO)

예제 데이터 다운로드

사용할 예제 데이터세트를 다운로드합니다.

In []:

_data_root = tempfile.mkdtemp(prefix='tfx-data')
DATA_PATH = '<https://raw.githubusercontent.com/tensorflow/tfx/master/tfx/examples/chicago_taxi_pipeline/data/simple/data.csv>'
_data_filepath = os.path.join(_data_root, "data.csv")
urllib.request.urlretrieve(DATA_PATH, _data_filepath)

InteractiveContext 작성

노트북에서 대화식으로 TFX 컴포넌트를 실행할 수 있는 InteractiveContext를 생성합니다.

In []:

context = InteractiveContext()

TFX 컴포넌트 실행

노트북 셀에서는 TFX 컴포넌트를 하나씩 작성하고 실행해보겠습니다.

ExampleGen

ExampleGen 컴포넌트는 대부분 TFX 파이프라인의 앞에 위치해 있습니다. 해당 컴포넌트는 다음과 같은 역할을 합니다.

  • 데이터를 학습 및 평가 세트로 분할(기본적으론 학습 세트에 2/3, 평가 세트에 1/3가 할당됩니다.)
  • 데이터를 tf.Example 형식으로 변환
  • 데이터를 다른 컴포넌트에서 접근할 수 있도록 _tfx_root 디렉토리로 복사

ExampleGen 은 데이터 원본의 경로를 입력값으로 사용합니다. 다음 예제의 경우 CSV 파일을 다운르도 받은 _data_root 경로를 입력값으로 사용합니다.

In []:

example_gen = CsvExampleGen(input=external_input(_data_root))
context.run(example_gen)

출력 아티팩트를 살펴보겠습니다. 이 컴포넌트는 학습(train)과 평가(eval) 나누어진 아티팩트를 출력합니다.

In []:

artifact = example_gen.outputs['examples'].get()[0]
print(artifact.split_names, artifact.uri)
["train", "eval"] /tmp/tfx-interactive-2020-05-07T09_40_15.820980-gawc9si3/CsvExampleGen/examples/1
This cell will be skipped during export to pipeline.

그리고 다음과 같이 학습에 사용될 데이터 세트를 조회해 볼 수 있습니다.

In []:

# Get the URI of the output artifact representing the training examples, which is a directory
train_uri = os.path.join(example_gen.outputs['examples'].get()[0].uri, 'train')

# Get the list of files in this directory (all compressed TFRecord files)
tfrecord_filenames = [os.path.join(train_uri, name)
                      for name in os.listdir(train_uri)]

# Create a `TFRecordDataset` to read these files
dataset = tf.data.TFRecordDataset(tfrecord_filenames, compression_type="GZIP")

# Iterate over the first 3 records and decode them.
for tfrecord in dataset.take(3):
  serialized_example = tfrecord.numpy()
  example = tf.train.Example()
  example.ParseFromString(serialized_example)
  pp.pprint(example)
features {
  feature {
    key: "company"
    value {
      bytes_list {
        value: "Taxi Affiliation Services"
      }
    }
  }
  feature {
    key: "dropoff_census_tract"
    value {
    }
  }
  feature {
    key: "dropoff_community_area"
    value {
    }
  }
  feature {
    key: "dropoff_latitude"
    value {
    }
  }
...

StatisticsGen

StatisticsGen 컴포넌트는 다운스트림 컴포넌트로서, 데이터 분석을 위해 데이터 세트에 대한 통계를 계산합니다. 텐서플로우 데이터 검증 라이브러리(TFDV:TensorFlow Data Validation)를 사용합니다.

StatisticsGen은 앞서 ExampleGen 에서 생성한 데이터 세트를 입력값으로 사용합니다.

In []:

statistics_gen = StatisticsGen(
    examples=example_gen.outputs['examples'])
context.run(statistics_gen)

StatisticsGen 의 실행이 끝나면, 출력된 통계를 시각화할 수 있습니다.

In []:

context.show(statistics_gen.outputs['statistics'])

‘train’ split:

‘eval’ split:

SchemaGen

SchemaGen 컴포넌트는 데이터 통계를 기반으로 스키마를 생성합니다. 스키마는 데이터 세트에 있는 형상의 예상 한계, 유형 및 속성을 정의합니다. SchemaGen 컴포넌트도 TFDV 라이브러리를 사용합니다.

SchemaGenStatisticsGen으로 생성한 통계를 입력으로 사용합니다.

In []:

schema_gen = SchemaGen(
    statistics=statistics_gen.outputs['statistics'],
    infer_feature_shape=False)
context.run(schema_gen)

SchemaGen이 실행이 끝나면, 생성된 스키마를 테이블로 시각화할 수 있습니다.

In []:

context.show(schema_gen.outputs['schema'])

데이터 세트의 각 피쳐는 스키마 테이블의 속성 옆에 행으로 표시합니다. 스키마는 또한 범주형 피처의 해당 영역에 있는 값들을 표시합니다.

ExampleValidator

ExampleValidator 컴포넌트는 스키마에 정의된 기대치를 기반으로, 데이터에서 이상 징후를 탐지합니다. ExampleValidator 컴포넌트도 TFDV 라이브러리를 사용합니다.

ExampleValidatorStatisticsGen의 통계와 SchemaGen의 스키마를 입력값으로 사용합니다.

In []:

example_validator = ExampleValidator(
    statistics=statistics_gen.outputs['statistics'],
    schema=schema_gen.outputs['schema'])
context.run(example_validator)

ExampleValidator 의 실행이 끝나면, 이상 징후를 표로 시각화할 수 있습니다.

In []:

context.show(example_validator.outputs['anomalies'])

이상 징후 표에서, 회사(company) 피처가 학습 데이터 세트에 없는 값들을 가지는 것을 확인할 수 있습니다. 이러한 정보를 이용하여 모델 성능을 디버그하고, 데이터가 시간에 따라 어떻게 발전하는지 이해하며, 데이터 오류를 식별하는 데 사용할 수 있습니다.

Transform

Transform 컴포넌트는 학습과 서빙에 대한 피쳐 엔지니어링을 수행합니다. TensorFlow Transform 라이브러리를 사용합니다.

TransformExampleGen 에서 생성한 데이터와 SchemaGen의 스키마 그리고 사용자가 정의 변환 코드를 입력값으로 사용합니다.

다음은 사용자 정의 변환 코드 입니다. 먼저 피처 엔지니어링을 위하여 몇가지 상수를 정의하겠습니다.

In []:

_taxi_constants_module_file = 'taxi_constants.py'

In []:

%%writefile {_taxi_constants_module_file}

# Categorical features are assumed to each have a maximum value in the dataset.
MAX_CATEGORICAL_FEATURE_VALUES = [24, 31, 12]

CATEGORICAL_FEATURE_KEYS = [
    'trip_start_hour', 'trip_start_day', 'trip_start_month',
    'pickup_census_tract', 'dropoff_census_tract', 'pickup_community_area',
    'dropoff_community_area'
]

DENSE_FLOAT_FEATURE_KEYS = ['trip_miles', 'fare', 'trip_seconds']

# Number of buckets used by tf.transform for encoding each feature.
FEATURE_BUCKET_COUNT = 10

BUCKET_FEATURE_KEYS = [
    'pickup_latitude', 'pickup_longitude', 'dropoff_latitude',
    'dropoff_longitude'
]

# Number of vocabulary terms used for encoding VOCAB_FEATURES by tf.transform
VOCAB_SIZE = 1000

# Count of out-of-vocab buckets in which unrecognized VOCAB_FEATURES are hashed.
OOV_SIZE = 10

VOCAB_FEATURE_KEYS = [
    'payment_type',
    'company',
]

# Keys
LABEL_KEY = 'tips'
FARE_KEY = 'fare'

def transformed_name(key):
  return key + '_xf'

그리고 데이터를 입력 받아 변환 작업을 하는 코드를 작성하겠습니다.

In []:

_taxi_transform_module_file = 'taxi_transform.py'

In []:

%%writefile {_taxi_transform_module_file}

import tensorflow as tf
import tensorflow_transform as tft

import taxi_constants

_DENSE_FLOAT_FEATURE_KEYS = taxi_constants.DENSE_FLOAT_FEATURE_KEYS
_VOCAB_FEATURE_KEYS = taxi_constants.VOCAB_FEATURE_KEYS
_VOCAB_SIZE = taxi_constants.VOCAB_SIZE
_OOV_SIZE = taxi_constants.OOV_SIZE
_FEATURE_BUCKET_COUNT = taxi_constants.FEATURE_BUCKET_COUNT
_BUCKET_FEATURE_KEYS = taxi_constants.BUCKET_FEATURE_KEYS
_CATEGORICAL_FEATURE_KEYS = taxi_constants.CATEGORICAL_FEATURE_KEYS
_FARE_KEY = taxi_constants.FARE_KEY
_LABEL_KEY = taxi_constants.LABEL_KEY
_transformed_name = taxi_constants.transformed_name

def preprocessing_fn(inputs):
  """tf.transform's callback function for preprocessing inputs.
  Args:
    inputs: map from feature keys to raw not-yet-transformed features.
  Returns:
    Map from string feature key to transformed feature operations.
  """
  outputs = {}
  for key in _DENSE_FLOAT_FEATURE_KEYS:
    # Preserve this feature as a dense float, setting nan's to the mean.
    outputs[_transformed_name(key)] = tft.scale_to_z_score(
        _fill_in_missing(inputs[key]))

  for key in _VOCAB_FEATURE_KEYS:
    # Build a vocabulary for this feature.
    outputs[_transformed_name(key)] = tft.compute_and_apply_vocabulary(
        _fill_in_missing(inputs[key]),
        top_k=_VOCAB_SIZE,
        num_oov_buckets=_OOV_SIZE)

  for key in _BUCKET_FEATURE_KEYS:
    outputs[_transformed_name(key)] = tft.bucketize(
        _fill_in_missing(inputs[key]), _FEATURE_BUCKET_COUNT,
        always_return_num_quantiles=False)

  for key in _CATEGORICAL_FEATURE_KEYS:
    outputs[_transformed_name(key)] = _fill_in_missing(inputs[key])

  # Was this passenger a big tipper?
  taxi_fare = _fill_in_missing(inputs[_FARE_KEY])
  tips = _fill_in_missing(inputs[_LABEL_KEY])
  outputs[_transformed_name(_LABEL_KEY)] = tf.where(
      tf.math.is_nan(taxi_fare),
      tf.cast(tf.zeros_like(taxi_fare), tf.int64),
      # Test if the tip was > 20% of the fare.
      tf.cast(
          tf.greater(tips, tf.multiply(taxi_fare, tf.constant(0.2))), tf.int64))

  return outputs

def _fill_in_missing(x):
  """Replace missing values in a SparseTensor.
  Fills in missing values of `x` with '' or 0, and converts to a dense tensor.
  Args:
    x: A `SparseTensor` of rank 2.  Its dense shape should have size at most 1
      in the second dimension.
  Returns:
    A rank 1 tensor where missing values of `x` have been filled in.
  """
  default_value = '' if x.dtype == tf.string else 0
  return tf.squeeze(
      tf.sparse.to_dense(
          tf.SparseTensor(x.indices, x.values, [x.dense_shape[0], 1]),
          default_value),
      axis=1)

이제 변환 작업을 하는 코드를 Transform 컴포넌트에 전달하여, 데이터를 변환하겠습니다.

In []:

transform = Transform(
    examples=example_gen.outputs['examples'],
    schema=schema_gen.outputs['schema'],
    module_file=os.path.abspath(_taxi_transform_module_file))
context.run(transform)

Transform는 두 개의 출력 아티팩트를 생성합니다.

  • transform_graph : transform_graph는 사전 처리 작업을 수행할 수 있는 그래프입니다.
  • transformed_examples : transformed_examples 는 사전 처리된 학습 데이터와 평가 데이터를 나타냅니다.

Trainer

Trainer 컴포넌트는 텐서플로우로 정의한 모델을 학습 시킵니다. TrainerSchemaGen의 스키마와 Transform 에서 변환된 데이터와 그래프, 학습 파라미터 그리고 사용자 정의 모델 코드를 입력값으로 사용합니다.

다음은 사용자 정의 모델 코드입니다.

In []:

_taxi_trainer_module_file = 'taxi_trainer.py'

In []:

%%writefile {_taxi_trainer_module_file}

from typing import List, Text

import os
import absl
import datetime
import tensorflow as tf
import tensorflow_transform as tft

from tfx.components.trainer.executor import TrainerFnArgs

import taxi_constants

_DENSE_FLOAT_FEATURE_KEYS = taxi_constants.DENSE_FLOAT_FEATURE_KEYS
_VOCAB_FEATURE_KEYS = taxi_constants.VOCAB_FEATURE_KEYS
_VOCAB_SIZE = taxi_constants.VOCAB_SIZE
_OOV_SIZE = taxi_constants.OOV_SIZE
_FEATURE_BUCKET_COUNT = taxi_constants.FEATURE_BUCKET_COUNT
_BUCKET_FEATURE_KEYS = taxi_constants.BUCKET_FEATURE_KEYS
_CATEGORICAL_FEATURE_KEYS = taxi_constants.CATEGORICAL_FEATURE_KEYS
_MAX_CATEGORICAL_FEATURE_VALUES = taxi_constants.MAX_CATEGORICAL_FEATURE_VALUES
_LABEL_KEY = taxi_constants.LABEL_KEY
_transformed_name = taxi_constants.transformed_name

def _transformed_names(keys):
  return [_transformed_name(key) for key in keys]

def _gzip_reader_fn(filenames):
  """Small utility returning a record reader that can read gzip'ed files."""
  return tf.data.TFRecordDataset(
      filenames,
      compression_type='GZIP')

def _get_serve_tf_examples_fn(model, tf_transform_output):
  """Returns a function that parses a serialized tf.Example and applies TFT."""

  model.tft_layer = tf_transform_output.transform_features_layer()

  @tf.function
  def serve_tf_examples_fn(serialized_tf_examples):
    """Returns the output to be used in the serving signature."""
    feature_spec = tf_transform_output.raw_feature_spec()
    feature_spec.pop(_LABEL_KEY)
    parsed_features = tf.io.parse_example(serialized_tf_examples, feature_spec)

    transformed_features = model.tft_layer(parsed_features)
    transformed_features.pop(_transformed_name(_LABEL_KEY))

    return model(transformed_features)

  return serve_tf_examples_fn

def _input_fn(file_pattern: Text,
              tf_transform_output: tft.TFTransformOutput,
              batch_size: int = 200) -> tf.data.Dataset:
  """Generates features and label for tuning/training.

  Args:
    file_pattern: input tfrecord file pattern.
    tf_transform_output: A TFTransformOutput.
    batch_size: representing the number of consecutive elements of returned
      dataset to combine in a single batch

  Returns:
    A dataset that contains (features, indices) tuple where features is a
      dictionary of Tensors, and indices is a single Tensor of label indices.
  """
  transformed_feature_spec = (
      tf_transform_output.transformed_feature_spec().copy())

  dataset = tf.data.experimental.make_batched_features_dataset(
      file_pattern=file_pattern,
      batch_size=batch_size,
      features=transformed_feature_spec,
      reader=_gzip_reader_fn,
      label_key=_transformed_name(_LABEL_KEY))

  return dataset

def _build_keras_model(hidden_units: List[int] = None) -> tf.keras.Model:
  """Creates a DNN Keras model for classifying taxi data.

  Args:
    hidden_units: [int], the layer sizes of the DNN (input layer first).

  Returns:
    A keras Model.
  """
  real_valued_columns = [
      tf.feature_column.numeric_column(key, shape=())
      for key in _transformed_names(_DENSE_FLOAT_FEATURE_KEYS)
  ]
  categorical_columns = [
      tf.feature_column.categorical_column_with_identity(
          key, num_buckets=_VOCAB_SIZE + _OOV_SIZE, default_value=0)
      for key in _transformed_names(_VOCAB_FEATURE_KEYS)
  ]
  categorical_columns += [
      tf.feature_column.categorical_column_with_identity(
          key, num_buckets=_FEATURE_BUCKET_COUNT, default_value=0)
      for key in _transformed_names(_BUCKET_FEATURE_KEYS)
  ]
  categorical_columns += [
      tf.feature_column.categorical_column_with_identity(  # pylint: disable=g-complex-comprehension
          key,
          num_buckets=num_buckets,
          default_value=0) for key, num_buckets in zip(
              _transformed_names(_CATEGORICAL_FEATURE_KEYS),
              _MAX_CATEGORICAL_FEATURE_VALUES)
  ]
  indicator_column = [
      tf.feature_column.indicator_column(categorical_column)
      for categorical_column in categorical_columns
  ]

  model = _wide_and_deep_classifier(
      wide_columns=indicator_column,
      deep_columns=real_valued_columns,
      dnn_hidden_units=hidden_units or [100, 70, 50, 25])
  return model

def _wide_and_deep_classifier(wide_columns, deep_columns, dnn_hidden_units):
  """Build a simple keras wide and deep model.

  Args:
    wide_columns: Feature columns wrapped in indicator_column for wide (linear)
      part of the model.
    deep_columns: Feature columns for deep part of the model.
    dnn_hidden_units: [int], the layer sizes of the hidden DNN.

  Returns:
    A Wide and Deep Keras model
  """
  # Following values are hard coded for simplicity in this example,
  # However prefarably they should be passsed in as hparams.

  # Keras needs the feature definitions at compile time.
  input_layers = {
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype=tf.float32)
      for colname in _transformed_names(_DENSE_FLOAT_FEATURE_KEYS)
  }
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_VOCAB_FEATURE_KEYS)
  })
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_BUCKET_FEATURE_KEYS)
  })
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_CATEGORICAL_FEATURE_KEYS)
  })

  deep = tf.keras.layers.DenseFeatures(deep_columns)(input_layers)
  for numnodes in dnn_hidden_units:
    deep = tf.keras.layers.Dense(numnodes)(deep)
  wide = tf.keras.layers.DenseFeatures(wide_columns)(input_layers)

  output = tf.keras.layers.Dense(
      1, activation='sigmoid')(
          tf.keras.layers.concatenate([deep, wide]))

  model = tf.keras.Model(input_layers, output)
  model.compile(
      loss='binary_crossentropy',
      optimizer=tf.keras.optimizers.Adam(lr=0.001),
      metrics=[tf.keras.metrics.BinaryAccuracy()])
  model.summary(print_fn=absl.logging.info)
  return model

# TFX Trainer will call this function.
def run_fn(fn_args: TrainerFnArgs):
  """Train the model based on given args.

  Args:
    fn_args: Holds args used to train the model as name/value pairs.
  """
  # Number of nodes in the first layer of the DNN
  first_dnn_layer_size = 100
  num_dnn_layers = 4
  dnn_decay_factor = 0.7

  tf_transform_output = tft.TFTransformOutput(fn_args.transform_output)

  train_dataset = _input_fn(fn_args.train_files, tf_transform_output, 40)
  eval_dataset = _input_fn(fn_args.eval_files, tf_transform_output, 40)

  model = _build_keras_model(
      # Construct layers sizes with exponetial decay
      hidden_units=[
          max(2, int(first_dnn_layer_size * dnn_decay_factor**i))
          for i in range(num_dnn_layers)
      ])

  # This log path might change in the future.
  log_dir = os.path.join(os.path.dirname(fn_args.serving_model_dir), 'logs')
  tensorboard_callback = tf.keras.callbacks.TensorBoard(
      log_dir=log_dir, update_freq='batch')
  model.fit(
      train_dataset,
      steps_per_epoch=fn_args.train_steps,
      validation_data=eval_dataset,
      validation_steps=fn_args.eval_steps,
      callbacks=[tensorboard_callback])

  signatures = {
      'serving_default':
          _get_serve_tf_examples_fn(model,
                                    tf_transform_output).get_concrete_function(
                                        tf.TensorSpec(
                                            shape=[None],
                                            dtype=tf.string,
                                            name='examples')),
  }
  model.save(fn_args.serving_model_dir, save_format='tf', signatures=signatures)

작성한 모델 코드를 Trainer 컴포넌트에 전달하여 모델을 학습시키겠습니다.

In []:

trainer = Trainer(
    module_file=os.path.abspath(_taxi_trainer_module_file),
    custom_executor_spec=executor_spec.ExecutorClassSpec(GenericExecutor),
    examples=transform.outputs['transformed_examples'],
    transform_graph=transform.outputs['transform_graph'],
    schema=schema_gen.outputs['schema'],
    train_args=trainer_pb2.TrainArgs(num_steps=10000),
    eval_args=trainer_pb2.EvalArgs(num_steps=5000))
context.run(trainer)

Evaluator

Evaluator 컴포넌트는 평가 데이터 세트를 이용하여 모델 성능 지표를 계산합니다. TFMA(TensorFlow Model Analysis) 라이브러리를 사용합니다. Evaluator 는 새로 학습된 모델이 이전 모델보다 더 나은지 선택적으로 검증할 수 있습니다. 이는 매일 모델을 자동으로 학습하고 검증할 수 있는 생산 파이프라인 설정에서 유용합니다. 현재 노트북에서는 하나의 모델만 학습하므로 Evaluator가 자동으로 모델에 “good”라고 라벨을 붙입니다.

EvaluatorExampleGen 에서 생성한 데이터와 Trainer 가 학습한 모델 그리고 슬라이싱 설정을 입력값으로 사용합니다. 슬라이싱 설정을 통해 피처 값에 대한 메트릭을 슬라이스할 수 있습니다.

In []:

eval_config = tfma.EvalConfig(
    model_specs=[
        # This assumes a serving model with signature 'serving_default'. If
        # using estimator based EvalSavedModel, add signature_name: 'eval' and 
        # remove the label_key.
        tfma.ModelSpec(label_key='tips')
    ],
    metrics_specs=[
        tfma.MetricsSpec(
            # The metrics added here are in addition to those saved with the
            # model (assuming either a keras model or EvalSavedModel is used).
            # Any metrics added into the saved model (for example using
            # model.compile(..., metrics=[...]), etc) will be computed
            # automatically.
            metrics=[
                tfma.MetricConfig(class_name='ExampleCount')
            ],
            # To add validation thresholds for metrics saved with the model,
            # add them keyed by metric name to the thresholds map.
            thresholds = {
                'binary_accuracy': tfma.MetricThreshold(
                    value_threshold=tfma.GenericValueThreshold(
                        lower_bound={'value': 0.5}),
                    change_threshold=tfma.GenericChangeThreshold(
                       direction=tfma.MetricDirection.HIGHER_IS_BETTER,
                       absolute={'value': -1e-10}))
            }
        )
    ],
    slicing_specs=[
        # An empty slice spec means the overall slice, i.e. the whole dataset.
        tfma.SlicingSpec(),
        # Data can be sliced along a feature column. In this case, data is
        # sliced along feature column trip_start_hour.
        tfma.SlicingSpec(feature_keys=['trip_start_hour'])
    ])

Evaluator 에 설정값을 넘겨서 실행 시키겠습니다.

In []:

# Use TFMA to compute a evaluation statistics over features of a model and
# validate them against a baseline.

# The model resolver is only required if performing model validation in addition
# to evaluation. In this case we validate against the latest blessed model. If
# no model has been blessed before (as in this case) the evaluator will make our
# candidate the first blessed model.
model_resolver = ResolverNode(
      instance_name='latest_blessed_model_resolver',
      resolver_class=latest_blessed_model_resolver.LatestBlessedModelResolver,
      model=Channel(type=Model),
      model_blessing=Channel(type=ModelBlessing))
context.run(model_resolver)

evaluator = Evaluator(
    examples=example_gen.outputs['examples'],
    model=trainer.outputs['model'],
    baseline_model=model_resolver.outputs['model'],
    # Change threshold will be ignored if there is no baseline (first run).
    eval_config=eval_config)
context.run(evaluator)

Pusher

Pusher 컴포넌트는 일반적으로 TFX 파이프라인의 마지막 단계에 위치해 있습니다. 모델이 유효성 검사를 통과했는지 여부를 확인하고, 합격하면 _serving_model_dir로 모델을 내보냅니다.

In []:

_serving_model_dir = os.path.join(tempfile.mkdtemp(), 'serving_model/taxi_simple')

pusher = Pusher(
    model=trainer.outputs['model'],
    model_blessing=evaluator.outputs['blessing'],
    push_destination=pusher_pb2.PushDestination(
        filesystem=pusher_pb2.PushDestination.Filesystem(
            base_directory=_serving_model_dir)))
context.run(pusher)

파이프라인 생성하기

앞서 작성한 코드들을 이용하여, TFX 파이프라인을 생성해 보겠습니다. 그리고 KubeflowDagRunner 를 이용하여 TFX 파이프라인을 Kubeflow 파이프라인 패키지로 변환하겠습니다.

모듈 파일 생성하기

TFX 파이프라인 컴포넌트에서 사용할 모듈 파일을 생성하겠습니다. 앞서 작성한 코드를 묶어 하나의 파일로 생성하겠습니다. Transform 컴포넌트에서 사용했던 taxi_constants.pytaxi_transform.py 파일 그리고 Trainer 컴포넌트에서 사용했던 taxi_trainer.py 파일을 합쳐서 taxi_utils.py 파일을 생성하겠습니다.

taxi_utils.py

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

from typing import List, Text

import absl
import tensorflow as tf
import tensorflow_transform as tft

from tfx.components.trainer.executor import TrainerFnArgs

# Categorical features are assumed to each have a maximum value in the dataset.
_MAX_CATEGORICAL_FEATURE_VALUES = [24, 31, 12]

_CATEGORICAL_FEATURE_KEYS = [
    'trip_start_hour', 'trip_start_day', 'trip_start_month',
    'pickup_census_tract', 'dropoff_census_tract', 'pickup_community_area',
    'dropoff_community_area'
]

_DENSE_FLOAT_FEATURE_KEYS = ['trip_miles', 'fare', 'trip_seconds']

# Number of buckets used by tf.transform for encoding each feature.
_FEATURE_BUCKET_COUNT = 10

_BUCKET_FEATURE_KEYS = [
    'pickup_latitude', 'pickup_longitude', 'dropoff_latitude',
    'dropoff_longitude'
]

# Number of vocabulary terms used for encoding VOCAB_FEATURES by tf.transform
_VOCAB_SIZE = 1000

# Count of out-of-vocab buckets in which unrecognized VOCAB_FEATURES are hashed.
_OOV_SIZE = 10

_VOCAB_FEATURE_KEYS = [
    'payment_type',
    'company',
]

# Keys
_LABEL_KEY = 'tips'
_FARE_KEY = 'fare'

def _transformed_name(key):
  return key + '_xf'

def _transformed_names(keys):
  return [_transformed_name(key) for key in keys]

def _gzip_reader_fn(filenames):
  """Small utility returning a record reader that can read gzip'ed files."""
  return tf.data.TFRecordDataset(
      filenames,
      compression_type='GZIP')

def _fill_in_missing(x):
  """Replace missing values in a SparseTensor.

  Fills in missing values of `x` with '' or 0, and converts to a dense tensor.

  Args:
    x: A `SparseTensor` of rank 2.  Its dense shape should have size at most 1
      in the second dimension.

  Returns:
    A rank 1 tensor where missing values of `x` have been filled in.
  """
  default_value = '' if x.dtype == tf.string else 0
  return tf.squeeze(
      tf.sparse.to_dense(
          tf.SparseTensor(x.indices, x.values, [x.dense_shape[0], 1]),
          default_value),
      axis=1)

def _get_serve_tf_examples_fn(model, tf_transform_output):
  """Returns a function that parses a serialized tf.Example and applies TFT."""

  model.tft_layer = tf_transform_output.transform_features_layer()

  @tf.function
  def serve_tf_examples_fn(serialized_tf_examples):
    """Returns the output to be used in the serving signature."""
    feature_spec = tf_transform_output.raw_feature_spec()
    feature_spec.pop(_LABEL_KEY)
    parsed_features = tf.io.parse_example(serialized_tf_examples, feature_spec)

    transformed_features = model.tft_layer(parsed_features)
    # TODO(b/148082271): Remove this line once TFT 0.22 is used.
    transformed_features.pop(_transformed_name(_LABEL_KEY), None)

    return model(transformed_features)

  return serve_tf_examples_fn

def _input_fn(file_pattern: Text,
              tf_transform_output: tft.TFTransformOutput,
              batch_size: int = 200) -> tf.data.Dataset:
  """Generates features and label for tuning/training.

  Args:
    file_pattern: input tfrecord file pattern.
    tf_transform_output: A TFTransformOutput.
    batch_size: representing the number of consecutive elements of returned
      dataset to combine in a single batch

  Returns:
    A dataset that contains (features, indices) tuple where features is a
      dictionary of Tensors, and indices is a single Tensor of label indices.
  """
  transformed_feature_spec = (
      tf_transform_output.transformed_feature_spec().copy())

  dataset = tf.data.experimental.make_batched_features_dataset(
      file_pattern=file_pattern,
      batch_size=batch_size,
      features=transformed_feature_spec,
      reader=_gzip_reader_fn,
      label_key=_transformed_name(_LABEL_KEY))

  return dataset

def _build_keras_model(hidden_units: List[int] = None) -> tf.keras.Model:
  """Creates a DNN Keras model for classifying taxi data.

  Args:
    hidden_units: [int], the layer sizes of the DNN (input layer first).

  Returns:
    A keras Model.
  """
  real_valued_columns = [
      tf.feature_column.numeric_column(key, shape=())
      for key in _transformed_names(_DENSE_FLOAT_FEATURE_KEYS)
  ]
  categorical_columns = [
      tf.feature_column.categorical_column_with_identity(
          key, num_buckets=_VOCAB_SIZE + _OOV_SIZE, default_value=0)
      for key in _transformed_names(_VOCAB_FEATURE_KEYS)
  ]
  categorical_columns += [
      tf.feature_column.categorical_column_with_identity(
          key, num_buckets=_FEATURE_BUCKET_COUNT, default_value=0)
      for key in _transformed_names(_BUCKET_FEATURE_KEYS)
  ]
  categorical_columns += [
      tf.feature_column.categorical_column_with_identity(  # pylint: disable=g-complex-comprehension
          key,
          num_buckets=num_buckets,
          default_value=0) for key, num_buckets in zip(
              _transformed_names(_CATEGORICAL_FEATURE_KEYS),
              _MAX_CATEGORICAL_FEATURE_VALUES)
  ]
  indicator_column = [
      tf.feature_column.indicator_column(categorical_column)
      for categorical_column in categorical_columns
  ]

  model = _wide_and_deep_classifier(
      wide_columns=indicator_column,
      deep_columns=real_valued_columns,
      dnn_hidden_units=hidden_units or [100, 70, 50, 25])
  return model

def _wide_and_deep_classifier(wide_columns, deep_columns, dnn_hidden_units):
  """Build a simple keras wide and deep model.

  Args:
    wide_columns: Feature columns wrapped in indicator_column for wide (linear)
      part of the model.
    deep_columns: Feature columns for deep part of the model.
    dnn_hidden_units: [int], the layer sizes of the hidden DNN.

  Returns:
    A Wide and Deep Keras model
  """
  # Following values are hard coded for simplicity in this example,
  # However prefarably they should be passsed in as hparams.

  # Keras needs the feature definitions at compile time.
  input_layers = {
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype=tf.float32)
      for colname in _transformed_names(_DENSE_FLOAT_FEATURE_KEYS)
  }
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_VOCAB_FEATURE_KEYS)
  })
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_BUCKET_FEATURE_KEYS)
  })
  input_layers.update({
      colname: tf.keras.layers.Input(name=colname, shape=(), dtype='int32')
      for colname in _transformed_names(_CATEGORICAL_FEATURE_KEYS)
  })

  # TODO(b/144500510): SparseFeatures for feature columns + Keras.
  deep = tf.keras.layers.DenseFeatures(deep_columns)(input_layers)
  for numnodes in dnn_hidden_units:
    deep = tf.keras.layers.Dense(numnodes)(deep)
  wide = tf.keras.layers.DenseFeatures(wide_columns)(input_layers)

  output = tf.keras.layers.Dense(
      1, activation='sigmoid')(
          tf.keras.layers.concatenate([deep, wide]))

  model = tf.keras.Model(input_layers, output)
  model.compile(
      loss='binary_crossentropy',
      optimizer=tf.keras.optimizers.Adam(lr=0.001),
      metrics=[tf.keras.metrics.BinaryAccuracy()])
  model.summary(print_fn=absl.logging.info)
  return model

# TFX Transform will call this function.
def preprocessing_fn(inputs):
  """tf.transform's callback function for preprocessing inputs.

  Args:
    inputs: map from feature keys to raw not-yet-transformed features.

  Returns:
    Map from string feature key to transformed feature operations.
  """
  outputs = {}
  for key in _DENSE_FLOAT_FEATURE_KEYS:
    # Preserve this feature as a dense float, setting nan's to the mean.
    outputs[_transformed_name(key)] = tft.scale_to_z_score(
        _fill_in_missing(inputs[key]))

  for key in _VOCAB_FEATURE_KEYS:
    # Build a vocabulary for this feature.
    outputs[_transformed_name(key)] = tft.compute_and_apply_vocabulary(
        _fill_in_missing(inputs[key]),
        top_k=_VOCAB_SIZE,
        num_oov_buckets=_OOV_SIZE)

  for key in _BUCKET_FEATURE_KEYS:
    outputs[_transformed_name(key)] = tft.bucketize(
        _fill_in_missing(inputs[key]),
        _FEATURE_BUCKET_COUNT,
        always_return_num_quantiles=False)

  for key in _CATEGORICAL_FEATURE_KEYS:
    outputs[_transformed_name(key)] = _fill_in_missing(inputs[key])

  # Was this passenger a big tipper?
  taxi_fare = _fill_in_missing(inputs[_FARE_KEY])
  tips = _fill_in_missing(inputs[_LABEL_KEY])
  outputs[_transformed_name(_LABEL_KEY)] = tf.where(
      tf.math.is_nan(taxi_fare),
      tf.cast(tf.zeros_like(taxi_fare), tf.int64),
      # Test if the tip was > 20% of the fare.
      tf.cast(
          tf.greater(tips, tf.multiply(taxi_fare, tf.constant(0.2))), tf.int64))

  return outputs

# TFX Trainer will call this function.
def trainer_fn(fn_args: TrainerFnArgs):
  """Train the model based on given args.

  Args:
    fn_args: Holds args used to train the model as name/value pairs.
  """
  # Number of nodes in the first layer of the DNN
  first_dnn_layer_size = 100
  num_dnn_layers = 4
  dnn_decay_factor = 0.7

  tf_transform_output = tft.TFTransformOutput(fn_args.transform_output)

  train_dataset = _input_fn(fn_args.train_files, tf_transform_output, 40)
  eval_dataset = _input_fn(fn_args.eval_files, tf_transform_output, 40)

  mirrored_strategy = tf.distribute.MirroredStrategy()
  with mirrored_strategy.scope():
    model = _build_keras_model(
        # Construct layers sizes with exponetial decay
        hidden_units=[
            max(2, int(first_dnn_layer_size * dnn_decay_factor**i))
            for i in range(num_dnn_layers)
        ])

  model.fit(
      train_dataset,
      steps_per_epoch=fn_args.train_steps,
      validation_data=eval_dataset,
      validation_steps=fn_args.eval_steps)

  signatures = {
      'serving_default':
          _get_serve_tf_examples_fn(model,
                                    tf_transform_output).get_concrete_function(
                                        tf.TensorSpec(
                                            shape=[None],
                                            dtype=tf.string,
                                            name='examples')),
  }
  model.save(fn_args.serving_model_dir, save_format='tf', signatures=signatures)

패키지 추가하기

새로운 주피터 노트북을 생성하고, TFX 컴포넌트와 필요한 패키지를 추가합니다.

In []:

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

import os
from typing import Text

from kfp import onprem
import tensorflow_model_analysis as tfma

from tfx.components import CsvExampleGen
from tfx.components import Evaluator
from tfx.components import ExampleValidator
from tfx.components import InfraValidator
from tfx.components import Pusher
from tfx.components import ResolverNode
from tfx.components import SchemaGen
from tfx.components import StatisticsGen
from tfx.components import Trainer
from tfx.components import Transform
from tfx.components.base import executor_spec
from tfx.components.trainer.executor import GenericExecutor
from tfx.dsl.experimental import latest_blessed_model_resolver
from tfx.orchestration import pipeline
from tfx.orchestration.kubeflow import kubeflow_dag_runner
from tfx.proto import infra_validator_pb2
from tfx.proto import pusher_pb2
from tfx.proto import trainer_pb2
from tfx.types import Channel
from tfx.types.standard_artifacts import Model
from tfx.types.standard_artifacts import ModelBlessing
from tfx.utils.dsl_utils import external_input

파이프라인 이름 정의하기

사용할 파이프라인 이름을 지정해 줍니다.

In[]:

_pipeline_name = 'chicago_taxi_pipeline_kubeflow_pvc'

파이프라인에서 사용할 PVC 정보를 지정해 줍니다.

In []:

_persistent_volume_claim = 'chicago-taxi-pvc'
_persistent_volume = 'chicago-taxi-pv'
_persistent_volume_mount = '/mnt'

사용할 경로들을 지정해 줍니다. _data_root 퍼시스턴스 볼륨에 저장된 학습 데이터의 경로이고, _pipeline_root 는 파이프라인에서 사용할 경로입니다.

In []:

# All input and output data are kept in the PV.
_input_base = os.path.join(_persistent_volume_mount, 'tfx')
_data_root = os.path.join(_input_base, 'data')

_output_base = os.path.join(_persistent_volume_mount, 'pipelines')
_tfx_root = os.path.join(_output_base, 'tfx')
_pipeline_root = os.path.join(_tfx_root, _pipeline_name)

TFX 컴포넌트에 추가할 사용자 정의 코드 파일의 경로를 지정합니다. Transform 컴포넌트와 Trainer 컴포넌트에서 사용하는 사용자 정의 코드입니다.

In []:

_module_file = os.path.join(_input_base, 'taxi_utils.py')

학습된 모델을 저장할 위치를 정의합니다. Pusher 컴포넌트에서 해당 위치로 모델을 저장합니다.

In []:

_serving_model_dir = os.path.join(_output_base, _pipeline_name, 'serving_model')

TFX 컴포넌트들을 이용하여 TFX 파이프라인 생성 코드를 작성합니다.

In []:

def _create_pipeline(pipeline_name: Text, pipeline_root: Text, data_root: Text,
                     module_file: Text, serving_model_dir: Text,
                     direct_num_workers: int) -> pipeline.Pipeline:
  """Implements the chicago taxi pipeline with TFX and Kubeflow Pipelines."""
  examples = external_input(data_root)

  # Brings data into the pipeline or otherwise joins/converts training data.
  example_gen = CsvExampleGen(input=examples)

  # Computes statistics over data for visualization and example validation.
  statistics_gen = StatisticsGen(examples=example_gen.outputs['examples'])

  # Generates schema based on statistics files.
  schema_gen = SchemaGen(
      statistics=statistics_gen.outputs['statistics'],
      infer_feature_shape=False)

  # Performs anomaly detection based on statistics and data schema.
  example_validator = ExampleValidator(
      statistics=statistics_gen.outputs['statistics'],
      schema=schema_gen.outputs['schema'])

  # Performs transformations and feature engineering in training and serving.
  transform = Transform(
      examples=example_gen.outputs['examples'],
      schema=schema_gen.outputs['schema'],
      module_file=module_file)

  # Uses user-provided Python function that implements a model using TF-Learn
  # to train a model on Google Cloud AI Platform.
  trainer = Trainer(
      module_file=module_file,
      custom_executor_spec=executor_spec.ExecutorClassSpec(GenericExecutor),
      examples=transform.outputs['transformed_examples'],
      transform_graph=transform.outputs['transform_graph'],
      schema=schema_gen.outputs['schema'],
      train_args=trainer_pb2.TrainArgs(num_steps=10000),
      eval_args=trainer_pb2.EvalArgs(num_steps=5000))
  

  # Uses TFMA to compute a evaluation statistics over features of a model and
  # perform quality validation of a candidate model (compared to a baseline).
  eval_config = tfma.EvalConfig(
    model_specs=[
        # This assumes a serving model with signature 'serving_default'. If
        # using estimator based EvalSavedModel, add signature_name: 'eval' and 
        # remove the label_key.
        tfma.ModelSpec(label_key='tips')
    ],
    metrics_specs=[
        tfma.MetricsSpec(
            # The metrics added here are in addition to those saved with the
            # model (assuming either a keras model or EvalSavedModel is used).
            # Any metrics added into the saved model (for example using
            # model.compile(..., metrics=[...]), etc) will be computed
            # automatically.
            metrics=[
                tfma.MetricConfig(class_name='ExampleCount')
            ],
            # To add validation thresholds for metrics saved with the model,
            # add them keyed by metric name to the thresholds map.
            thresholds = {
                'binary_accuracy': tfma.MetricThreshold(
                    value_threshold=tfma.GenericValueThreshold(
                        lower_bound={'value': 0.5}),
                    change_threshold=tfma.GenericChangeThreshold(
                       direction=tfma.MetricDirection.HIGHER_IS_BETTER,
                       absolute={'value': -1e-10}))
            }
        )
    ],
    slicing_specs=[
        # An empty slice spec means the overall slice, i.e. the whole dataset.
        tfma.SlicingSpec(),
        # Data can be sliced along a feature column. In this case, data is
        # sliced along feature column trip_start_hour.
        tfma.SlicingSpec(feature_keys=['trip_start_hour'])
    ])

  # Get the latest blessed model for model validation.
  model_resolver = ResolverNode(
      instance_name='latest_blessed_model_resolver',
      resolver_class=latest_blessed_model_resolver.LatestBlessedModelResolver,
      model=Channel(type=Model),
      model_blessing=Channel(type=ModelBlessing))

  evaluator = Evaluator(
      examples=example_gen.outputs['examples'],
      model=trainer.outputs['model'],
      baseline_model=model_resolver.outputs['model'],
      # Change threshold will be ignored if there is no baseline (first run).
      eval_config=eval_config)

  # Performs infra validation of a candidate model to prevent unservable model
  # from being pushed. In order to use InfraValidator component, persistent
  # volume and its claim that the pipeline is using should be a ReadWriteMany
  # access mode.
  infra_validator = InfraValidator(
      model=trainer.outputs['model'],
      examples=example_gen.outputs['examples'],
      serving_spec=infra_validator_pb2.ServingSpec(
          tensorflow_serving=infra_validator_pb2.TensorFlowServing(
              tags=['latest']),
          kubernetes=infra_validator_pb2.KubernetesConfig()),
      request_spec=infra_validator_pb2.RequestSpec(
          tensorflow_serving=infra_validator_pb2.TensorFlowServingRequestSpec())
  )

  # Checks whether the model passed the validation steps and pushes the model
  # to  Google Cloud AI Platform if check passed.
  pusher = Pusher(
      model=trainer.outputs['model'],
      model_blessing=evaluator.outputs['blessing'],
      infra_blessing=infra_validator.outputs['blessing'],
      push_destination=pusher_pb2.PushDestination(
          filesystem=pusher_pb2.PushDestination.Filesystem(
              base_directory=serving_model_dir)))

  return pipeline.Pipeline(
      pipeline_name=pipeline_name,
      pipeline_root=pipeline_root,
      components=[
          example_gen,
          statistics_gen,
          schema_gen,
          example_validator,
          transform,
          trainer,
          model_resolver,
          evaluator,
          infra_validator,
          pusher,
      ],
      beam_pipeline_args=['--direct_num_workers=%d' % direct_num_workers],
  )

TFX 에서 사용할 메타데이터 저장소의 정보를 지정합니다. Kubeflow의 메타데이터를 사용하겠습니다.

In []:

from tfx.orchestration.kubeflow.proto import kubeflow_pb2

metadata_config = kubeflow_pb2.KubeflowMetadataConfig()
metadata_config.grpc_config.grpc_service_host.value = 'metadata-grpc-service'
metadata_config.grpc_config.grpc_service_port.value = '8080'

KubeflowDagRunner 를 사용하여, 작성한 TFX 파이프라인을 Kubeflow 파이프라인으로 생성합니다. 해당 셀이 실행되면, chicago_taxi_pipeline_kubeflow_pvc.tar.gz 라는 Kubeflow 파이프라인 패키지가 생성됩니다.

In []:

if __name__ == '__main__':
  # This pipeline automatically injects the Kubeflow TFX image if the
  # environment variable 'KUBEFLOW_TFX_IMAGE' is defined. Currently, the tfx
  # cli tool exports the environment variable to pass to the pipelines.
  tfx_image = os.environ.get('KUBEFLOW_TFX_IMAGE', None)

  runner_config = kubeflow_dag_runner.KubeflowDagRunnerConfig(
      kubeflow_metadata_config=metadata_config,
      # Specify custom docker image to use.
      tfx_image=tfx_image,
      pipeline_operator_funcs=(
          [
              onprem.mount_pvc(_persistent_volume_claim, _persistent_volume,
                               _persistent_volume_mount)
          ]))

  kubeflow_dag_runner.KubeflowDagRunner(config=runner_config).run(
      _create_pipeline(
          pipeline_name=_pipeline_name,
          pipeline_root=_pipeline_root,
          data_root=_data_root,
          module_file=_module_file,
          serving_model_dir=_serving_model_dir,
          # 0 means auto-detect based on the number of CPUs available during
          # execution time.
          direct_num_workers=0))

파이프라인 실행하기

PVC 생성하기

파이프라인에서 사용할 PVC를 생성합니다.

chicago-taxi-pvc.yaml

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: chicago-taxi-pvc
spec:
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 500Mi
kubectl -n kubeflow apply -f chicago-taxi-pvc.yaml

PV에 파일 복사하기

파이프라인을 실행하기에 앞서, 필요한 파일을 퍼시스턴스 볼륨에 복사하도록 하겠습니다. 학습을 위한 데이터 파일과 사용자 정의 코드가 들어 있는 파이썬 파일을 복사합니다.

퍼시스턴스 볼륨에 파일을 업로드하는 방법은 다양하게 존재하기 때문에, 편하신 방법을 사용하시면 됩니다. 예제에서는 퍼시스턴스 볼륨에 파일을 업로드하기 위해서, “PHP File Manager” 를 사용하였습니다. 파일 매니저를 POD로 실행한 다음, 웹 브라우저를 이용해서 파일을 업로드하겠습니다.

먼저 파일 매니저 POD 매니페스트를 작성합니다. chicago-taxi-pvc 를 이용하여 볼륨을 마운트 합니다.

다음은 파일 매니저 POD의 매니페스트 입니다.

filemanager.yaml

apiVersion: v1
kind: Pod
metadata:
  name: filemanager
spec:
  containers:
  - image: smokserwis/filemanager
    imagePullPolicy: IfNotPresent
    name: filemanager
    ports:
    - containerPort: 80
      name: http
      protocol: TCP
    volumeMounts:
    - mountPath: /var/www/mount
      name: chicago-taxi
  volumes:
  - name: chicago-taxi
    persistentVolumeClaim:
      claimName: chicago-taxi-pvc

다음 명령어를 실행하여 파일 매니저 POD를 생성합니다.

kubectl -n kubeflow apply -f filemanager.yaml

파일 매니저에 접근하기 위하여 포트포워딩을 사용합니다.

kubectl -n kubeflow port-forward filemanager 8080:80

웹 브라우저를 이용하여 “http://localhost:8080” 에 접속하면 다음과 같은 로그인 화면을 볼 수 있습니다. 사용자명과 비밀번호의 기본값은 fm_admin / fm_admin 입니다.

https://raw.githubusercontent.com/tensorflow/tfx/master/tfx/examples/chicago_taxi_pipeline/data/simple/data.csv 파일을 다운로드 받아서 /tfx/data/data.csv 경로로 파일을 업로드 합니다.

그리고 앞서 생성한 taxi_utils.py 파일을 /tfx/taxi_utils.py 경로로 업로드 합니다.

포트 포워딩을 종료하고, 파일 매니저를 삭제하겠습니다.

kubectl -n kubeflow delete pod filemanager

파이프라인 실행하기

KFP SDK를 이용하여, 생성한 파이프라인 패키지를 실행해 보겠습니다.

In []:

import kfp

run_result = kfp.Client(
    host=None  # replace with Kubeflow Pipelines endpoint if this notebook is run outside of the Kubeflow cluster.
).create_run_from_pipeline_package('chicago_taxi_pipeline_kubeflow_pvc.tar.gz', arguments={})

다음은 파이프라인의 화면입니다.

캐글 – 집 값 예측

머신 러닝 파이프라인을 만들기 위하여, 캐글의 집 값 데이터를 사용해 보도록 하겠습니다.

집 값 예측은, 미국 아이오와 주의 에임스에 있는 주거용 주택의 정보를 이용하여 주택의 판매가격을 예측하는 Competition입니다.

이 장에서는 집 값 예측 결과를 캐글에 제출하기 위한 파이프라인을 구성해 볼 것입니다. 그리고 파이프라인에서 Katib를 이용하여 모델의 하이퍼 파라미터 튜닝을 할 것입니다. 데이터를 저장하기 위해서, PVC와 S3 두 개 모두 사용하겠습니다.

데이터 분석 보다는 전체적인 파이프라인을 만드는 것에 중점을 두고 설명하겠습니다.

사전 준비

House Prices: Advanced Regression Techniques 접속

예제에서 사용할 데이터가 있는 집 값예측 Competition 의 주소는 다음과 같습니다.

<https://www.kaggle.com/c/house-prices-advanced-regression-techniques>

해당 주소로 직접 접속하셔도 되고, 상단에 있는 검색바를 이용하여 검색하셔도 됩니다.

다음은 검색바를 이용하여, “House Prices: Advanced Regression Techniques” 을 검색한 결과입니다.

“House Prices: Advanced Regression Techniques” Competition 페이지 접속하면 다음과 같은 화면을 볼 수 있습니다.

데이터는 “Data” 탭에서 받을 수 있습니다. “Data” 탭을 클릭하면, 데이터에 대한 자세한 설명과 다운로드 받는 방법을 볼 수 있습니다.

주피터 노트북

주피터에서 새로운 Terminal 을 엽니다.

주피터 노트북에서 타이타닉 데이터 다운로드하기

작업 디렉토리를 생성한 다음, 타이타닉 데이터를 다운로드 합니다. house-prices-advanced-regression-techniques.zip 라는 파일이 다운로드 됩니다.

mkdir -p ~/workspace/house-prices/kaggle
cd ~/workspace/house-prices/kaggle
kaggle competitions download -c house-prices-advanced-regression-techniques
Downloading house-prices-advanced-regression-techniques.zip to /home/jovyan/workspace/house-prices/kaggle
  0%|                                                                                          | 0.00/34.1k [00:00<?, ?B/s]
100%|██████████████████████████████████████████████████████████████████████████████████| 34.1k/34.1k [00:00<00:00, 842kB/s]

다운로드한 파일의 압축을 풀겠습니다. 모델 학습을 위한 train.csv 파일과, 예측에 사용할 데이터인 test.csv 그리고, 캐글에 제출할 파일의 형식을 보여주는 sample_submission.csv 파일이 생성됩니다.

unzip house-prices-advanced-regression-techniques.zip
Archive:  house-prices-advanced-regression-techniques.zip
  inflating: data_description.txt
  inflating: sample_submission.csv
  inflating: test.csv
  inflating: train.csv

파이썬 패키지 설치

머신 러닝 모델 코드를 작성하기 위한 패키지들을 설치합니다. 이 장에서는 xgboost 패키지와 pandas_profiling 패키지를 추가로 사용합니다. 만약 설치되어 있지 않다면, 다음 명령어를 실행하여 패키지를 설치합니다.

pip install xgboost pandas_profiling  --user

데이터 전처리와 모델 작성

문제 정의하기

주어진 데이터를 바탕으로, 집 값을 예측하는 문제입니다.

데이터 전처리

머신 러닝 모델에서 데이터를 사용할 수 있도록, 데이터를 전처리 해 보겠습니다. 먼저 캐글에서 제공한 데이터를 살펴보도록 하겠습니다. 이번에는 pandas_profiling 라는 패키지를 사용해 보겠습니다.

집 값 데이터 분석 및 검증

먼저 집 값 데이터에 대해 이해하기 위하여, 간단히 탐색해보도록 하겠습니다.

주피터 노트북을 생성합니다. 노트북의 위치는 ~/workspace/house-prices입니다. 앞으로 작성할 예제에서는 노트북이 ~/workspace/house-prices 에 위치하고 있다고 가정하여, 파일 경로를 설정할 것입니다.

주피터 노트북을 이용하여 데이터를 분석 및 검증해 보겠습니다.

판다스를 이용하여, 다운받은 캐글 데이터를 읽어 오겠습니다.

In[] :

import os
import pandas as pd

input_path='./kaggle'
train_data = pd.read_csv(os.path.join(input_path, 'train.csv'))
test_data = pd.read_csv(os.path.join(input_path, 'test.csv'))

pandas_profiling 을 이용하여, 데이터의 프로파일링 리포트를 출력하겠습니다.

In[] :

import pandas_profiling
train_data.profile_report()

프로파일링 리포트의 결과는 다음과 같습니다. 단 한 줄의 명령어로 데이터를 분석해 볼 수 있습니다.

리포트 결과를 보면 알 수 있듯이, 여러 타입의 데이터가 존재하고, 결측값도 존재하는 것을 확인할 수 있습니다.

데이터 처리

캐글에서 좋은 점수를 받는게 목적이 아니기 때문에, 과감히 ojbect 타입의 데이터를 삭제하겠습니다.

In []:

train_data = train_data.drop([], axis=1).select_dtypes(exclude=['object'])
train_X = train_data.drop(['SalePrice'], axis=1)
train_y = train_data['SalePrice']
test_data = test_data.drop([], axis=1).select_dtypes(exclude=['object'])

결측값들도 SimpleImputer 를 이용하여 간단히 처리하겠습니다. strategy='median' 을 지정하였기 때문에 결측값들은 중간값으로 대치됩니다.

In []:

imputer = SimpleImputer(strategy='median')
imputer.fit(train_X)

train_X = pd.DataFrame(imputer.transform(train_X), columns=train_X.columns, index=train_X.index)
train_data = pd.concat([train_X, train_y], axis=1)
test_data = pd.DataFrame(imputer.transform(test_data), columns=test_data.columns, index=test_data.index)

train_data = train_data.astype({'Id': int})
test_data = test_data.astype({'Id': int})

모델 학습 (Train)

준비한 데이터를 이용하여 모델을 학습해 보겠습니다.

먼저, 모델 학습을 위하여 데이터를 학습 세트와 테스트 세트로 나누겠습니다. sklearntrain_test_split() 를 사용하면, 간단히 나눌 수 있습니다.

In []:

from sklearn.model_selection import train_test_split

X = train_data.drop(['Id', 'SalePrice'], axis=1)
y = train_data['SalePrice']

X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2)

xgboostXGBRegressor을 사용하여, 모델을 학습 시켜 보겠습니다.

In []:

from xgboost import XGBRegressor

model = XGBRegressor()
model.fit(X_train, y_train, eval_set=[(X_test, y_test)])

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

[0]	validation_0-rmse:180608
[1]	validation_0-rmse:164048
...
[98]	validation_0-rmse:25150.7
[99]	validation_0-rmse:25156.1

이제 캐글에서 제공한 test 데이터를 가지고 예측해 보도록 하겠습니다.

pred = model.predict(test_data.drop(['Id'], axis=1))

예측한 결과물을 가지고, 캐글에 제공할 submission.csv 파일을 생성해 보겠습니다.

submission = pd.DataFrame({'Id': test_data['Id'], 'SalePrice': pred})
submission.to_csv('submission.csv', index=False)

submission 을 조회해 보겠습니다.

submission.head()

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

생성한 submission.csv 파일을 캐글에 제출하겠습니다. kaggle 명령어를 사용하여 제출합니다. kaggle 명령어가 PATH 에 포함되어 있지 않기 때문에 전체 경로를 적어 주었습니다.

!/home/jovyan/.local/bin/kaggle competitions submit -c house-prices-advanced-regression-techniques -f submission.csv -m "Message"

캐글의 “My Submissions” 탭을 클릭하면, 제출한 내용들을 확인할 수 있습니다.

파이프라인 만들기

앞서 작성한 코드들을 바탕으로 하여 파이프라인을 구성해 보겠습니다. 각각의 단계를 컴포넌트로 구성한 다음, 파이프라인을 작성하고 실행해 보겠습니다.

파이프라인의 단계는 다음과 같습니다.

  • 데이터 다운로드 : 캐글에서 데이터를 다운로드 합니다.
  • 데이터 압축풀기 : 캐글에서 다운로드한 데이터의 압축을 풉니다.
  • 데이터 변환 : train.csvtest.csv 의 데이터를 머신러닝의 학습에 사용할 수 있도록 변환합니다.
  • 모델 학습 : 변환된 train.csv 데이터를 이용하여 모델을 학습니다.
  • 예측 : 변환된 test.csv 데이터를 이용하여 예측합니다. 그리고 예측한 결과를 submission.csv 파일로 저장합니다.
  • 캐글 제출 : 생성된 submission.csv 파일을 캐글에 제출합니다.

기본 이미지 만들기

데이터 변환, 모덱 학습, 예측 컴포넌트에서 사용할 기본 이미지를 만들어 보겠습니다. 파이프라인에서도 필요한 이미지를 빌드할 수 있지만, 기본 이미지를 만들어서 사용하는게 더 효율적입니다. docker 명령어를 이용하여, 컨테이너 이미지를 빌드하기 때문에, docker 명령어가 실행 가능한 곳에서 작업을 해야합니다.

먼저 베이스 이미지 디렉토리를 만듭니다.

mkdir -p ~/workspace/base/xgboost
cd ~/workspace/base/xgboost

필요한 파이썬 패키지 목록을 requirements.txt 파일로 작성합니다.

requirements.txt

scikit-learn
joblib
numpy
pandas
fire
xgboost

컨테이너 이미지 빌드를 위하여 Dockerfile 파일을 작성합니다. 파이썬 패키지 목록인 requirements.txt 파일을 추가하고, 해당 파일을 이용하여 패키지를 설치합니다.

Dockerfile

FROM python:3.6-slim

RUN apt-get update -y && \\
    apt-get install -y libgomp1

WORKDIR /app
COPY requirements.txt /app

RUN pip --no-cache-dir install -r requirements.txt

컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하기 위하여 build_image.sh 파일을 작성합니다.

build_image.sh

#!/bin/bash -e

image_name=kangwoo/xgboost
image_tag=0.0.1
full_image_name=${image_name}:${image_tag}
base_image_tag=3.6-slim

cd "$(dirname "$0")"

docker build --build-arg BASE_IMAGE_TAG=$base_image_tag -t "$full_image_name" .
docker push "$full_image_name"

build_image.sh 파일을 실행하여, 컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하겠습니다.

chmod +x build_image.sh
./build_image.sh

데이터 전처리 파이프라인 작성하기

데이터 전처리 파이프라인에서는 세개의 컴포넌트를 사용합니다.

  • Download : 캐글에서 데이터를 다운로드 받습니다.
  • Unzip : 압축을 풉니다.
  • Transofrm : 데이터를 전처리한 후 S3에 저장합니다.

모든 데이터를 S3에 저장할 수 있으나, 앞서 만든 Download 컴포넌트와 Unzip 컴포넌트가 S3를 지원하기 않기 때문에, 퍼시스턴스 볼륨과 S3를 같이 사용하였습니다. AWS 접속하여 사용할 S3 버킷을 생성합니다.

파이프라인의 전체적인 흐름은 다음과 같습니다.

파이프라인의 데이터 변환 작업이 kubeflow 네임스페이스 실행되므로, 해당 작업이 S3에 접근할 수 있도록, kubeflow 네임스페이스에 aws-secret 을 생성해줘야합니다.

export AWS_ACCESS_KEY_ID=<YOUR_AWS_ACCESS_KEY_ID>
export AWS_SECRET_ACCESS_KEY=<YOUR_AWS_SECRET_ACCESS_KEY>

kubectl -n kubeflow create secret generic aws-secret \\
    --from-literal=AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \\
    --from-literal=AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}

데이터 전처리 파이프라인 컴포넌트 작성하기

주피터 노트북을 생성합니다. 파일 이름은 transform_pipeline_s3.ipynb 입니다. 노트북의 위치는 ~/workspace/house-prices입니다. 앞으로 작성할 예제에서는 노트북이 ~/workspace/house-prices 에 위치하고 있다고 가정하여, 파일 경로를 설정할 것입니다.

패키지 추가

파이프라인과 컴포넌트를 사용하기 위한 패키지를 추가합니다.

In []:

from kfp import components
from kfp import dsl

캐글 데이터 다운로드 컴포넌트

캐글에서 데이터를 다운로드 하는 컴포넌트를 정의합니다. 앞서 “타이타닉 생존 예측”에서 만들 컴포넌트를 재사용 합니다.

In []:

download_op = components.load_component_from_file('../components/kaggle/competitions_downloader/component.yaml')

데이터 압축풀기 컴포넌트

unzip 명령어를 사용하여 압축을 풀겠습니다.

In []:

def unzip_op(filename, exdir):
    return dsl.ContainerOp(name='Unzip',
                           image='garthk/unzip:latest',
                           command=['unzip', '-o', filename, '-d', exdir])

데이터 변환 컴포넌트

이번에는 [transform.py](<http://transform.py>) 라는 파이썬 파일을 생성한 후, 페어링을 이용하여 컨테이너 이미지를 빌드한 다음, 파이프라인에서 사용하도록 하겠습니다.

train.csvtest.csv 의 데이터를 머신러닝의 학습에 사용할 수 있도록 변환합니다. 캐글 데이터의 경로를 input_path 파라미터로 입력 받아 데이터를 변환합니다. 데이터 변환에 쓰이는 코드들은 앞에서 작성한 코드와 동일합니다. 변환할 데이터를 저장할 경로를 output_path 파라미터로 입력 받아 변환된 데이터를 저장합니다. 컨테이너 이미지를 빠르게 빌드하기 위하여, 필요한 패키지가 포함된 기본 이미지를 미리 만들어서 사용하였습니다.

주피터 노트북 셀에서 %%writefile transform.py 을 이용하여transform.py 파일을 생성합니다.

In []:

%%writefile transform.py
import argparse
import os
from tempfile import TemporaryDirectory

import pandas as pd
from sklearn.impute import SimpleImputer

def transform(input_path, output_path):
    train_data = pd.read_csv(os.path.join(input_path, 'train.csv'))
    test_data = pd.read_csv(os.path.join(input_path, 'test.csv'))

    train_data.dropna(axis=0, subset=['SalePrice'], inplace=True)

    train_data = train_data.drop([], axis=1).select_dtypes(exclude=['object'])
    train_X = train_data.drop(['SalePrice'], axis=1)
    train_y = train_data['SalePrice']
    test_data = test_data.drop([], axis=1).select_dtypes(exclude=['object'])

    imputer = SimpleImputer(strategy='median')
    imputer.fit(train_X)

    train_X = pd.DataFrame(imputer.transform(train_X), columns=train_X.columns, index=train_X.index)
    train_data = pd.concat([train_X, train_y], axis=1)
    test_data = pd.DataFrame(imputer.transform(test_data), columns=test_data.columns, index=test_data.index)
    
    train_data = train_data.astype({'Id': int})
    test_data = test_data.astype({'Id': int})

    
    access_key = os.environ['AWS_ACCESS_KEY_ID']
    secret_key = os.environ['AWS_SECRET_ACCESS_KEY']
    from minio import Minio
    minio_client = Minio('s3.amazonaws.com',
                 access_key=access_key,
                 secret_key=secret_key)
    
    from urllib.parse import urlparse
    url = urlparse(output_path, allow_fragments=False)
    bucket_name = url.netloc
    object_name = url.path.lstrip('/')
    
    with TemporaryDirectory() as tmpdir:
        tmp_train_data = os.path.join(tmpdir, 'train.csv')
        tmp_test_data = os.path.join(tmpdir, 'test.csv')
        train_data.to_csv(tmp_train_data, index=False)
        test_data.to_csv(tmp_test_data, index=False)
        minio_client.fput_object(bucket_name, os.path.join(object_name, 'train.csv'), tmp_train_data)
        minio_client.fput_object(bucket_name, os.path.join(object_name, 'test.csv'), tmp_test_data)

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--input_path', default='./kaggle', type=str)
    parser.add_argument('--output_path', default='./input', type=str)
    args = parser.parse_args()

    transform(args.input_path, args.output_path)

변환이 완료된 데이터를 S3에 저장하기 위하여, minio 라이브러리를 사용하였습니다. 그리고 S3에 접속하기 위한 자격 증명 정보는 AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY 라는 환경 변수를 이용하여 넘겨받습니다.

페어링을 이용하여, transform.py 파일이 포함된 컨테이너 이미지를 빌드하고 푸시하겠습니다. 주피터 노트북에서 페어링을 이용하여, 컨테이너 이미지를 푸시하려면, 별도의 설정이 되어 있야 합니다. 만약 설정이 되어 있지 않다면, “05-Kubeflow Fairing – 주피터 노트북에서 Kubeflow Fairing 설정하기“를 참고하셔서 설정하시기 바랍니다.

In []:

import uuid
from kubeflow import fairing
from kubeflow.fairing.kubernetes import utils as k8s_utils
from kubeflow.fairing.preprocessors import base
from kubeflow.fairing.builders.append import append

CONTAINER_REGISTRY = 'kangwoo'

preprocessor = base.BasePreProcessor(executable="transform.py")

builder = append.AppendBuilder(registry=CONTAINER_REGISTRY, image_name="house-prices-transform",
                           base_image="kangwoo/xgboost:0.82", preprocessor=preprocessor)
builder.build()

transform_image = builder.image_tag
print(transform_image)

데이터 전처리 파이프라인 생성하기

PVC와 캐글 토큰 확인하기

파이프라인 컴포넌트에서 이 PVC를 이용하여, 데이터를 저장하고 읽어 올 것입니다. PVC는 dsl.VolumeOp() 를 이용하여 생성한 후, 작업이 끝나면 삭제하도록 하겠습니다.

그리고 캐글 API 사용을 위한 토큰도 앞서 “타이타닉 생존 예측”에서 생성한 kaggle-secret 을 사용하겠습니다.

파이프라인 작성하기

주피터 노트북으로 돌아가서 파이프라인을 작성해 보겠습니다.

In []:

import os
import string

import kfp
import kfp.dsl as dsl
from kfp import components
from kfp import onprem
from kfp import aws
from kubernetes.client.models import V1Volume
from kubernetes.client.models import V1SecretVolumeSource
from kubernetes.client.models import V1VolumeMount

@dsl.pipeline(
    name='House Prices Transofrm Pipeline',
    description='House Prices Transofrm Pipeline'
)
def house_prices_transform_pipeline():
    
    secret_name = "aws-secret"
    
    competition_name = 'house-prices-advanced-regression-techniques'

    kaggle_data_path = os.path.join('/data/competitions', competition_name, 'kaggle')
    version = 'v0.0.1'
    ouput_data_path = os.path.join('s3://kfp-bucket/data/competitions', competition_name, 'input', version)
    
    volume_task = dsl.VolumeOp(
        name="house-prices-volume",
        resource_name="house-prices-pvc",
        modes=dsl.VOLUME_MODE_RWO,
        size="100Mi"
    )

    download_task = download_op(competition=competition_name, path=kaggle_data_path)\\
        .add_pvolumes({"/data": volume_task.volume})\\
        .add_volume(V1Volume(name='kaggle-secret', secret=V1SecretVolumeSource(secret_name='kaggle-secret')))\\
        .add_volume_mount(V1VolumeMount(name='kaggle-secret', mount_path='/root/.kaggle'))

    with dsl.Condition(download_task.outputs['downloaded'] == 'True'):
        unzip_task = unzip_op(os.path.join(kaggle_data_path, competition_name + '.zip'), kaggle_data_path)\\
                         .add_pvolumes({"/data": download_task.pvolume})\\
    
    
    transform_task = dsl.ContainerOp(
        name='Transform',
        image=transform_image,
        command=['python', '/app/transform.py'],
        arguments=['--input_path', kaggle_data_path, '--output_path', ouput_data_path],
        pvolumes={"/data": unzip_task.pvolume}
    ).apply(aws.use_aws_secret(secret_name,
            aws_access_key_id_name='AWS_ACCESS_KEY_ID',
            aws_secret_access_key_name='AWS_SECRET_ACCESS_KEY'))

    volume_task.delete().after(transform_task)
  

if __name__ == '__main__':
    kfp.compiler.Compiler().compile(house_prices_transform_pipeline, 'house-prices-transform.zip')

    client = kfp.Client()
    my_experiment = client.create_experiment(name='House Prices Experiment')
    my_run = client.run_pipeline(my_experiment.id, 'House Prices Transform Pipeline', 'house-prices-transform.zip')

생성된 링크를 클릭하시면, 다음과 같은 화면을 확인할 수 있습니다.

S3 저장소의 해당 버킷을 조회해 보면, 다음과 같이 2개의 데이터 파일이 생성된 것을 확인할 수 있습니다.


모델 학습 및 캐글 제출 파이프라인 컴포넌트 작성하기

모델 학습 및 캐글 제출 파이프라인에서는 세개의 컴포넌트를 사용합니다.

  • Katib Launcher: 하이퍼파리미터 튜닝을 위하여, Experiment 를 생성해 줍니다.
  • HP Out: 하이퍼파리미터 튜닝 결과 값을 출력해 줍니다.
  • Train: 하이퍼파리미터 값을 입력 받아 모델을 학습합니다. 학습한 모델은 S3에 저장합니다.
  • Predict : S3에서 모델을 가져와서, 예측을 수행합니다. 예측 결과 값을 퍼시스턴스 볼륨에 저장합니다.
  • Submit : 예측 결가 값을 캐글에 제출합니다.

모든 데이터를 S3에 저장할 수 있으나, 앞서 만든 Submit 컴포넌트가 S3를 지원하기 않기 때문에, 퍼시스턴스 볼륨과 S3를 같이 사용하였습니다. 그리고 하이퍼파라미터 튜닝을 위한 Experiment 리소스를 파이프라인이 실행되는 kubeflow 네임스가 아닌, 별도의 admin 네임스페이스에 생성하였습니다.

파이프라인의 전체적인 흐름은 다음과 같습니다.

하이퍼 파리미터 튜닝 작업이 admin 네임스페이스 실행되므로, 해당 작업들이 S3에 접근할 수 있도록, admin 네임스페이스에도 aws-secret 을 생성해줘야합니다.

export AWS_ACCESS_KEY_ID=<YOUR_AWS_ACCESS_KEY_ID>
export AWS_SECRET_ACCESS_KEY=<YOUR_AWS_SECRET_ACCESS_KEY>

kubectl -n admin create secret generic aws-secret \\
    --from-literal=AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \\
    --from-literal=AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}

모델 학습 및 캐글 제출 파이프라인 컴포넌트 작성하기

주피터 노트북을 생성합니다. 파일 이름은 train_pipeline_s3.ipynb 입니다. 노트북의 위치는 ~/workspace/house-prices입니다. 앞으로 작성할 예제에서는 노트북이 ~/workspace/house-prices 에 위치하고 있다고 가정하여, 파일 경로를 설정할 것입니다.

모델 학습과 예측 컴포넌트

train.py 파일을 생성한 후, 페어링을 이용하여 컨테이너 이미지를 빌드한 다음, 파이프라인에서 사용하도록 하겠습니다.

변환된 train.csv 데이터를 이용하여 모델을 학습니다. 변환된 데이터의 경로를 path 파리미터로 입력받에 데이터를 읽어옵니다. 그리고 데이터를 학습 세트와 테스트 세트로 나눈다음, 모델을 학습니다. 그리고 하이퍼 파라미터로서 n_estimatorslearning_rate 를 입력 받아, 모델 학습시 사용합니다. 그리고 mode 를 입력 받아, train 일 경우에는 모델 학습을, predict 일 경우에는 예측을 실행합니다. S3에서 데이터를 읽고, 저장하기 위하여 minio 라이브러리를 사용하였습니다.

주피터 노트북 셀에서 %%writefile train.py 을 이용하여 train.py 파일을 생성합니다.

In []:

%%writefile train.py
import argparse
import json
import os
from datetime import datetime, timezone
from tempfile import TemporaryDirectory

import pandas as pd
from sklearn.metrics import r2_score
from sklearn.model_selection import train_test_split
from xgboost import XGBRegressor

def read_train_input(input_path):
    minio_client = get_minio_client()
    bucket_name, object_name = get_bucket_name_and_object_name(input_path)
    with TemporaryDirectory() as tmpdir:
        tmp_train_data_file = os.path.join(tmpdir, 'train.csv')
        minio_client.fget_object(bucket_name, os.path.join(object_name, 'train.csv'), tmp_train_data_file)
        data = pd.read_csv(tmp_train_data_file)
        
    X = data.drop(['Id', 'SalePrice'], axis=1)
    y = data['SalePrice']

    X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2)

    return X_train, y_train, X_test, y_test

def read_test_input(input_path='./input'):
    minio_client = get_minio_client()
    bucket_name, object_name = get_bucket_name_and_object_name(input_path)
    with TemporaryDirectory() as tmpdir:
        tmp_test_data_file = os.path.join(tmpdir, 'test.csv')
        minio_client.fget_object(bucket_name, os.path.join(object_name, 'test.csv'), tmp_test_data_file)
        data = pd.read_csv(tmp_test_data_file)
        
    X = data.drop(['Id'], axis=1)
    id = data['Id']

    return X, id

def train_model(X_train, y_train,
                X_test, y_test,
                n_estimators, learning_rate, early_stopping_rounds):
    model = XGBRegressor(n_estimators=n_estimators, learning_rate=learning_rate)

    model.fit(X_train, y_train,
              early_stopping_rounds=early_stopping_rounds, eval_set=[(X_test, y_test)])

    print('Best RMSE on eval: {} with {} rounds'.format(model.best_score, model.best_iteration + 1))
    return model

def eval_model(model, X_test, y_test):
    predictions = model.predict(X_test)
    local_time = datetime.now(timezone.utc).astimezone().isoformat()
    score = r2_score(predictions, y_test)
    print('{} r2_score={}'.format(local_time, score))
    return score

MODE_FILENAME = 'model.bst'

def load_model(model_path):
    minio_client = get_minio_client()
    bucket_name, object_name = get_bucket_name_and_object_name(model_path)
    model = XGBRegressor()
    with TemporaryDirectory() as tmpdir:
        tmp_model_file = os.path.join(tmpdir, MODE_FILENAME)
        minio_client.fget_object(bucket_name, os.path.join(object_name, MODE_FILENAME), tmp_model_file)
        model.load_model(tmp_model_file)
        print('Load modelfrom ', os.path.join(model_path, MODE_FILENAME))
    return model

def save_model(model, model_path):
    minio_client = get_minio_client()
    bucket_name, object_name = get_bucket_name_and_object_name(model_path)
    with TemporaryDirectory() as tmpdir:
        tmp_model_file = os.path.join(tmpdir, MODE_FILENAME)
        model.save_model(tmp_model_file)
        minio_client.fput_object(bucket_name, os.path.join(object_name, MODE_FILENAME), tmp_model_file)
        print('Save model to', os.path.join(model_path, MODE_FILENAME))

def get_minio_client():
    access_key = os.environ['AWS_ACCESS_KEY_ID']
    secret_key = os.environ['AWS_SECRET_ACCESS_KEY']

    from minio import Minio
    return Minio('s3.amazonaws.com',access_key=access_key, secret_key=secret_key)

def get_bucket_name_and_object_name(path):
    from urllib.parse import urlparse
    url = urlparse(path, allow_fragments=False)
    bucket_name = url.netloc
    object_name = url.path.lstrip('/')
    return bucket_name, object_name

class ModelServe(object):
    def __init__(self, model_path=None, n_estimators=100, learning_rate=0.1, early_stopping_rounds=40):
        self.model_path = model_path
        self.n_estimators = n_estimators
        self.learning_rate = learning_rate
        self.early_stopping_rounds = early_stopping_rounds
        print("model_path={}".format(self.model_path))
        print("n_estimators={}".format(self.n_estimators))
        print("learning_rate={}".format(self.learning_rate))
        print("early_stopping_rounds={}".format(self.early_stopping_rounds))

        self.model = None
        
    #         self._workspace = None
    #         self.exec = self.create_execution()

    def train(self, X_train, y_train, X_test, y_test):

        #         self.exec.log_input(metadata.DataSet(
        #             description="xgboost synthetic data",
        #             name="synthetic data",
        #             owner="someone@kubeflow.org",
        #             uri="file://path/to/dataset",
        #             version="v0.0.1"))

        model = train_model(X_train,
                            y_train,
                            X_test,
                            y_test,
                            self.n_estimators,
                            self.learning_rate,
                            self.early_stopping_rounds)

        score = eval_model(model, X_test, y_test)

        #         self.exec.log_output(metadata.Metrics(
        #             name="traing- valuation",
        #             owner="someone@kubeflow.org",
        #             description="training evaluation for xgboost synthetic",
        #             uri="file://path/to/metrics",
        #             metrics_type=metadata.Metrics.VALIDATION,
        #             values={"mean_absolute_error": mae}))

        if self.model_path:
            save_model(model, self.model_path)

    #         self.exec.log_output(metadata.Model(
    #             name="model",
    #             description="prediction model using synthetic data",
    #             owner="someone@kubeflow.org",
    #             uri='file://path/to/model',
    #             model_type="linear_regression",
    #             training_framework={
    #                 "name": "xgboost",
    #                 "version": "0.90"
    #             },
    #             hyperparameters={
    #                 "learning_rate": self.learning_rate,
    #                 "n_estimators": self.n_estimators
    #             },
    #             version=datetime.utcnow().isoformat("T")))

    def predict(self, X, feature_names):
        if not self.model:
            self.model = load_model(self.model_path)
        # Do any preprocessing
        prediction = self.model.predict(data=X)
        # Do any postprocessing
        return prediction

#     @property
#     def workspace(self):
#         if not self._workspace:
#             self._workspace = create_workspace()
#         return self._workspace

#     def create_execution(self):
#         r = metadata.Run(
#             workspace=self.workspace,
#             name="xgboost-synthetic-run" + datetime.utcnow().isoformat("T"),
#             description="a notebook run")

#         return metadata.Execution(
#             name = "execution" + datetime.utcnow().isoformat("T"),
#             workspace=self.workspace,
#             run=r,
#             description="execution for training xgboost-synthetic")

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--input_path', default='./input', type=str)
    parser.add_argument('--hyperparameters', required=False, type=str)
    parser.add_argument('--n_estimators', default='100', type=int)
    parser.add_argument('--learning_rate', default='0.1', type=float)
    parser.add_argument('--model_path', required=False, type=str)
    parser.add_argument('--mode', default='train', choices=['train', 'predict'])
    parser.add_argument('--submission_path', default='./', type=str)
    args = parser.parse_args()

    if args.hyperparameters:
        hp_json = json.loads(args.hyperparameters)
        print("use json hyperparameters", hp_json)
        hyperparameters = {}
        for n in hp_json:
            hyperparameters[n['name']] = n['value']

        n_estimators = int(hyperparameters['--n_estimators'])
        learning_rate = float(hyperparameters['--learning_rate'])
    else:
        n_estimators = args.n_estimators
        learning_rate = args.learning_rate

    if args.mode == 'predict':
        test, id = read_test_input(args.input_path)
        model = ModelServe(model_path=args.model_path)
        pred = model.predict(test, None)
        submission = pd.concat([id, pd.Series(pred, name='SalePrice')], axis=1)
        print(submission)
        if not os.path.exists(args.submission_path):
            os.makedirs(args.submission_path)
        submission.to_csv(os.path.join(args.submission_path, 'submission.csv'), index=False)
    else:
        X_train, y_train, X_test, y_test = read_train_input(args.input_path)

        model = ModelServe(model_path=args.model_path, n_estimators=n_estimators, learning_rate=learning_rate)
        model.train(X_train, y_train, X_test, y_test)

페어링을 이용하여, [train.py](<http://train.py>) 파일이 포함된 컨테이너 이미지를 빌드하고 푸시하겠습니다. 주피터 노트북에서 페어링을 이용하여, 컨테이너 이미지를 푸시하려면, 별도의 설정이 되어 있야 합니다. 만약 설정이 되어 있지 않다면, “05-Kubeflow Fairing – 주피터 노트북에서 Kubeflow Fairing 설정하기“를 참고하셔서 설정하시기 바랍니다.

In []:

import uuid
from kubeflow import fairing
from kubeflow.fairing.kubernetes import utils as k8s_utils
from kubeflow.fairing.preprocessors import base
from kubeflow.fairing.builders.append import append

CONTAINER_REGISTRY = 'kangwoo'

preprocessor = base.BasePreProcessor(executable="train.py")

builder = append.AppendBuilder(registry=CONTAINER_REGISTRY, image_name="house-prices-train",
                           base_image="kangwoo/xgboost:0.82", preprocessor=preprocessor)
builder.build()

train_image = builder.image_tag
print(train_image)

파이프라인 생성하기

파이프라인 작성하기

파이프라인을 작성해 보겠습니다. Kubeflow 에서 제공하는 katib-launcher 컴포넌트를 이용하여, 하이퍼 파리미터 튜닝 작업을 실행합니다. 튜닝 작업이 끝난 후, 가장 좋은 점수의 하이퍼 파라미터값을 넘겨 받습니다. 이 값을 이용하여 모델을 다시 학습한 후, 캐글에 제출할 예측 데이터를 생성합니다.

In []:

import os
import string

import kfp
import kfp.dsl as dsl
from kfp import components
from kfp import onprem
from kfp import aws
from kubernetes.client.models import V1Volume
from kubernetes.client.models import V1SecretVolumeSource
from kubernetes.client.models import V1VolumeMount

@dsl.pipeline(
    name='House Prices Train Pipeline',
    description='House Prices Train Pipeline'
)
def house_prices_train_pipeline(name="house-prices-train", namespace="admin",
            goal=0.95, parallel_trial_count=2, max_trial_count=12, experiment_timeout_minutes=60, delete_after_done=True):

    secret_name = "aws-secret"
    
    competition_name = 'house-prices-advanced-regression-techniques'
    data_version='v0.0.1'
    input_data_path = os.path.join('s3://kfp-bucket/data/competitions', competition_name, 'input', data_version)

    objective_config = {
      "type": "maximize",
      "goal": goal,
      "objectiveMetricName": "r2_score"
    }
    algorithm_config = {'algorithmName' : 'random'}
    parameters = [
      {"name": "--learning_rate", "parameterType": "double", "feasibleSpace": {"min": "0.01","max": "0.2"}},
      {"name": "--n_estimators", "parameterType": "int", "feasibleSpace": {"min": "10", "max": "200"}}
    ]
    metrics_collector = {
        "collector": {
            "kind": "StdOut"
        }
    }

    trial_template_params = {'train_image':train_image,
    'secret_name': secret_name,
    'input_data_path': input_data_path}     

    trial_template = string.Template('''
    goTemplate:
        rawTemplate: |-
          apiVersion: batch/v1
          kind: Job
          metadata:
            name: {{.Trial}}
            namespace: {{.NameSpace}}
          spec:
            template:
              spec:
                containers:
                - name: {{.Trial}}
                  image: $train_image
                  command:
                  - "python"
                  - "/app/train.py"
                  - "--input_path"
                  - $input_data_path
                  {{- with .HyperParameters}}
                  {{- range .}}
                  - "{{.Name}}={{.Value}}"
                  {{- end}}
                  {{- end}}
                  env:
                  - name: AWS_ACCESS_KEY_ID
                    valueFrom:
                      secretKeyRef:
                        name: $secret_name
                        key: AWS_ACCESS_KEY_ID
                  - name: AWS_SECRET_ACCESS_KEY
                    valueFrom:
                      secretKeyRef:
                        name: $secret_name
                        key: AWS_SECRET_ACCESS_KEY
                restartPolicy: Never
    ''').safe_substitute(trial_template_params)

    katib_experiment_launcher_op = components.load_component_from_url('<https://raw.githubusercontent.com/kubeflow/pipelines/master/components/kubeflow/katib-launcher/component.yaml>')
    hp_task = katib_experiment_launcher_op(
              experiment_name=name,
              experiment_namespace=namespace,
              parallel_trial_count=parallel_trial_count,
              max_trial_count=max_trial_count,
              objective=str(objective_config),
              algorithm=str(algorithm_config),
              trial_template=str(trial_template),
              parameters=str(parameters),
              metrics_collector=str(metrics_collector),
              experiment_timeout_minutes=experiment_timeout_minutes,
              delete_finished_experiment=delete_after_done)
    
    
    hp_out_task = dsl.ContainerOp(
        name="hp out",
        image="library/bash:4.4.23",
        command=["sh", "-c"],
        arguments=["echo hyperparameter: %s" % hp_task.output],
    )

    model_version = 'v0.0.1'
    model_path = os.path.join('s3://kfp-bucket/data/competitions', competition_name, 'models', model_version)
    
    train_task = dsl.ContainerOp(
        name='train',
        image=train_image,
        command=['python', '/app/train.py'],
        arguments=['--input_path', input_data_path, '--hyperparameters',  hp_task.output, '--model_path', model_path]
    ).apply(aws.use_aws_secret(secret_name,
            aws_access_key_id_name='AWS_ACCESS_KEY_ID',
            aws_secret_access_key_name='AWS_SECRET_ACCESS_KEY'))
    
    
    submission_path = os.path.join('/data/competitions', competition_name, 'submissions', model_version)

    volume_task = dsl.VolumeOp(
        name="house-prices-volume",
        resource_name="house-prices-pvc",
        modes=dsl.VOLUME_MODE_RWO,
        size="100Mi"
    )
    
    predict_task = dsl.ContainerOp(
        name='predict',
        image=train_image,
        command=['python', '/app/train.py'],
        arguments=['--input_path', input_data_path, '--mode',  'predict', '--model_path', model_path,
                  '--submission_path', submission_path],
        pvolumes={"/data": volume_task.volume}
    ).apply(aws.use_aws_secret(secret_name,
            aws_access_key_id_name='AWS_ACCESS_KEY_ID',
            aws_secret_access_key_name='AWS_SECRET_ACCESS_KEY')).after(train_task)
    
    submit_op = components.load_component('../components/kaggle/competitions_submit/component.yaml')
    submit_task = submit_op(competition=competition_name, path=submission_path, message='RunId {{workflow.uid}}')\\
            .add_pvolumes({"/data": predict_task.pvolume})\\
            .add_volume(V1Volume(name='kaggle-secret', secret=V1SecretVolumeSource(secret_name='kaggle-secret')))\\
            .add_volume_mount(V1VolumeMount(name='kaggle-secret', mount_path='/root/.kaggle')).after(predict_task)

    
    volume_task.delete().after(submit_task)

if __name__ == '__main__':
    kfp.compiler.Compiler().compile(house_prices_train_pipeline, 'house-prices-train.zip')

    client = kfp.Client()
    my_experiment = client.create_experiment(name='House Prices Experiment')
    my_run = client.run_pipeline(my_experiment.id, 'House Prices Train Pipeline', 'house-prices-train.zip')

생성된 링크를 클릭하시면, 다음과 같은 화면을 확인할 수 있습니다.

Katib 모니터 화면에서 튜닝 결과도 확인할 수 있습니다.

“hp-out” 단계를 클릭하면, 다음과 같은 하이퍼파리미터 튜닝 결과 값을 확인해 볼 수 있습니다.

hyperparameter: [{name: --learning_rate, value: 0.1985601684459975}, {name: --n_estimators, value: 183}]

파이프라인 실행이 완료되면, 예측 결과가 캐글에 제출 됩니다.

캐글의 “My Submissions” 탭을 클릭하면, 제출한 내용들을 확인할 수 있습니다.

쿠버네티스 리소스 강제로 삭제하기

간혹 쿠버네티스의 리소스의 삭제가 불가능해지는 경우가 있습니다. 예를 들어, 커스텀 리소스를 등록하여 사용하다가, 의존성을 무시한채 컴포넌트를 제거해버려서 특정 리소스를 삭제하지 못하는 경우 입니다. 아무런 생각없이 다시 설치할 생각에, 네임스페이스를 제거해버렸다가, 영원히 삭제되지 않는 고통을 경험해 볼 수 있습니다.

이럴 경우 최후의 방법을 사용해야 하는데, 바로 etcd 의 리소스 데이터를 삭제해 버리는 것입니다. 정상적인 방법은 아니니, 꼭 필요한 경우가 아니면 사용하지 않는 것을 추천 드립니다.

다음은 etcdctl을 이용해서, 특정 리소스를 삭제하는 예제입니다.

tekton-pipelines 이라는 네임스페이스에 있는 echo-hello-world-task-run 라는 taskruns 커스텀 리소스를 삭제하는 것입니다.

ADVERTISE_URL="<https://10.203.163.116:2379>"
KEY="/registry/tekton.dev/taskruns/tekton-pipelines/echo-hello-world-task-run"

kubectl -n kube-system exec etcd-node001 -- sh -c \\
"ETCDCTL_API=3 etcdctl \\
--endpoints $ADVERTISE_URL \\
--cacert /etc/kubernetes/pki/etcd/ca.crt \\
--key /etc/kubernetes/pki/etcd/server.key \\
--cert /etc/kubernetes/pki/etcd/server.crt \\
del \\"$KEY\\"

etcd에 대한 자세한 사항은 “쿠버네티스의 etcd 살펴보기“를 참고하시기 바랍니다.

쿠버네티스의 Etcd 살펴보기

etcd는 쿠버네티스 클러스터의 중요한 컴포넌트로서, 클러스터의 상태를 저장하고 있습니다. 클러스터에 필요한 설정 정보와, 포드와 서비스 같은 각 리소스들의 명세와 상태 정보 등을 저장하고 있습니다. 이 글에서는 etcd가 이러한 정보들을 어떻게 저장하는지에 대해서 간단히 알아볼 것입니다.

etcd

etcd 는 분산 시스템에서 사용할 수 있는 분산형 키-값 (key-value) 저장소 입니다 CoreOS에서 클러스터를 관리하기 위해서 사용했으며, 요즘은 쿠버네티스의 기본 데이터 저장소로 많이 사용하고 있습니다. etcd는 고가용성을 위하여 클러스터로 설치됩니다. 여러 노드의 통신은 래프트(Raft) 알고리즘에 의해 처리합니다. 연결된 노드들 중 리더를 선정하여 클러스터를 관리합니다. 데이터는 분산되어 저장하기 때문에 시스템 오류에 대한 내성을 가지고 있습니다. 클러스터의 노드는 홀수개로 이루어져야 하며, 최소 3개 이상의 노드가 필요합니다.

http://thesecretlivesofdata.com/raft/ 에서 래프트 알고리즘의 작동 방식을 설명하는 애니메이션을 볼 수 있습니다.

쿠버네티스의 etcd

쿠버네티스는 etcd를 기본 데이터 저장소로 사용합니다. 그래서 쿠버네티스를 설치하기 위해서는 etcd 가 필요합니다. 별도의 etcd 클러스터를 쿠버네티스 외부에 설치한 후 쿠버네티스에서 사용할 수 있습니다. 또는 쿠버네티스를 설치할때 컨트롤플레인 노드에 etcd를 포드로 같이 설치할 수 있습니다.

etcd 클러스터를 별도로 설치한 경우

다음은 그림은 etcd 클러스터를 외부에 설치한 경우를 나타낸 것입니다. 쿠버네티스 외부에 etcd 클러스터가 존재하고 kube-apiserver에서 해당 etcd 클러스터에 접속하여 데이터를 저장하고 읽어옵니다.

etcd 클러스터를 컨트롤 플레인 노드에 포드를 설치한 경우

다음 그림은 etcd 클러스터를 쿠버네티스 컨트롤 플레인 노드에 같이 설치한 경우를 나타낸 것입니다. 컨트롤 플레인 노드에 스태틱 포드(static pod) 형태로 etcd가 실행됩니다.

etcd 데이터 흐름 살펴보기

다음 명령어를 실행하여 포드를 생성해 보겠습니다.

$ cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Pod
metadata:
  name: nginx
spec:
  containers:
  - name: nginx
    image: nginx:1.19.2
EOF

다음 그림은 포드를 생성했을 때 일어나는 일을 간단히 나타낸 것입니다.

  • 작성한 매니페스트는 kubectl 를 이용하여 kube-apiserver로 전달합니다.
  • kube-apiserver 는 포드를 생성하는 요청을 받은 후, 포드의 매니페스트를 etcd로 저장합니다.
  • kube-schedulerkube-apiserver 를 통해 포드 정보를 감시(watch)하고 있다가, 새로운 포드가 등록 된것을 감지하고, 포드가 실행 가능한 노드로 배치합니다. 포드의 정보에 배치될 노드의 정보를 추가한 후,kube-apiserver 를 통해 정보를 업데이트 합니다. kube-apiserver 는 업데이트 된 정보를 다시 etcd에 저장합니다.
  • kubelet 은 자신의 노드에 배치된 파드의 정보를 감지하고, 컨테이너를 실행시킵니다. 그리고, kube-apiserver 를 통해 상태 정보를 업데이트 합니다. kube-apiserver 는 업데이트 된 정보를 다시 etcd에 저장합니다.

쿠버네티스에서 etcd 정보 조회하기

쿠버네티스에서 사용되고 있는 etcd의 데이터를 조회하는 방법에 대해서 알아보겠습니다.

예제에 사용하는 쿠버네티스는 etcd가 컨트롤 플레인 노드에 스태틱 포드(static pod)로 같이 설치된 클러스터입니다.

쿠버네티스 클러스터가 정상적으로 설치되었다면, kube-system 네임스페이스에서 etcd 포드를 확인할 수 있습니다. 포드 이름은 일반적으로 etcd-노드명 입니다.

$ kubectl -n kube-system get pod
NAME                              READY   STATUS                   RESTARTS   AGE
...
etcd-node001                      1/1     Running                  0          229d
etcd-node002                      1/1     Running                  0          229d
etcd-node003                      1/1     Running                  1          229d
...

미러 포드(mirror pod)로 등록되어 있다면, etcd 포드를 확인할 수 있습니다.

etcdctl 사용하기

etcd 포드들 중 하나에 ps aux 명령어를 실행하여 etcd 서버의 주소를 확인해 보겠습니다.

$ kubectl -n kube-system exec -it etcd-node001 -- ps aux

PID   USER     TIME  COMMAND
    1 root      9d20 etcd --advertise-client-urls=https://10.203.163.116:2379,h
39283 root      0:00 ps aux

--advertise-client-urls 플래그의 값을 사용하여, etcd 클러스터에 명령을 실행해 보겠습니다. etcd 클러스터에 명령을 실행하기 위해서 etcdctl 이라는 유틸리티를 사용하겠습니다.

etcd의 데이터를 파일로 저장하기

etcdctl 실행할 때, v3 API를 사용하기 위해 ETCDCTL_API=3 을 붙입니다. 그리고, 접속 주소랑 인증을 위한 인증서 파일 경로를 플래그로 넘겨줍니다.

다음은 etcd에 저장된 데이터를 json 형식으로 저장하는 예제입니다.

$ ADVERTISE_URL="<https://10.203.163.116:2379>"

$ kubectl -n kube-system exec etcd-node001 -- sh -c \\
"ETCDCTL_API=3 etcdctl \\
--endpoints $ADVERTISE_URL \\
--cacert /etc/kubernetes/pki/etcd/ca.crt \\
--key /etc/kubernetes/pki/etcd/server.key \\
--cert /etc/kubernetes/pki/etcd/server.crt \\
get \\"\\" --prefix=true -w json" > etcd-data.json

저장된 데이터를 조회해 보기

다음은 etcd-data.json 파일의 일부분입니다. 파일을 살펴보면, 키와 값의 목록으로 이루어져 있는것을 알 수 있습니다. 키와 값들은 base64로 인코딩 되어 있기 때문에, 쉽게 알아 볼 수 없습니다.

{
  "header": {
    "cluster_id": 17306099881785348000,
    "member_id": 17264302005967186000,
    "revision": 66544117,
    "raft_term": 2
  },
  "kvs": [
    {
      "key": "L3JlZ2lzdHJ5L2FwaWV4dGVuc2lvbnMuazhzLmlvL2N1c3RvbXJlc291cmNlZGVmaW5pdGlvbnMvYWRhcHRlcnMuY29uZmlnLmlzdGlvLmlv",
      "create_revision": 6490,
      "mod_revision": 30436184,
      "version": 4,
      "value": "eyJraW5kIjoiQ3VzdG9tUmVzb3VyY2VEZWZpbml0aW9uIiwiYXBpVmVyc2lvbiI6ImFwaWV4dGVuc2lvbnMuazhzLmlvL3YxYmV0YTEi...생략..."
    },
    {
      "key": "L3JlZ2lzdHJ5L2FwaWV4dGVuc2lvbnMuazhzLmlvL2N1c3RvbXJlc291cmNlZGVmaW5pdGlvbnMvYXBpa2V5cy5jb25maWcuaXN0aW8uaW8=",
      "create_revision": 11406824,
      "mod_revision": 11406826,
      "version": 3,
      "value": "eyJraW5kIjoiQ3VzdG9tUmVzb3VyY2VEZWZpbml0aW9uIiwiYXBpVmVyc2lvbiI6ImFwaWV4dGVuc2lvbnMuazhzLmlvL3YxYmV0YTEiLCJtZXRhZGF0YSI6eyJuYW1lIjoiYXBpa2V5cy5jb25maWcuaXN0aW8uaW8iLCJ1aWQiOiJhMWFjMGZhMi0yZWM1LTQ1MzMtOGViOC1mZDMwY2JlMjQ0ZDgiLCJn...생략..."
    },
...

다음 명령어를 실행하면, 디코딩된 키값들을 조회해 볼 수 있습니다.

$ for k in $(cat etcd-data.json | jq '.kvs[].key' | cut -d '"' -f2); do echo $k | base64 --decode; echo; done

쿠버네티스의 전체 리소스들을 확인할 수 있습니다.

...
/registry/pods/istio-system/istio-citadel-58c6fb56fb-fs2gp
/registry/pods/istio-system/istio-egressgateway-64787c7b7d-7fblz
/registry/pods/istio-system/istio-galley-67f97d7c8b-wgb2r
/registry/pods/istio-system/istio-grafana-post-install-1.2.10-sl54z
/registry/pods/istio-system/istio-ingressgateway-66cd7b9b8b-hbfsl
...
/registry/services/endpoints/istio-system/istio-citadel
/registry/services/endpoints/istio-system/istio-egressgateway
/registry/services/endpoints/istio-system/istio-galley
/registry/services/endpoints/istio-system/istio-ingressgateway
...

nginx 포드의 리소스

앞서 예제에 있는 포드를 생성한 다음, etcd 데이터를 저장하였다면 다음과 같은 리소스들의 키 정보도 확인할 수 있습니다. 해당 포드의 이벤트 리소스와 포드 리소스 입니다.

/registry/events/default/nginx.1630e320224081de
/registry/events/default/nginx.1630e320535d4dd0
/registry/events/default/nginx.1630e32218d6d691
/registry/events/default/nginx.1630e3221ea631fb
/registry/events/default/nginx.1630e322284c4b56
...
/registry/pods/default/nginx

포드의 이벤트는 kubectl describe pod 포드네임 명령어를 이용하여 확인해 볼 수 있습니다.

$ kubectl describe pod nginx

“Events:”라는 부분에 포드 관련 이벤트가 조회되는 것을 확인할 수 있습니다. 이 이벤트는 시간이 지나면 자동으로 삭제되기 때문에, 안 보일수도 있습니다. (이벤트 지속 시간의 기본 설정 값은 1시간입니다.)

Name:         nginx
Namespace:    default
Priority:     0
...
Events:
  Type    Reason     Age    From                 Message
  ----    ------     ----   ----                 -------
  Normal  Scheduled  2m37s  default-scheduler    Successfully assigned default/nginx to worker-001
  Normal  Pulling    2m36s  kubelet, worker-001  Pulling image "nginx:1.19.2"
  Normal  Pulled     2m28s  kubelet, worker-001  Successfully pulled image "nginx:1.19.2"
  Normal  Created    2m28s  kubelet, worker-001  Created container nginx
  Normal  Started    2m28s  kubelet, worker-001  Started container nginx

특정 키로 조회해보기

특정 키의 값을 바로 조회해 볼 수도 있습니다. etcdctl 의 get 플래그에 키를 지정하면 됩니다. default 네임스페이스에 있는 nginx 라는 포드의 정보를 조회해 보겠습니다.

KEY="/registry/pods/default/nginx"

kubectl -n kube-system exec etcd-node001 -- sh -c \\
"ETCDCTL_API=3 etcdctl \\
--endpoints $ADVERTISE_URL \\
--cacert /etc/kubernetes/pki/etcd/ca.crt \\
--key /etc/kubernetes/pki/etcd/server.key \\
--cert /etc/kubernetes/pki/etcd/server.crt \\
get \\"$KEY\\" -w json" | jq '.kvs[].value' | cut -d '"' -f2 | base64 --decode

다음은 조회된 결과 입니다. 포드의 정보를 가지고 있는것을 확인할 수 있습니다. 문자열 데이터가 아닌 부분은 깨져 보이지만, 대충 어떤 의미를 가지는지는 확인할 수 있습니다.

k8s

v1Pod�
�
nginxdefault"*$1ae7d990-d09e-443b-a419-0d8bbc0ece232���b�
0kubectl.kubernetes.io/last-applied-configuration�{"apiVersion":"v1","kind":"Pod","metadata":{"annotations":{},"name":"nginx","namespace":"default"},"spec":{"containers":[{"image":"nginx:1.19.2","name":"nginx"}]}}
z�
1
default-token-pz9rt2
default-token-pz9rt��
nginx
     nginx:1.19.2*BJJ
default-token-pz9rt-/var/run/secrets/kubernetes.io/serviceaccount"2j/dev/termination-logr
                                                                                         IfNotPresent����FileAlways 2
                                                                                                                     ClusterFirstBdefaultJdefaultRworker-001X`hr���default-scheduler�6
node.kubernetes.io/not-readyExists"	NoExecute(��8
node.kubernetes.io/unreachableExists"	NoExecute(�����
Running#

InitializedTru���*2
ReadyTru���*2'
ContainersReadyTru���*2$

PodScheduledTru���*2"*
                      10.233.166.02
                                   172.32.8.8���B�
nginx

��� (2
      nginx:1.19.2:_docker-pullable://nginx@sha256:b0ad43f7ee5edbc0effbc14645ae7055e21bc1973aee5150745632a24a752661BIdocker://9e8f506939d41129f61720813ee9cda07569e6628cf385fa71b692425d4be40cJ
BestEffortZ"

이상으로 etcd에 대해서 간단히 살펴보았습니다.

캐글 – 타이타닉 생존 예측 파이프라인 만들기

머신 러닝 파이프라인을 만들기 위하여, 타이타닉 데이터를 사용해 보도록 하겠습니다.

타이타닉 데이터는 캐글(Kaggle)에서 입문자용으로 가장 많이 사용하는 예제입니다. 캐글은 데이터 사이언스나 머신 러닝을 공부하는 사람들이 많이 사용하는 데이터 분석 경연 플랫폼입니다.

타이타닉 데이터는 다양한 사람들이 다양한 관점에서 다양한 방법으로 데이터를 분석하고 있기 때문에, 이 데이터를 가지고 공부를 하다보면, 데이터 분석의 전반적인 과정을 이해하는데 많은 도움이 될 것입니다.

이 장에서는 타이타낵 생존 예측 결과를 캐글에 제출하기 위한 파이프라인을 구성해 볼 것입니다. 그리고 재사용 컴포넌트를 만들고, 파이프라인에서 재사용 컴포넌트를 사용할 것입니다. 데이터 분석 보다는 전체적인 파이프라인을 만드는 것에 중점을 두고 설명하겠습니다.

사전 준비

캐글 접속하기

캐글 사이트의 주소는 https://www.kaggle.com/ 입니다. 원활한 사용을 위하여, 회원 가입이 필요합니다. 회원 가입을 하시고, 로그인하시기 바랍니다.

Titanic: Machine Learning from Disaster 접속

예제에서 사용할 데이터가 있는 타이나닉 예측 Competition 의 주소는 다음과 같습니다.

[<https://www.kaggle.com/c/titanic>](<https://www.kaggle.com/c/titanic>)

해당 주소로 직접 접속하셔도 되고, 상단에 있는 검색바를 이용하여 검색하셔도 됩니다.

다음은 검색바를 이용하여, “Titanic: Machine Learning from Disaster” 을 검색한 결과입니다.

“Titanic: Machine Learning from Disaster” Competition 페이지 접속하면 다음과 같은 화면을 볼 수 있습니다.

데이터는 “Data” 탭에서 받을 수 있습니다. “Data” 탭을 클릭하면, 데이터에 대한 자세한 설명과 다운로드 받는 방법을 볼 수 있습니다.

주피터 노트북

주피터에서 새로운 Terminal 을 엽니다.

kaggle 을 이용하여 데이터를 받기 위해서, kaggle 패키지를 설치합니다.

pip install kaggle --user

정상적으로 설치되면, 다음과 같은 응답 결과를 확인할 수 있습니다.

Collecting kaggle
  Downloading <https://files.pythonhosted.org/packages/62/ab/bb20f9b9e24f9a6250f95a432f8d9a7d745f8d24039d7a5a6eaadb7783ba/kaggle-1.5.6.tar.gz> (58kB)
....
Successfully built kaggle python-slugify
Installing collected packages: urllib3, tqdm, text-unidecode, python-slugify, kaggle
  WARNING: The script tqdm is installed in '/home/jovyan/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
  WARNING: The script slugify is installed in '/home/jovyan/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
  WARNING: The script kaggle is installed in '/home/jovyan/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed kaggle-1.5.6 python-slugify-4.0.0 text-unidecode-1.3 tqdm-4.45.0 urllib3-1.24.3

kaggle 명령어를 실행하기 위해서 PATH 에 추가해 줍니다. kaggleuser 디렉토리에 설치하였기 때문에, PATH 에 안잡혀 있을 수 있습니다. 사용하는 주피터 노트북 이미지에 따라서 다르기 때문에, 이미 PATH 에 추가되어 있다면, 다음 단계로 넘어가셔도 됩니다.

export PATH=${PATH}:/home/jovyan/.local/bin

캐글 API 토큰 생성하기

주피터 터미널에서 kaggle 명령어를 이용하여, 데이터를 받으려면, API 토큰이 필요합니다. 캐글 사이트의 우측 상단에 있는 “My Profile”을 클릭합니다.

My Account

“My Profile” 페이지 접속하면, 토큰을 생성할 수 있습니다.

“Create New API Token”을 클릭하여 토큰을 생성합니다. 토큰이 생성되면 “kaggle.json” 파일로 자동 다운로드 됩니다.

주피터 노트북에 캐글 API 토큰 추가하기

해당 파일을 주피터 노트북의 ~/.kaggle/kaggle.json 로 복사해 줍니다.

mkdir ~/.kaggle
cd ~/.kaggle
cat << EOF > kaggle.json
{"username":"USERNAME","key":"12345678901234567890"}
EOF

주피터 노트북에서 타이타닉 데이터 다운로드하기

작업 디렉토리를 생성한 다음, 타이타닉 데이터를 다운로드 합니다. [titanic.zip](<http://titanic.zip>) 라는 파일이 다운로드 됩니다.

mkdir -p ~/workspace/titanic/kaggle
cd ~/workspace/titanic/kaggle
kaggle competitions download -c titanic
Downloading titanic.zip to /home/jovyan/workspace/titanic/kaggle
  0%|                                                                                          | 0.00/34.1k [00:00<?, ?B/s]
100%|██████████████████████████████████████████████████████████████████████████████████| 34.1k/34.1k [00:00<00:00, 842kB/s]

다운로드한 파일의 압축을 풀겠습니다. 모델 학습을 위한 train.csv 파일과, 예측에 사용할 데이터인 test.csv 그리고, 캐글에 제출할 파일의 형식을 보여주는 gender_submission.csv 파일이 생성됩니다.

unzip titanic.zip
Archive:  titanic.zip
  inflating: gender_submission.csv
  inflating: test.csv
  inflating: train.csv

파이썬 패키지 설치

머신 러닝 모델 코드를 작성하기 위한 패키지들을 설치합니다.

pip install pandas seaborn sklearn --user

Kubeflow 파이프라인을 작성하기 위한 패키지를 설치합니다.

pip install kfp --user

데이터 전처리와 모델 작성

문제 정의하기

주어진 데이터를 바탕으로, 타이타닉호에 탑승했던 승객이 타이타닉 침몰에서 살아 남았는지를 예측하는 문제입니다.

데이터 수집(Data Ingestion)

Data Ingestion은 사용하거나 저장하기 위해서 데이터를 입수하고 가져오는 과정입니다. 간단히 얘기해서 머신 러닝에 사용할 데이터를 가져온다고 할 수 있습니다. 예제에서는 캐글에서 제공하는 데이터를 다운로드 받아 사용합니다.

데이터 분석 및 검증 (Data Analysis and Validation)

데이터 분석이란 데이터의 분포를 이해한다는 것을 의미합니다. 데이터에 대한 통계 정보들, 예를 들어, 각 컬럼들이 어떤한 값들을 얼마 만큼 가지고 있는지, 어떤 컬럼이 포함하거나 포함하지 않는 값들 얼마만큼 가지고 있는지 같은 정보를 파악하는것을 의미합니다. 이런 분석 작업을 통하여 데이터를 검증하게 됩니다.

데이터 검증은 데이터의 품질을 높이기 위하여, 데이터의 오류를 파악하여 수정하는 것을 의미합니다. 데이터 분석에서 얻은 정보들을 기반으로 데이터 검증이 이루어 집니다.

데이터 분석과 검증을 통하여 유효하지 않거나, 유실된 데이터를 처리해야만 데이터의 품질이 좋아질 수 있습니다.

데이터의 품질을 높이기 위해서는 다음과 같은 여러 가지 기능을 사용합니다.

  • 기본 사항(선택, 필터, 중복 제거 등)
  • 샘플링(균형, 계층화 등)
  • 데이터 파티셔닝(학습 세트 + 검증 세트 + 테스트 세트)
  • 변환(일반화, 표준화, 스케일링, 피벗, 등)
  • Binning (결측값 처리 등)

타이타닉 데이터 분석 및 검증

먼저 타이타닉 데이터에 대해 이해하기 위하여, 캐글에서 제공하고 있는 Data DictionaryVariable Notes를 살펴 보겠습니다. Data 탭의 Data Description 부분을 펼치면 다음과 같은 내용을 확인할 수 있습니다.

Data Dictionary

변수 노트

각 변수에 대해서 좀 더 자세한 내용이 적혀 있습니다.

  • pclass :사회 경제적 지위 (SES)
    • 1st = Upper
    • 2nd = Middle
    • 3rd = Lower
  • age : 나이가 1보다 작은 경우는 분수입니다. 추정된 나이일 경우에는 xx.5 형식입니다.
  • sibsp : 데이터 세트는 다음과 같은 방식으로 가족 관계를 정의합니다.
    • 형제 자매 = 형제, 자매, 의붓 형제, 이복 누이
    • 배우자 = 남편, 아내 (정부와 약혼자는 무시 합니다.)
  • parch : 데이터 세트는 다음과 같은 방식으로 가족 관계를 정의합니다.
    • 부모 = 어머니, 아버지
    • 아이 = 딸, 아들, 의붓 딸, 의붓 아들
    • 보모와 같이 여행한 어린이는 parch=0 으로 처리합니다.

이제 각 변수들에 대한 의미를 알게되었으니, 주어진 데이터에 대해 간략하게 살펴보겠습니다.

캐글에서 제공하는 타이타닉 데이터 세트는 분석 모델을 만드는데에는 아직 적합하지 않습니다. 결측 값들이 존재하고, 학습에 사용하기 어려운 문자열 값들이 존재하고 있습니다. 이러한 값들을 잘 처리하여야만, 머신 러닝 알고리즘을 적용할 때 최상의 결과를 얻을 수 있습니다.

주피터 노트북을 생성합니다. 노트북의 위치는 ~/workspace/titanic 입니다. 앞으로 작성할 예제에서는 노트북이 ~/workspace/titanic 에 위치하고 있다고 가정하여, 파일 경로를 설정할 것입니다.

주피터 노트북을 이용하여 데이터를 분석 및 검증해 보겠습니다.

판다스를 이용해서 데이터를 읽어 오겠습니다.

In []:

import pandas as pd
train = pd.read_csv('~/workspace/titanic/kaggle/train.csv')
test = pd.read_csv('~/workspace/titanic/kaggle/test.csv')

head() 메소드를 이용하여 학습용 데이터를 조회해 봅니다.

In []:

train.head()

Cabin 에 Nan(Not a Number) 가 존재하는 것을 알 수가 있습니다.

테스트 데이터도 조회해 봅니다.

In[]:

test.head()

테스트 데이터에는 Survived 컬럼이 없다는 것을 알 수 있습니다. 파일명이 test 이지만 테스트에는 사용할 수 없습니다. 이 데이터는 캐글에 예측 결과값을 제출할때 사용하는 입력 데이터 입니다.

그리고 info()메소드를 이용하에 데이터의 정보를 조회해 봅니다.

In[]:

train.info()

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

<class 'pandas.core.frame.DataFrame'>
RangeIndex: 891 entries, 0 to 890
Data columns (total 12 columns):
 #   Column       Non-Null Count  Dtype  
---  ------       --------------  -----  
 0   PassengerId  891 non-null    int64  
 1   Survived     891 non-null    int64  
 2   Pclass       891 non-null    int64  
 3   Name         891 non-null    object 
 4   Sex          891 non-null    object 
 5   Age          714 non-null    float64
 6   SibSp        891 non-null    int64  
 7   Parch        891 non-null    int64  
 8   Ticket       891 non-null    object 
 9   Fare         891 non-null    float64
 10  Cabin        204 non-null    object 
 11  Embarked     889 non-null    object 
dtypes: float64(2), int64(5), object(5)
memory usage: 83.7+ KB

Non-Null 의 값들이 다른 것을 알 수 있습니다. 즉 Null 인 값들이 존재한다는 것입니다.

Null 값들의 개수를 조회해 보겠습니다.

train.isnull().sum()

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

PassengerId      0
Survived         0
Pclass           0
Name             0
Sex              0
Age            177
SibSp            0
Parch            0
Ticket           0
Fare             0
Cabin          687
Embarked         2
dtype: int64

AgeCabin 그리고 Embarked 에 결측값이 존재하는 것을 알 수 있습니다.

데이터에 대한 간단한 통계 정보를 보고 싶으면 describe() 메소드를 사용할 수 도 있습니다.

train.describe(include='all')

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

조회해 본 결과를 통해서 알 수 있듯이, Age, Cabin, Embarked 는 결측값이 존재하는 것을 확인할 수 있습니다. 그리고 여러 유형의 문자열 데이터가 존재하는 것도 확인할 수 있습니다.

데이터는 크게 숫자형 데이터(Numerical Type)와 범주형 데이터(Categorical Type)로 나눌 수 있습니다. 숫자형 데이터는 연속성을 가지는 숫자로 이루어진 데이터를 의미합니다. 예제에서는 AgeFare 같은 것이 여기에 속합니다. 범주형 데이터는 연속적이지 않는 값을 갖는 데이터를 의미합니다. 대부분의 경우 문자형 데이터가 여기에 속합니다. 하지만, 어떤 경우에는 숫자형 데이터도 개념적으로 범주형으로 처리해야 할 경우도 있습니다. 예제에서는 Sex, Embarked, Pclass 를 범주형 데이터라고 볼 수 있습니다. Pclass 의 경우 숫자형 데이터로 보이지만, 개념적으로 범주형으로 처리하겠습니다.

데이터 변환 (Data Transformation )

머신 러닝 모델을 학습할 때 사용할 수 있도록 데이터를 변환하고, 결측값들을 처리하도록 하겠습니다

범주형 데이터 변환

One-Hot Encoding 을 사용하겠습니다. 판다스에서는 get_dummies() 메소드를 이용하면 One-Hot Encoding 을 손쉽게 할 수 있습니다.

One-Hot Encoding 은 문자를 숫자로 바꾸어 주는 방법 중의 하나로서, 가변수(dummy variable)을 0과 1로 이루어진 가변수를 만들어 주는 것입니다. 1은 있다는 것을, 0은 없다는것을 나타냅니다.

예를 들어 과일이라는 컬럼이 있습니다. 해당 컬럼은 사과, 바나나, 체리라는 세가지 종류의 값을 가지고 있습니다. 이 값을 One-Hot Encoding 할 경우 사과라는 값은 “1,0,0” 같은 형태로 변환시킬수 있습니다.

그림 출처 : (?)

판다스의 get_dummies() 메소드를 이용하여 Sex, Embarked, Pclass 를 One-Hot Encoding 하겠습니다.

train = pd.get_dummies(train, columns=['Sex', 'Embarked', 'Pclass'])
test = pd.get_dummies(test, columns=['Sex', 'Embarked', 'Pclass'])

Sex, Embarked, Pclass 컬럼들이 아래처럼 변환것을 확인할 수 있습니다.

결측 데이터 처리

결측값들을 처리하는 방법은 크게 두 가지가 있습니다. 결측값이 포함된 데이터를 삭제하거나, 다른값으로 치환하는 것입니다. 판다스에서 결측값이 포함된 데이터를 삭제하고 싶으면 dropna() 메소드를 사용하면 됩니다. 만약 다른값으로 치환하고 싶다면 fillna() 메소드를 사용하면 됩니다.

Age 의 결측값을 처리해 보겠습니다. 간단하게 생존자와 사망자의 나이 평균값을 구한다음, 그 값으로 치환하겠습니다.

survived_1_age_mean = train[(train['Survived'] == 1)]['Age'].mean()
survived_0_age_mean = train[(train['Survived'] == 0)]['Age'].mean()

Age 의 결측값을 생존자와 사망자의 나이 평균값을로 치환합니다.

train.loc[train['Survived'] == 1, 'Age'] = train[train['Survived'] == 1].fillna(survived_1_age_mean)
train.loc[train['Survived'] == 0, 'Age'] = train[train['Survived'] == 0].fillna(survived_1_age_mean)
test['Age'].fillna(test['Age'].mean(), inplace=True)

다시 한번 데이터의 정보를 조회해 보겠습니다.

train.info()
<class 'pandas.core.frame.DataFrame'>
RangeIndex: 891 entries, 0 to 890
Data columns (total 17 columns):
 #   Column       Non-Null Count  Dtype  
---  ------       --------------  -----  
 0   PassengerId  891 non-null    int64  
 1   Survived     891 non-null    int64  
 2   Name         891 non-null    object 
 3   Age          891 non-null    float64
 4   SibSp        891 non-null    int64  
 5   Parch        891 non-null    int64  
 6   Ticket       891 non-null    object 
 7   Fare         891 non-null    float64
 8   Cabin        204 non-null    object 
 9   Sex_female   891 non-null    uint8  
 10  Sex_male     891 non-null    uint8  
 11  Embarked_C   891 non-null    uint8  
 12  Embarked_Q   891 non-null    uint8  
 13  Embarked_S   891 non-null    uint8  
 14  Pclass_1     891 non-null    uint8  
 15  Pclass_2     891 non-null    uint8  
 16  Pclass_3     891 non-null    uint8  
dtypes: float64(2), int64(4), object(3), uint8(8)
memory usage: 69.7+ KBtrain['Cabin'].unique()

이제 Cabin 을 제외하고는 결측값을 없습니다.

Cabin 에 어떤 값들이 존재하는 확인해 보겠습니다.

In [] :

train['Cabin'].unique()

Out[] :

array([nan, 'C85', 'C123', 'E46', 'G6', 'C103', 'D56', 'A6',
       'C23 C25 C27', 'B78', 'D33', 'B30', 'C52', 'B28', 'C83', 'F33',
       'F G73', 'E31', 'A5', 'D10 D12', 'D26', 'C110', 'B58 B60', 'E101',
       'F E69', 'D47', 'B86', 'F2', 'C2', 'E33', 'B19', 'A7', 'C49', 'F4',
       'A32', 'B4', 'B80', 'A31', 'D36', 'D15', 'C93', 'C78', 'D35',
       'C87', 'B77', 'E67', 'B94', 'C125', 'C99', 'C118', 'D7', 'A19',
       'B49', 'D', 'C22 C26', 'C106', 'C65', 'E36', 'C54',
       'B57 B59 B63 B66', 'C7', 'E34', 'C32', 'B18', 'C124', 'C91', 'E40',
       'T', 'C128', 'D37', 'B35', 'E50', 'C82', 'B96 B98', 'E10', 'E44',
       'A34', 'C104', 'C111', 'C92', 'E38', 'D21', 'E12', 'E63', 'A14',
       'B37', 'C30', 'D20', 'B79', 'E25', 'D46', 'B73', 'C95', 'B38',
       'B39', 'B22', 'C86', 'C70', 'A16', 'C101', 'C68', 'A10', 'E68',
       'B41', 'A20', 'D19', 'D50', 'D9', 'A23', 'B50', 'A26', 'D48',
       'E58', 'C126', 'B71', 'B51 B53 B55', 'D49', 'B5', 'B20', 'F G63',
       'C62 C64', 'E24', 'C90', 'C45', 'E8', 'B101', 'D45', 'C46', 'D30',
       'E121', 'D11', 'E77', 'F38', 'B3', 'D6', 'B82 B84', 'D17', 'A36',
       'B102', 'B69', 'E49', 'C47', 'D28', 'E17', 'A24', 'C50', 'B42',
       'C148'], dtype=object)

Cabin 즉 객실 번호는 생존 여부에 영향을 미칠 수 있을거 같습니다. 하지만 결측값이 너무 많기 때문에, 예제에서는 값들을 사용하지 않도록 하겠습니다. NameTicket 도 삭제하도록 하겠습니다. 좋은 모델을 만드는게 목적이 아니라, Kubeflow 파이프라인을 만드는것이 목적이므로, 과감히 삭제 하도록 하겠습니다.

Cabin ,Name , Ticket 컬럼을 삭제하겠습니다.

train = train.drop(columns=['Cabin', 'Name', 'Ticket'], axis=1)
test = test.drop(columns=['Cabin', 'Name', 'Ticket'], axis=1)

test 데이터의 정보도 조회해 보겠습니다.

test.info()
<class 'pandas.core.frame.DataFrame'>
RangeIndex: 418 entries, 0 to 417
Data columns (total 13 columns):
 #   Column       Non-Null Count  Dtype  
---  ------       --------------  -----  
 0   PassengerId  418 non-null    int64  
 1   Age          418 non-null    float64
 2   SibSp        418 non-null    int64  
 3   Parch        418 non-null    int64  
 4   Fare         417 non-null    float64
 5   Sex_female   418 non-null    uint8  
 6   Sex_male     418 non-null    uint8  
 7   Embarked_C   418 non-null    uint8  
 8   Embarked_Q   418 non-null    uint8  
 9   Embarked_S   418 non-null    uint8  
 10  Pclass_1     418 non-null    uint8  
 11  Pclass_2     418 non-null    uint8  
 12  Pclass_3     418 non-null    uint8  
dtypes: float64(2), int64(3), uint8(8)
memory usage: 19.7 KB

Fare 에 결측값이 있는 것을 확인할 수 있겠습니다. 평균값으로 치환하겠습니다.

In []

test['Fare'].fillna(test['Fare'].mean(), inplace=True)

각 데이터들간에 어떤 관련성이 있는지를 분석하기 위하여, 피어슨 상관 계수(Pearson correlation coefficient)를 사용하겠습니다.

In []:

corr = train.corr(method='pearson')
print(corr)

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

PassengerId  Survived       Age     SibSp     Parch      Fare  \\
PassengerId     1.000000 -0.005007  0.034016 -0.057527 -0.001652  0.012658   
Survived       -0.005007  1.000000 -0.065915 -0.035322  0.081629  0.257307   
Age             0.034016 -0.065915  1.000000 -0.233212 -0.173876  0.095674   
SibSp          -0.057527 -0.035322 -0.233212  1.000000  0.414838  0.159651   
Parch          -0.001652  0.081629 -0.173876  0.414838  1.000000  0.216225   
Fare            0.012658  0.257307  0.095674  0.159651  0.216225  1.000000   
Sex_female     -0.042939  0.543351 -0.081785  0.114631  0.245489  0.182333   
Sex_male        0.042939 -0.543351  0.081785 -0.114631 -0.245489 -0.182333   
Embarked_C     -0.001205  0.168240  0.030613 -0.059528 -0.011069  0.269335   
Embarked_Q     -0.033606  0.003650 -0.027873 -0.026354 -0.081228 -0.117216   
Embarked_S      0.022148 -0.155660 -0.017186  0.070941  0.063036 -0.166603   
Pclass_1        0.034303  0.285904  0.323163 -0.054582 -0.017633  0.591711   
Pclass_2       -0.000086  0.093349  0.013967 -0.055932 -0.000734 -0.118557   
Pclass_3       -0.029486 -0.322308 -0.289806  0.092548  0.015790 -0.413333   

             Sex_female  Sex_male  Embarked_C  Embarked_Q  Embarked_S  \\
PassengerId   -0.042939  0.042939   -0.001205   -0.033606    0.022148   
Survived       0.543351 -0.543351    0.168240    0.003650   -0.155660   
Age           -0.081785  0.081785    0.030613   -0.027873   -0.017186   
SibSp          0.114631 -0.114631   -0.059528   -0.026354    0.070941   
Parch          0.245489 -0.245489   -0.011069   -0.081228    0.063036   
Fare           0.182333 -0.182333    0.269335   -0.117216   -0.166603   
Sex_female     1.000000 -1.000000    0.082853    0.074115   -0.125722   
Sex_male      -1.000000  1.000000   -0.082853   -0.074115    0.125722   
Embarked_C     0.082853 -0.082853    1.000000   -0.148258   -0.778359   
Embarked_Q     0.074115 -0.074115   -0.148258    1.000000   -0.496624   
Embarked_S    -0.125722  0.125722   -0.778359   -0.496624    1.000000   
Pclass_1       0.098013 -0.098013    0.296423   -0.155342   -0.170379   
Pclass_2       0.064746 -0.064746   -0.125416   -0.127301    0.192061   
Pclass_3      -0.137143  0.137143   -0.153329    0.237449   -0.009511   

             Pclass_1  Pclass_2  Pclass_3  
PassengerId  0.034303 -0.000086 -0.029486  
Survived     0.285904  0.093349 -0.322308  
Age          0.323163  0.013967 -0.289806  
SibSp       -0.054582 -0.055932  0.092548  
Parch       -0.017633 -0.000734  0.015790  
Fare         0.591711 -0.118557 -0.413333  
Sex_female   0.098013  0.064746 -0.137143  
Sex_male    -0.098013 -0.064746  0.137143  
Embarked_C   0.296423 -0.125416 -0.153329  
Embarked_Q  -0.155342 -0.127301  0.237449  
Embarked_S  -0.170379  0.192061 -0.009511  
Pclass_1     1.000000 -0.288585 -0.626738  
Pclass_2    -0.288585  1.000000 -0.565210  
Pclass_3    -0.626738 -0.565210  1.000000

분석 결과를 보기 좋게 그래프로 만들어 보겠습니다.

In []:

import seaborn as sns
sns.set(context='paper', style='whitegrid', palette='muted', font_scale=1, color_codes=True, rc=None)
sns.heatmap(corr,linewidths=.5)

In []:

sns.barplot(x=corr.Survived,y=corr.columns)

모델의 성능은 데이터의 품질에 좌우됩니다. 그래서 위의 상관 그래프나 컬럼별 통계분포 등을 파악하여 보다 많은 데이터의 정제 과정을 거쳐야 합니다. 그리고 피쳐 엔지니어링 과정을 통해서 데이터의 품질을 높여야합니다. 하지만 해당 내용들은 이 책의 범위에서 벗어나기 때문에 다루지 않겠습니다.

모델 학습 (Train)

준비한 데이터를 이용하여 모델을 학습해 보겠습니다.

먼저, 모델 학습을 위하여 데이터를 학습 세트와 테스트 세트로 나누겠습니다. sklearntrain_test_split() 를 사용하면, 간단히 나눌 수 있습니다.

In []:

from sklearn.model_selection import train_test_split

X = train.drop('Survived', axis=1)
y = train['Survived']

X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.25, random_state=30)

sklearnLogisticRegression 을 사용하여, 모델을 학습 시켜 보겠습니다.

In []:

from sklearn.linear_model import LogisticRegression
from sklearn.metrics import classification_report

model = LogisticRegression()

model.fit(X_train, y_train)
prediction = model.predict(X_test)
cr = classification_report(y_test, prediction, output_dict=True)
print('accuracy =', cr['accuracy'])

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

accuracy = 0.7892376681614349

이제 캐글에서 제공한 test 데이터를 가지고 예측해 보도록 하겠습니다.

pred = model.predict(test)

예측한 결과물을 가지고, 캐글에 제공할 submission.csv 파일을 생성해 보겠습니다.

submission = pd.DataFrame({'PassengerId': test['PassengerId'], 'Survived': pred})
submission.to_csv('submission.csv', index=False)

submission 을 조회해 보겠습니다.

submission.head()

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

생성한 submission.csv 파일을 캐글에 제출하겠습니다. kaggle 명령어를 사용하여 제출합니다. kaggle 명령어가 PATH 에 포함되어 있지 않기 때문에 전체 경로를 적어 주었습니다.

!/home/jovyan/.local/bin/kaggle competitions submit -c titanic -f submission.csv -m "Message"

캐글의 “My Submissions” 탭을 클릭하면, 제출한 내용들을 확인할 수 있습니다.

파이프라인 만들기

앞서 작성한 코드들을 바탕으로 하여 파이프라인을 구성해 보겠습니다. 각각의 단계를 컴포넌트로 구성한 다음, 파이프라인을 작성하고 실행해 보겠습니다.

파이프라인의 단계는 다음과 같습니다.

  • 데이터 다운로드 : 캐글에서 데이터를 다운로드 합니다.
  • 데이터 압축풀기 : 캐글에서 다운로드한 데이터의 압축을 풉니다.
  • 데이터 변환 : train.csvtest.csv 의 데이터를 머신러닝의 학습에 사용할 수 있도록 변환합니다.
  • 모델 학습 : 변환된 train.csv 데이터를 이용하여 모델을 학습니다.
  • 예측 : 변환된 test.csv 데이터를 이용하여 예측합니다. 그리고 예측한 결과를 submission.csv 파일로 저장합니다.
  • 캐글 제출 : 생성된 submission.csv 파일을 캐글에 제출합니다.

파이프라인의 전체적인 흐름은 다음과 같습니다.

기본 이미지 만들기

데이터 변환, 모덱 학습, 예측 컴포넌트에서 사용할 기본 이미지를 만들어 보겠습니다. 파이프라인에서도 필요한 이미지를 빌드할 수 있지만, 기본 이미지를 만들어서 사용하는게 더 효율적입니다. docker 명령어를 이용하여, 컨테이너 이미지를 빌드하기 때문에, docker 명령어가 실행 가능한 곳에서 작업을 해야합니다.

먼저 베이스 이미지 디렉토리를 만듭니다.

mkdir -p ~/workspace/base/sklearn
cd ~/workspace/base/sklearn

필요한 파이썬 패키지 목록을 requirements.txt 파일로 작성합니다.

requirements.txt

scikit-learn
joblib
numpy
pandas
fire

컨테이너 이미지 빌드를 위하여 Dockerfile 파일을 작성합니다. 파이썬 패키지 목록인 requirements.txt 파일을 추가하고, 해당 파일을 이용하여 패키지를 설치합니다.

Dockerfile

FROM python:3.6-slim

WORKDIR /app
COPY requirements.txt /app

RUN pip --no-cache-dir install -r requirements.txt

컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하기 위하여 build_image.sh 파일을 작성합니다.

build_image.sh

#!/bin/bash -e

image_name=kangwoo/sklearn
image_tag=0.0.1
full_image_name=${image_name}:${image_tag}
base_image_tag=3.6-slim

cd "$(dirname "$0")"

docker build --build-arg BASE_IMAGE_TAG=$base_image_tag -t "$full_image_name" .
docker push "$full_image_name"

build_image.sh 파일을 실행하여, 컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하겠습니다.

chmod +x build_image.sh
./build_image.sh

컴포넌트 만들기

캐글 데이터 다운로드 컴포넌트

캐글에서 데이터 다운로드하는 컴포넌트를 만들어 보겠습니다. docker 명령어를 이용하여, 컨테이너 이미지를 빌드하기 때문에, docker 명령어가 실행 가능한 곳에서 작업을 해야합니다.

먼저 컴포넌트 디렉토리를 만듭니다.

mkdir -p ~/workspace/components/kaggle/competitions_download
mkdir -p ~/workspace/components/kaggle/competitions_download/src
cd ~/workspace/components/kaggle/competitions_download

컴포넌트 디렉토리의 하위 src 디렉토리에, 컴포넌트에서 사용할 애플리케이션 코드인 [download.py](<http://download.py>) 파일을 작성합니다. kaggle 명령어를 실행하여, 데이터를 다운로드 합니다. 이미 데이터가 저장 경로에 존재하면 다운로드 하지 않습니다. 데이터를 다운로드 했는지 여부를 출력 결과값으로 반환합니다.

src/download.py

from __future__ import absolute_import, division, print_function, unicode_literals

import argparse
import os
import subprocess
from distutils.util import strtobool

parser = argparse.ArgumentParser()
parser.add_argument('--competition', required=True, type=str)
parser.add_argument('--path', default='.', type=str)
parser.add_argument('--force', default='False', type=strtobool)
parser.add_argument('--downloaded', default='/tmp/outputs/downloaded', type=str)
args = parser.parse_args()

if not os.path.exists(args.path):
    os.makedirs(args.path)

kaggle_args = ['kaggle', 'competitions', 'download', '--path', args.path]
if args.force:
    kaggle_args.append('--force')
kaggle_args.append(args.competition)
print(kaggle_args)
result = subprocess.check_output(kaggle_args, encoding='utf-8')
print('result:', result)

downloaded = False
if 'Downloading' in result:
    downloaded = True
print('downloaded:', downloaded)

if not os.path.exists(os.path.dirname(args.downloaded)):
    os.makedirs(os.path.dirname(args.downloaded))

with open(args.downloaded, 'w') as writer:
    writer.write(str(downloaded))

컴포넌트 디렉토리에 컴포넌트 설정 정보가 있는 component.yaml 파일을 작성합니다.

component.yaml

name: Kaggle - Competitions downloader
description: Download competition files
inputs:
  - {name: competition, type: String, description: 'Competition URL suffix'}
  - {name: path, type: String, default: '.', description: 'Folder where file(s) will be download, defaults to current working directory'}
  - {name: force, type: String, default: 'False', description: 'Skip check whether local version of files is up to date, force file download'}
outputs:
  - {name: downloaded, type: String, description: 'Downloaded'}
implementation:
  container:
    image: kangwoo/kaggle-competitions-download@sha256:e0c585eaa50d880a0e0ab2245077c9ec487ffc7c5b8c910c7a88798314d6eab9
    command: ['python', 'download.py']
    args: [
      --competition, {inputValue: competition},
      --path, {inputValue: path},
      --force, {inputValue: force},
      --downloaded, {outputPath: downloaded},
    ]

컨테이너 이미지 빌드를 위하여 Dockerfile 파일을 작성합니다. 파이썬을 기본 이미지로 사용하고 있으며, 앞서 작성한 src/download.py 파일을 추가합니다.

Dockerfile

ARG BASE_IMAGE_TAG=3.6-slim
FROM python:$BASE_IMAGE_TAG

RUN pip install kaggle

WORKDIR /app
ADD src/download.py /app/

ENTRYPOINT ['python', 'download.py']

컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하기 위하여 build_image.sh 파일을 작성합니다.

build_image.sh

#!/bin/bash -e

image_name=kangwoo/kaggle-competitions-download
image_tag=0.0.1
full_image_name=${image_name}:${image_tag}
base_image_tag=3.6-slim

cd "$(dirname "$0")"

docker build --build-arg BASE_IMAGE_TAG=$base_image_tag -t "$full_image_name" .
docker push "$full_image_name"

# Output the strict image name (which contains the sha256 image digest)
# This name can be used by the subsequent steps to refer to the exact image that was built even if another image with the same name was pushed
image_name_with_digest=$(docker inspect --format="{{index .RepoDigests 0}}" "$full_image_name")
strict_image_name_output_file=./versions/image_digests_for_tags/$image_tag
mkdir -p "$(dirname "$strict_image_name_output_file")"
echo $image_name_with_digest | tee "$strict_image_name_output_file"

build_image.sh 파일을 실행하여, 컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하겠습니다.

chmod +x build_image.sh
./build_image.sh

생성한 로컬 개발 환경의 ~/workspace/components/kaggle/competitions_downloader/component.yaml 파일을, 주피터 노트북의 ~/workspace/components/kaggle/competitions_downloader/component.yaml 로 복사합니다.

캐글 제출 컴포넌트

예측 결과를 캐글에 제출하는 컴포넌트를 만들어 보겠습니다. docker 명령어를 이용하여, 컨테이너 이미지를 빌드하기 때문에, docker 명령어가 실행 가능한 곳에서 작업을 해야합니다.

먼저 컴포넌트 디렉토리를 만듭니다.

mkdir -p ~/workspace/components/kaggle/competitions_submit

컴포넌트 디렉토리의 하위 src 디렉토리에, 컴포넌트에서 사용할 애플리케이션 코드인 submit.py 파일을 작성합니다. kaggle 명령어를 실행하여, 예측 결과가 저장된 submission.csv 파일을 캐글에 제출 합니다.

src/submit.py

from __future__ import absolute_import, division, print_function, unicode_literals

import argparse
import os
import subprocess

parser = argparse.ArgumentParser()
parser.add_argument('--competition', required=True, type=str)
parser.add_argument('--path', default='.', type=str)
parser.add_argument('--filename', default='submission.csv', type=str)
parser.add_argument('--message', default='Message', type=str)
parser.add_argument('--submitted', default='/tmp/outputs/submitted', type=str)
args = parser.parse_args()

file = os.path.join(args.path, args.filename)
kaggle_args = ['kaggle', 'competitions', 'submit', '-c', args.competition, '-f', file, '-m', args.message]
print(kaggle_args)
result = subprocess.check_output(kaggle_args, encoding='utf-8')
print('result:', result)

submitted = False
if 'submitted' in result:
    submitted = True
print('submitted:', submitted)

if not os.path.exists(os.path.dirname(args.submitted)):
    os.makedirs(os.path.dirname(args.submitted))

with open(args.submitted, 'w') as writer:
    writer.write(str(submitted))

컴포넌트 디렉토리에 컴포넌트 설정 정보가 있는 component.yaml 파일을 작성합니다.

component.yaml

name: Kaggle - Competitions submitter
description: Submit competition file
inputs:
  - {name: competition, type: String, description: 'Competition URL suffix'}
  - {name: path, type: String, description: 'Path for upload'}
  - {name: filename, type: String, default: 'submission.csv', description: 'Filename for upload'}
  - {name: message, type: String, description: 'Message describing this submission'}
outputs:
  - {name: submitted, type: String, description: 'Submitted'}
implementation:
  container:
    image: kangwoo/kaggle-competitions-submit:0.0.1
    command: ['python', 'submit.py']
    args: [
      --competition, {inputValue: competition},
      --path, {inputValue: path},
      --filename, {inputValue: filename},
      --message, {inputValue: message},
      --submitted, {outputPath: submitted},
    ]

컨테이너 이미지 빌드를 위하여 Dockerfile 파일을 작성합니다. 파이썬을 기본 이미지로 사용하고 있으며, 앞서 작성한 src/submit.py 파일을 추가합니다.

Dockerfile

ARG BASE_IMAGE_TAG=3.6-slim
FROM python:$BASE_IMAGE_TAG

RUN pip install kaggle

WORKDIR /app
ADD src/submit.py /app/

ENTRYPOINT ['python', '/app/submit.py']

컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하기 위하여 build_image.sh 파일을 작성합니다.

build_image.sh

#!/bin/bash -e

image_name=kangwoo/kaggle-competitions-submit
image_tag=0.0.1
full_image_name=${image_name}:${image_tag}
base_image_tag=3.6-slim

cd "$(dirname "$0")"

docker build --build-arg BASE_IMAGE_TAG=$base_image_tag -t "$full_image_name" .
docker push "$full_image_name"

# Output the strict image name (which contains the sha256 image digest)
# This name can be used by the subsequent steps to refer to the exact image that was built even if another image with the same name was pushed
image_name_with_digest=$(docker inspect --format="{{index .RepoDigests 0}}" "$full_image_name")
strict_image_name_output_file=./versions/image_digests_for_tags/$image_tag
mkdir -p "$(dirname "$strict_image_name_output_file")"
echo $image_name_with_digest | tee "$strict_image_name_output_file"

build_image.sh 파일을 실행하여, 컨테이너 이미지를 빌드하고, 컨테이너 레지스트리에 푸시하겠습니다.

chmod +x build_image.sh
./build_image.sh

생성한 로컬 개발 환경의 ~/workspace/components/kaggle/competitions_submit/component.yaml 파일을, 주피터 노트북의 ~/workspace/components/kaggle/competitions_submit/component.yaml 로 복사합니다.

컴포넌트 작성하기

주피터 노트북을 생성합니다. 파일 이름은 titanic_pipeline.ipynb 입니다. 노트북의 위치는 ~/workspace/titanic입니다. 앞으로 작성할 예제에서는 노트북이 ~/workspace/titanic 에 위치하고 있다고 가정하여, 파일 경로를 설정할 것입니다.

패키지 추가

파이프라인과 컴포넌트를 사용하기 위한 패키지를 추가합니다.

In []:

import os
import kfp
from kfp import dsl
from kfp import onprem

from kfp import components
from kfp.components import func_to_container_op, InputPath, OutputPath

from kubernetes.client.models import V1Volume
from kubernetes.client.models import V1SecretVolumeSource
from kubernetes.client.models import V1VolumeMount

캐글 데이터 다운로드 컴포넌트

캐글에서 데이터를 다운로드 하는 컴포넌트를 만들어 보겠습니다. 이 기능은 필요에 따라 다른 곳에서도 사용기 가능할거 같기 때문에, 재사용 컴포넌트로 만들겠습니다.

In []:

download_op = components.load_component_from_file('../components/kaggle/competitions_downloader/component.yaml')

데이터 압축풀기 컴포넌트

unzip 명령어를 사용하여 압축을 풀겠습니다.

In []:

def unzip_op(filename, exdir):
    return dsl.ContainerOp(name='Unzip',
                           image='garthk/unzip:latest',
                           command=['unzip', '-o', filename, '-d', exdir])

데이터 변환 컴포넌트

train.csvtest.csv 의 데이터를 머신러닝의 학습에 사용할 수 있도록 변환합니다. 캐글 데이터의 경로를 input_path 파라미터로 입력 받아 데이터를 변환합니다. 데이터 변환에 쓰이는 코드들은 앞에서 작성한 코드와 동일합니다. 변환할 데이터를 저장할 경로를 output_path 파라미터로 입력 받아 변환된 데이터를 저장합니다. 컨테이너 이미지를 빠르게 빌드하기 위하여, 필요한 패키지가 포함된 기본 이미지를 미리 만들어서 사용하였습니다.

In []:

def transform_op(input_path, output_path):
    import os
    import pandas as pd
    train = pd.read_csv(os.path.join(input_path, 'train.csv'))
    test = pd.read_csv(os.path.join(input_path, 'test.csv'))
    print(train.info())
    print("*"*40)
    print(test.info())
    train = pd.get_dummies(train, columns=['Sex', 'Embarked', 'Pclass'])
    test = pd.get_dummies(test, columns=['Sex', 'Embarked', 'Pclass'])
    survived_1_age_mean = train[(train['Survived'] == 1)]['Age'].mean()
    survived_0_age_mean = train[(train['Survived'] == 0)]['Age'].mean()
    train.loc[train['Survived'] == 1, 'Age'] = train[train['Survived'] == 1].fillna(survived_1_age_mean)
    train.loc[train['Survived'] == 0, 'Age'] = train[train['Survived'] == 0].fillna(survived_0_age_mean)
    test['Age'].fillna(test['Age'].mean(), inplace=True)
    train = train.drop(columns=['Cabin','Name','Ticket'], axis=1)
    test = test.drop(columns=['Cabin','Name','Ticket'], axis=1)
    test['Fare'].fillna(test['Fare'].mean(), inplace=True)
    
    if not os.path.exists(output_path):
        os.makedirs(output_path)
    
    train.to_csv(os.path.join(output_path, 'train.csv'))
    test.to_csv(os.path.join(output_path, 'test.csv'))

transform_op = components.func_to_container_op(transform_op, base_image='kangwoo/sklearn:0.0.1')

모델 학습 컴포넌트

변환된 train.csv 데이터를 이용하여 모델을 학습니다. 변환된 데이터의 경로를 path 파리미터로 입력받에 데이터를 읽어옵니다. 그리고 데이터를 학습 세트와 테스트 세트로 나눈다음, 모델을 학습니다. 사용할 모델 이름은 model_name 파라미터로 입력 받게 하였습니다. 학습된 모델의 분류 결과를 classification_report.json 파일로 저장하고, 학습된 모델을 model.joblib 파일로 저장하였습니다. 각 파일든은 export_path 파라미터로 입력하 경로에 저장됩니다.

In []:

def transform_op(input_path, output_path):
    import os
    import pandas as pd
    train = pd.read_csv(os.path.join(input_path, 'train.csv'))
    test = pd.read_csv(os.path.join(input_path, 'test.csv'))
    print(train.info())
    print("*"*40)
    print(test.info())
    train = pd.get_dummies(train, columns=['Sex', 'Embarked', 'Pclass'])
    test = pd.get_dummies(test, columns=['Sex', 'Embarked', 'Pclass'])
    survived_1_age_mean = train[(train['Survived'] == 1)]['Age'].mean()
    survived_0_age_mean = train[(train['Survived'] == 0)]['Age'].mean()
    train.loc[train['Survived'] == 1, 'Age'] = train[train['Survived'] == 1].fillna(survived_1_age_mean)
    train.loc[train['Survived'] == 0, 'Age'] = train[train['Survived'] == 0].fillna(survived_0_age_mean)
    test['Age'].fillna(test['Age'].mean(), inplace=True)
    train = train.drop(columns=['Cabin','Name','Ticket'], axis=1)
    test = test.drop(columns=['Cabin','Name','Ticket'], axis=1)
    test['Fare'].fillna(test['Fare'].mean(), inplace=True)
    
    if not os.path.exists(output_path):
        os.makedirs(output_path)
    
    train.to_csv(os.path.join(output_path, 'train.csv'))
    test.to_csv(os.path.join(output_path, 'test.csv'))

transform_op = components.func_to_container_op(transform_op, base_image='kangwoo/sklearn:0.0.1')

예측 컴포넌트

변환된 test.csv 데이터를 이용하여 예측합니다. 그리고 예측한 결과를 submission.csv 파일로 저장합니다.

In []:

def predict_op(model_path, test_data_path, submission_path):
    import argparse
    import json
    import os

    import joblib
    import pandas as pd

    reports = {}
    model_names = os.listdir(model_path)
    for model_name in model_names:
        file = os.path.join(model_path, model_name, 'classification_report.json')
        print(file)
        if os.path.isfile(file):
            with open(file) as json_file:
                report = json.load(json_file)
                reports[model_name] = report

    print('{} found'.format(len(reports)))

    for item in reports.items():
        print('item :', item)
        print('{} :  accuracy={}'.format(item[0], item[1]['accuracy']))

    def accuracy(x):
        return reports[x]['accuracy']

    best_model = max(reports.keys(), key=accuracy)
    print('Best model is', best_model, reports[best_model]['accuracy'])

    model = joblib.load(os.path.join(model_path, best_model, 'model.joblib'))
    print(model)

    test = pd.read_csv(os.path.join(test_data_path, 'titanic-test.csv'))
    pred = model.predict(test)

    submission_file = os.path.join(submission_path, 'submission.csv')
    if not os.path.isdir(os.path.dirname(submission_file)):
        os.makedirs(os.path.dirname(submission_file))

    submission = pd.DataFrame({'PassengerId': test['PassengerId'], 'Survived': pred})
    submission.to_csv(submission_file, index=False)
    print("Saved submission :", submission_file)

predict_op= components.func_to_container_op(predict_op, base_image='kangwoo/sklearn:0.0.1')

캐글 제출 컴포넌트

생성된 submission.csv 파일을 캐글에 제출합니다.

In[] :

submit_op = components.load_component_from_file('../components/kaggle/competitions_submit/component.yaml')

파이프라인 생성하기

PVC 생성하기

PVC를 생성하기 위한 매니페스트를 작성합니다. 파이프라인 컴포넌트에서 이 PVC를 이용하여, 데이터를 저장하고 읽어 올 것입니다.

kaggle-pvc.yaml

kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: kaggle-pvc
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 200Mi

다음은 kubeflow 네임스페이스에 PVC 리소스를 생성하는 명령어 입니다.

kubectl -n kubeflow apply -f kaggle-pvc.yaml

캐글 토큰 Secret 생성하기

캐글 API 토큰이 저장되어 있는 kaggle.json 파일을 이용하여, 쿠버네티스 Secret 리소스를 생성합니다. 생성한 Secret 리소스는 파이프라인의 “캐글에서 데이터 다운로드 컴포넌트”와 “캐글 제출 컴포넌트” 에서 사용될 것입니다.

다음은 kubeflow 네임스페이스에 kaggle-secret 이라는 리소스를 생성하는 명령어 입니다.

kubectl -n kubeflow create secret generic kaggle-secret --from-file=kaggle.json

파이프라인 작성하기

주피터 노트북으로 돌아가서 파이프라인을 작성해 보겠습니다.

In []:

@dsl.pipeline(
    name='Titanic pipeline',
    description='Titanic pipeline'
)
def titanic_pipeline():
    pvc_name = "kaggle-pvc"
    volume_name = 'pipeline'
    volume_mount_path = '/data'

    competition_name = 'titanic'
    kaggle_data_path = os.path.join('/data/competitions', competition_name, 'kaggle')
    input_data_path = os.path.join('/data/competitions', competition_name, 'input')

    download_task = download_op(competition=competition_name, path=kaggle_data_path)\\
        .add_volume(V1Volume(name='kaggle-secret', secret=V1SecretVolumeSource(secret_name='kaggle-secret')))\\
        .add_volume_mount(V1VolumeMount(name='kaggle-secret', mount_path='/root/.kaggle'))

    with dsl.Condition(download_task.outputs['downloaded'] == 'True'):
        unzip_task = unzip_op(os.path.join(kaggle_data_path, 'titanic.zip'), kaggle_data_path).after(download_task)
        
    transform_task = transform_op(input_path=kaggle_data_path, output_path=input_data_path).after(unzip_task)

    models = ['sklearn.linear_model.LogisticRegression',
          'sklearn.linear_model.SGDClassifier',
          'sklearn.naive_bayes.GaussianNB',
          'sklearn.neighbors.KNeighborsClassifier',
          'sklearn.tree.DecisionTreeClassifier',
          'sklearn.svm.SVC',
          'sklearn.ensemble.AdaBoostClassifier',
          'sklearn.ensemble.RandomForestClassifier']
    
    export_path = os.path.join('/data/competitions', competition_name, 'models')
    submit_path = os.path.join('/data/competitions', competition_name, 'submit')
    
    with dsl.ParallelFor(models) as model:
        train_task = train_op(input_data_path, model, export_path).after(transform_task)

    predict_task = predict_op(export_path, input_data_path, submit_path).after(train_task)
    
    submit_task = submit_op(competition='titanic', path=submit_path, message='RunId : {{workflow.uid}}')\\
            .add_volume(V1Volume(name='kaggle-secret', secret=V1SecretVolumeSource(secret_name='kaggle-secret')))\\
            .add_volume_mount(V1VolumeMount(name='kaggle-secret', mount_path='/root/.kaggle')).after(predict_task)

    
    steps = [download_task, unzip_task, transform_task, train_task, predict_task, submit_task]
    for step in steps:
        step.apply(onprem.mount_pvc(pvc_name, volume_name=volume_name, volume_mount_path=volume_mount_path))
        

if __name__ == '__main__':
    kfp.compiler.Compiler().compile(titanic_pipeline, 'titanic-pipeline.zip')

    client = kfp.Client()
    my_experiment = client.create_experiment(name='Kaggle Experiment')
    my_run = client.run_pipeline(my_experiment.id, 'Titanic Pipeline', 'titanic-pipeline.zip')

생성된 링크를 클릭하시면, 다음과 같은 화면을 확인할 수 있습니다.

파이프라인 실행이 완료되면, 예측 결과가 캐글에 제출 됩니다.

캐글의 “My Submissions” 탭을 클릭하면, 제출한 내용들을 확인할 수 있습니다.

도커 네트워크

도커 네트워크

도커에서 제공하는 대표적인인 네트워크 드라이버로는 호스트(host), 브리지(bridge), 사용안함(none) 등이 있습니다.

$ docker network ls

NETWORK ID          NAME                DRIVER              SCOPE
d4c7abefb75d        bridge              bridge              local
8c897fb9e7da        host                host                local
9fb15fe19162        none                null                local

도커의 기본 네티워크 모드는 bridge 입니다. 만약 다른 모드를 사용하여 컨테이너를 생성하고 싶다면 --net 을 이용하여 설정할 수 있습니다.

docker run --net=<NETWORK>

도커를 설치하면, 기본적으로 docker0 이라는 가상 브리지(bridge)가 생성 됩니다.

$ ifconfig

...
docker0: flags=4099<UP,BROADCAST,MULTICAST>  mtu 1500
        inet 172.17.0.1  netmask 255.255.0.0  broadcast 172.17.255.255
        ether 02:42:6c:3d:0f:04  txqueuelen 0  (Ethernet)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
$ ip addr

...
3: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default
    link/ether 02:42:6c:3d:0f:04 brd ff:ff:ff:ff:ff:ff
    inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0
       valid_lft forever preferred_lft forever

이 브리지는 컨테이너를 기본 브리지 모드로 실행할 때 사용되면, CIRD 표기법으로 172.17.0.1/16 의 주소 범위를 가지고 있습니다. 172.17.0.1 부터 172.17.255.254 까지의 아이피를 사용할 수 있습니다. 그래서 컨테이너가 기본 브리지 모드로 실행될 때, 해당 범위에서 아이피를 할당받습니다.

만약 이 범위를 변경하고 싶다면, 도커 설정 파일인 /etc/docker/daemon.json"bip" 항목을 추가 하면 됩니다.


Bridge Mode Networking

Docker는 연결된 다른 네트워크 인터페이스 간에 패킷을 자동으로 전달하는 가상 이더넷 브리지인 docker0을 생성합니다. 기본적으로 호스트의 모든 컨테이너는 이 브리지를 이용하여 내부 네트워크에 연결이 됩니다. 이 모드는 컨테이너를 분리된 네트워크 네임스페이스에 배치하고, 네트워크 주소 변환을 사용하여 여러 컨테이너 간에 호스트의 외부 IP 주소를 공유합니다.

브리지 모드 네트워킹은 동일한 호스트에서 여러 컨테이너를 실행할 때 네트워크 포트 충돌을 일으키지 않습니다. 즉, 동일한 포트를 사용하는 다수의 컨테이너를 하나의 호스트에서 실행할 수 있습니다. 각 컨테이너는 호스트와 분리된 전용 네트워크 네임스페이스를 소유하고 있습니다. 그래서 이 모드는 NAT의 사용으로 인해 네트워크 처리량과 지연 시간에 영향을 미치고, 호스트와 컨테이너 간의 네트워크 포트 매핑을 제어해야하는 단점이 있습니다.

컨테이너가 생성되면, 해당 컨테이너를 위해서 페어 인터페이스(pair interfaces)가 생성됩니다. 이 인터페이스들은 두 개가 한 쌍으로 구성되어 있는데, 마치 직접 연결된 것 처럼 서로 패킷을 주고 받습니다.

컨테이너가 생성되면, 페어 인터페이스의 한쪽은 컨테이너 내부 네임스페이스에 eth0 이라는 이름으로 할당됩니다. 나머자 하나는 vethXXXX 라는 이름으로 docker0 브리지에 바인딩 됩니다.

컨테이너를 실행할 때 브리지 네트워킹 모드를 사용하려면 별다른 설정을 추가할 필요 없습니다. 기본값이 브리지 네트워킹 모드이기 때문입니다.

docker run -i -t --rm --name network_bridge ubuntu:18.04

정상적으로 실행되면, 쉘이 나타나고, 명령어를 입력할 수 있습니다. 우분투 이미지에서 네트워크 관련 도구가 설치되어 있지 않기 때문에, 필요한 도구들을 설치해 줍니다.

apt-get update
apt-get install net-tools
apt-get install iproute2
root@6a5f6efd7f52:/# ifconfig

eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.17.0.2  netmask 255.255.0.0  broadcast 172.17.255.255
        ether 02:42:ac:11:00:02  txqueuelen 0  (Ethernet)
        RX packets 3899  bytes 19574414 (19.5 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 3318  bytes 224386 (224.3 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
root@6a5f6efd7f52:/# ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
4: eth0@if5: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default
    link/ether 02:42:ac:11:00:02 brd ff:ff:ff:ff:ff:ff link-netnsid 0
    inet 172.17.0.2/16 brd 172.17.255.255 scope global eth0
       valid_lft forever preferred_lft forever

컨테이너 내부의 eth0 인터페이스의 번호가 4번인것을 확인 할 수 있습니다.

새로운 터미널을 열어서, 호스트에서 인터페이스를 조회해 보겠습니다.

root@magi:~# ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
    link/ether 00:15:5d:15:0e:00 brd ff:ff:ff:ff:ff:ff
    inet 192.168.21.39/24 brd 192.168.21.255 scope global dynamic eth0
       valid_lft 4714sec preferred_lft 4714sec
    inet6 fe80::215:5dff:fe15:e00/64 scope link
       valid_lft forever preferred_lft forever
3: docker0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default
    link/ether 02:42:6c:3d:0f:04 brd ff:ff:ff:ff:ff:ff
    inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0
       valid_lft forever preferred_lft forever
    inet6 fe80::42:6cff:fe3d:f04/64 scope link
       valid_lft forever preferred_lft forever
5: vethab05419@if4: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue master docker0 state UP group default
    link/ether 96:0e:66:36:cd:d0 brd ff:ff:ff:ff:ff:ff link-netnsid 0
    inet6 fe80::940e:66ff:fe36:cdd0/64 scope link
       valid_lft forever preferred_lft forever

vethab05419 라는 새로운 인터페이스 생성된 것을 확인할 수 있습니다. vethab05419 와 컨테이너안의 eth0 인터페이스가 맺어져 있다는 것을 ethtool 을 이용하여 확인할 수 있습니다.

root@magi:~# ethtool -S vethab05419

NIC statistics:
     peer_ifindex: 4

peer_ifindex 가 4로 설정되어 있습니다. 앞서 컨테이너 안에서 확인한 eth0 인터페이스의 번호인 것을 알 수 있습니다.

컨테이너 게이트웨이

컨테이너의 게이트웨이를 확인해 보겠습니다. 컨테이너 안에서 route 명령어를 실행합니다.

root@6a5f6efd7f52:/# route

Kernel IP routing table
Destination     Gateway         Genmask         Flags Metric Ref    Use Iface
default         172.17.0.1      0.0.0.0         UG    0      0        0 eth0
172.17.0.0      0.0.0.0         255.255.0.0     U     0      0        0 eth0

출력된 결과처럼 컨테이너 내부의 모든 패킷은 default 인 172.17.0.1 로 가게 됩니다. 이 주소는 docker0 의 IP 입니다.

브리지 모드에 대한 자세한 정보를 얻고 싶다면, 다음과 같이 확인할 수 있습니다.

docker network inspect bridge

[
    {
        "Name": "bridge",
        "Id": "022cf8e85d00a623504732098d6c99f3a6bf74fbd632787b4d3bf70a1ad03256",
        "Created": "2020-07-28T11:56:57.739214Z",
        "Scope": "local",
        "Driver": "bridge",
        "EnableIPv6": false,
        "IPAM": {
            "Driver": "default",
            "Options": null,
            "Config": [
                {
                    "Subnet": "172.17.0.0/16",
                    "Gateway": "172.17.0.1"
                }
            ]
        },
        "Internal": false,
        "Attachable": false,
        "Ingress": false,
        "ConfigFrom": {
            "Network": ""
        },
        "ConfigOnly": false,
        "Containers": {
            "6a5f6efd7f5235d46d1ae332b003566494bb0e0255bf5edc05899b2e7c71191b": {
                "Name": "network_bridge",
                "EndpointID": "53666d16b8a932aaef1f241535ae2944758ad40cbbddb923d1a1621a286b3e2e",
                "MacAddress": "02:42:ac:11:00:02",
                "IPv4Address": "172.17.0.2/16",
                "IPv6Address": ""
            }
        },
        "Options": {
            "com.docker.network.bridge.default_bridge": "true",
            "com.docker.network.bridge.enable_icc": "true",
            "com.docker.network.bridge.enable_ip_masquerade": "true",
            "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
            "com.docker.network.bridge.name": "docker0",
            "com.docker.network.driver.mtu": "1500"
        },
        "Labels": {}
    }
]

브리지 생성하기

브리지는 다음 명령어로 생성할 수도 있습니다.

docker network create --driver bridge <브리지 이름>

다음은 mybridge 라는 이름의 브리지를 생성하는 예제입니다.

docker network create --driver bridge mybridge 

생성한 브리지는 컨테이너를 실행할 때 --net 설정을 통해 사용할 수 있습니다.

docker run -i -t --name mybridge_container --net mybrdige ubuntu:18.04

Host Mode Networking

호스트 모드는 컨테이너가 호스트의 네트워킹 네임스페이스를 공유하고 있으며, 외부 네트워크에 직접 노출됩니다. 호스트의 IP 주소와 호스트의 TCP 포트 공간을 사용하여, 컨테이너 내부에서 실행 중인 서비스를 노출합니다.

컨테이너를 실행할 때 호스트 네트워킹 모드를 사용하려면 다음과 같이 --net=host 라고 설정하면 됩니다.

$ docker run -i -t --rm --net=host --name network_host ubuntu:18.04

이 네트워킹 모드는 간단하기 때문에, 개발자가 이해하기 쉽고, 사용하기 쉽습니다. 하지만 호스트 네트워크를 그대로 사용하기 때문에 동일한 네트워크 포트를 사용할 경우 충돌이 발생합니다. 동일한 포트를 사용하는 다수의 컨테이너를 하나의 호스트에서 실행할 경우, 포트 충돌이 발생하여 서비스가 시작되지 않을 수 있습니다.

apt-get update
apt-get install net-tools
apt-get install iproute2
root@docker-desktop:/# ifconfig
docker0: flags=4099<UP,BROADCAST,MULTICAST>  mtu 1500
        inet 172.17.0.1  netmask 255.255.0.0  broadcast 172.17.255.255
        inet6 fe80::42:e3ff:fe89:ac76  prefixlen 64  scopeid 0x20<link>
        ether 02:42:e3:89:ac:76  txqueuelen 0  (Ethernet)
        RX packets 6303  bytes 257694 (257.6 KB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 13671  bytes 20016034 (20.0 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 192.168.65.3  netmask 255.255.255.0  broadcast 192.168.65.255
        inet6 fe80::50:ff:fe00:1  prefixlen 64  scopeid 0x20<link>
        ether 02:50:00:00:00:01  txqueuelen 1000  (Ethernet)
        RX packets 146158  bytes 147055882 (147.0 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 77952  bytes 6736462 (6.7 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 2  bytes 140 (140.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 2  bytes 140 (140.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

호스트 모드에 대한 자세한 정보를 얻고 싶다면, 다음과 같이 확인할 수 있습니다.

docker network inspect host

[
    {
        "Name": "host",
        "Id": "8c897fb9e7da39ec5c0cbceaf25935d9fd32cd9cca5eea5a665085eb7a793070",
        "Created": "2019-01-04T16:21:19.013894618Z",
        "Scope": "local",
        "Driver": "host",
        "EnableIPv6": false,
        "IPAM": {
            "Driver": "default",
            "Options": null,
            "Config": []
        },
        "Internal": false,
        "Attachable": false,
        "Ingress": false,
        "ConfigFrom": {
            "Network": ""
        },
        "ConfigOnly": false,
        "Containers": {},
        "Options": {},
        "Labels": {}
    }
]

None Mode Networking

none은 말 그대로, 네트워크를 사용하지 않는 다는것을 의미합니다. none 네트워크로 설정을 하면, 컨테이너에는 lo 인터페이스만 나타납니다. 이 모드로 설정된 컨테이너는 외부와 단절 됩니다.

docker run -i -t --rm --name network_none --net none ubuntu:18.04


Container Mode Networking

컨테이너 네트워크를 사용하면, 다른 컨테이너의 네트워크 환경을 공유할 수 있습니다.

--net container:<다른 컨테이너 이름 또는 아이디>
docker run -i -t --rm --name network_container_1 ubuntu:18.04

root@1fae52d25cbd:/# ifconfig
eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.17.0.2  netmask 255.255.0.0  broadcast 172.17.255.255
        ether 02:42:ac:11:00:02  txqueuelen 0  (Ethernet)
        RX packets 26111  bytes 38303216 (38.3 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 9567  bytes 526098 (526.0 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

다음과 같이 ifconfig 명령을 실행해보면, 동일한 네트워크를 사용하고 있다는 것을 확인할 수 있습니다.

docker run -i -t --rm --name network_container_2 --net container:network_container_1  ubuntu:18.04

root@1fae52d25cbd:/# ifconfig
eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.17.0.2  netmask 255.255.0.0  broadcast 172.17.255.255
        ether 02:42:ac:11:00:02  txqueuelen 0  (Ethernet)
        RX packets 13034  bytes 19150595 (19.1 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 4542  bytes 250008 (250.0 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

도커 구조

도커 구조

도커 초기에는 LXC(LinuX Container)를 기반으로 구현하였습니다. 그리고 0.9 버전부터 LXC를 대신한는 libcontainer를 개발하여 사용하고 있습니다.

다음 그림은 도커 0.9 버전의 구조입니다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/2c21284c-197c-4393-8448-a00d37533ecc/docker-execdriver-diagram.png

출처 : https://www.docker.com/blog/docker-0-9-introducing-execution-drivers-and-libcontainer/

도커 1.11 버전부터 containerdrunC 를 컨테이너 런타임으로 사용합니다. 앞서 사용한 libcontainer 프로젝트는 OCI에 기부되었고, runc 라는 이름으로 바뀌게 됩니다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/5af65736-5226-47ae-9c67-af23bc193744/docker-containerd.png

dockerd

dockerd 는 컨테이너를 지속적으로 관리하는 데몬 프로세스로서, docker CLI 같은 클라이언트가 사용할 수 있는 RESTful API를 제공하고 있습니다. 흔히 명령어로 사용하는 docker 실행 파일이 docker CLI 입니다. 사용자가 입력한 docker 명령어는, 이 dockerd 로 전달되고, 실행됩니다.

dockerd는 unix, tcp, fd의 세 가지 소켓 유형을 통해, 도커 API 요청을 수신할 수 있습니다.

containerd

containerd는 이미지를 push 하고 pull 하고, 스토리지를 관리하고, 네트워크 기능을 정의할 수 있는 독립 실행형 고수준(high-level) 컨테이너 런타임입니다. runc 같은 저수준(low-level)의 컨테이너 런타임에 해당 명령을 전달하여, 컨테이너를 실행하는 등의 라이프사이클을 관리합니다.

도커에 의해 빠르게 확산되고 있던 컨테이너 환경에서, 컨테이너 런타임을 특정 벤더에 의존하지 않고, 중립적인 입장에서 컨테이너 표준에 맞게 구현하는 것을 목적으로 만들어졌습니다.

Docker Inc는 2016 년 12 월 컨테이너 런타임 부분을 독립적인 오픈 소스 프로젝트인 containerd 로 분리하여, 마이크로 소프트, Google, AWS, IBM 등과 공동으로 개발하기로 발표하였습니다.

그리고, 2017년 3월에는 CNCF (Cloud Native Computing Foundation)에 기부되었고, 이후 이를 담당해왔습니다.

도커는 1.11 이후 버전부터 containerd를 컨테이너 런타임으로 사용하고 있습니다.

containerd-shim

containerd-shimrunc를 실행하고, 컨테이너 프로세스를 제어하는 경량 데몬입니다. 컨테이너와 containerd 의 모든 통신은 containerd-shim 을 통해서 이루어 집니다.

containerd-shim 은 보통 다음과 같은 역할을 담당합니다.

  • 컨테이너의 stdout 및 stderr의 스트림을 제공해 주고 있습니다. 그래서 containerd 가 재시작 중에도 문제가 발생하지 않습니다. containerd 는 stdout 및 stderr의 스트림을 받아서 로그 파일로 저장을 할 수 있습니다.
  • runc 는 컨테이너 프로세스를 실행(fork)한 다음, 포그라운드 프로세스를 종료하여, 컨테이너 프로세스를 의도적으로 데몬화 합니다. 이렇게 되면, 컨테이너 프로세스는 호스트의 init 프로세스가 담당하게 되어서, 컨테이너의 관리가 어려워집니다. 이 문제를 해결하기 위해 shim 프로세스를 subreaper로 만들어서, 컨테이너 프로세스를 shim 프로세스가 관리하도록 합니다.

runc

OCI 런타임 스펙을 구현하고 있는 저수준 컨테이너 런타임입니다. 저수준 컨테이너 런타임이라고 부르는 이유는, 오직 실행 중인 컨테이너 관리에만 그 범위를 집중시키고 있기 때문입니다. 리눅스 커널의 네임스페이스와 cgroups 을 사용하여 격리시키는 기능을 제공합니다. 컨테이너를 생성(spawning)과 실행(running) 할 수있는 CLI로 구현되어 있습니다.

runc 는 도커 프로젝트(이전 이름은 libcontainer)에서 나와, OCI에 기부되었고, 이후 이를 담당해 왔습니다.

dockerdcontainerd 확인해 보기

도커가 설치된 호스트에서 프로세스를 조회해 보면, dockerdcontainerd 가 작동중인 것을 확인할 수 있습니다.

다음은 우분투 18.04 버전에 설치한 도커 19.03.12 버전인 경우 조회해 본 결과입니다.

dockerd 를 조회해 보았습니다.

sudo systemctl status docker.service
● docker.service - Docker Application Container Engine
   Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
   Active: active (running) since Sat 2020-07-25 06:31:07 UTC; 3h 11min ago
     Docs: <https://docs.docker.com>
 Main PID: 3375 (dockerd)
    Tasks: 8
   CGroup: /system.slice/docker.service
           └─3375 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock

Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.242010835Z" level=warning msg="Your kernel does not support swap memory lim
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.242240538Z" level=warning msg="Your kernel does not support cgroup rt perio
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.242342040Z" level=warning msg="Your kernel does not support cgroup rt runti
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.242520743Z" level=info msg="Loading containers: start."
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.430146872Z" level=info msg="Default bridge (docker0) is assigned with an IP
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.580818585Z" level=info msg="Loading containers: done."
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.630878720Z" level=info msg="Docker daemon" commit=48a66213fe graphdriver(s)
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.636328410Z" level=info msg="Daemon has completed initialization"
Jul 25 06:31:07 magi systemd[1]: Started Docker Application Container Engine.
Jul 25 06:31:07 magi dockerd[3375]: time="2020-07-25T06:31:07.677294494Z" level=info msg="API listen on /var/run/docker.sock"

containerd 를 조회해 보았습니다.

sudo systemctl status containerd.service
containerd.service - containerd container runtime
   Loaded: loaded (/lib/systemd/system/containerd.service; enabled; vendor preset: enabled)
   Active: active (running) since Sat 2020-07-25 06:31:05 UTC; 3h 11min ago
     Docs: <https://containerd.io>
 Main PID: 3118 (containerd)
    Tasks: 9
   CGroup: /system.slice/containerd.service
           └─3118 /usr/bin/containerd

Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.738189803Z" level=info msg="loading plugin "io.containerd.grpc.v1.images
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.738198104Z" level=info msg="loading plugin "io.containerd.grpc.v1.leases
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.738208904Z" level=info msg="loading plugin "io.containerd.grpc.v1.namesp
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.738217304Z" level=info msg="loading plugin "io.containerd.internal.v1.op
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.744531308Z" level=info msg="loading plugin "io.containerd.grpc.v1.snapsh
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.744556608Z" level=info msg="loading plugin "io.containerd.grpc.v1.tasks"
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.744565509Z" level=info msg="loading plugin "io.containerd.grpc.v1.versio
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.744574009Z" level=info msg="loading plugin "io.containerd.grpc.v1.intros
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.745122618Z" level=info msg=serving... address="/run/containerd/container
Jul 25 06:31:05 magi containerd[3118]: time="2020-07-25T06:31:05.745135418Z" level=info msg="containerd successfully booted in 0.165150s"

dockerdcontainerd 가 분리되어 있기 때문에, 도커 버전을 올릴 때 재시작 하여도, 컨테이너의 재시작 없이 사용할 수 있습니다.

컨테이너 실행 과정 살펴보기

pstree 명령어를 이용하여, 프로세스를 트리 모양으로 확인해 보겠습니다.

sudo pstree

실행중인 컨테이너가 없다면, 다음과 같은 결과를 확인할 수 있습니다.

systemd─┬─accounts-daemon───2*[{accounts-daemon}]
        ├─atd
        ├─containerd───8*[{containerd}]
        ├─cron
...

nginx 컨테이너를 실행해 보겠습니다.

sudo docker run -d --name nginx nginx:latest

docker ps 명령어를 실행하여, 실행중인 컨테이너를 확인할 수 있습니다.

sudo docker ps
CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS               NAMES
79c0a9468509        nginx:latest        "/docker-entrypoint.…"   5 seconds ago       Up 4 seconds        80/tcp              nginx

pstree 명령어를 이용하여, 프로세스를 트리 모양으로 확인해 보겠습니다.

sudo pstree

containerd의 자식 프로세스로 containerd-shim 이 생성된 것을 알 수 있습니다.

systemd─┬─accounts-daemon───2*[{accounts-daemon}]
        ├─atd
        ├─containerd─┬─containerd-shim─┬─nginx───nginx
        │            │                 └─9*[{containerd-shim}]
        │            └─8*[{containerd}]
        ├─cron
        ├─dbus-daemon

앞서 살펴본, docker run 을 이용한 nginx 컨테이너의 실행 과정을 정리하면 다음과 같습니다.

  • docker 명령어, 즉 docker CLI 를 실행하면, dockerd 로 요청을 전달합니다.
  • dockerd는 gRPC를 통해 containerd 요청을 전달합니다.
  • containerdexec를 통해, containerd-shim 을 자식으로 생성합니다.
  • containerd-shimrunc 를 이용하여, 컨테이너를 생성하고 실행합니다.
  • runc 는 컨테이너가 정상적으로 실행되면 종료됩니다.
  • containerd-shim 은 컨테이너에서 실행되는 프로세스의 부모가 됩니다.

도커에는 컨테이너 안에 프로세스를 새로 실행할 수 있는 docker exec 라는 명령어가 있습니다.

다음 명령어를 실행하여, nginx 컨테이너에 bash 쉘을 추가로 실행해 보겠습니다.

sudo docker exec -it nginx bash

nginx 컨테이너 bash 쉘이 실행되고, -it 옵션을 사용했기 때문에 터미널에서 쉘을 이용할 수 있습니다.

다른 터미널을 열어서, pstree 를 실행해 보겠습니다.

pstree
systemd─┬─accounts-daemon───2*[{accounts-daemon}]
        ├─atd
        ├─containerd─┬─containerd-shim─┬─bash
        │            │                 ├─nginx───nginx
        │            │                 └─9*[{containerd-shim}]
        │            └─8*[{containerd}]
        ├─cron
...

containerd-shim 프로세스의 자식 프로세스로 bash 프로세스가 추가된 것을 확인할 수 있습니다.

참고 문서

우분투에 Docker 설치하기

Ubuntu Bionic 18.04 (LTS) 에 도커 설치하기

사전 확인

이전 버전 삭제하기

만약 이전 버전의 도커가 설치되어 있다면 먼저 삭제해야합니다. 패키지명은 docker, docker.io 또는 docker-engine 입니다

sudo apt-get remove docker docker-engine docker.io containerd runc

도커 설치하기

리포지토리를 이용하여 설치하기

새로운 호스트 시스템에, 처음으로 도커 엔진을 설치하기 위해서는, 도커 리포지토리를 설정해야 합니다. 설정 후후 리포지토리를 이용하여 도커를 설치하고 업데이트할 수 있습니다.

리포지토리 설정하기

https를 통해 리포지토리를 사용할 수 있도록, 적절한 패키지 인덱스 및 설치 패키지 업데이트 합니다.

sudo apt-get update

sudo apt-get install \\
    apt-transport-https \\
    ca-certificates \\
    curl \\
    gnupg-agent \\
    software-properties-common

도커의 공식 GPG key를 추가합니다

curl -fsSL <https://download.docker.com/linux/ubuntu/gpg> | sudo apt-key add -

도커를 설치하기 위한 리포지토리를 추가합니다.

sudo add-apt-repository \\
   "deb [arch=amd64] <https://download.docker.com/linux/ubuntu> \\
   $(lsb_release -cs) \\
   stable"

도커 설치하기

apt 패키지 인덱스를 업데이트하고, 도커 엔진과, containerd 를 설치합니다.

sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli 

도커 확인하기

docker 를 일반 사용자 계정에서 사용하려면, docker 그룹에 사용자 계정을 추가해 줘야합니다.

sudo usermod -aG docker <your-username>

로그 아웃을 한 다음, 다시 접속을 해야 설정이 적용됩니다.

docker info 명령어를 실행하여, 설치된 도커의 정보를 확인할 수 있습니다.

docker info

정상적으로 실행되면, 다음과 같은 결과를 확인할 수 있습니다.

Client:
 Debug Mode: false

Server:
 Containers: 0
  Running: 0
  Paused: 0
  Stopped: 0
 Images: 0
 Server Version: 19.03.12
 Storage Driver: overlay2
  Backing Filesystem: extfs
  Supports d_type: true
  Native Overlay Diff: true
 Logging Driver: json-file
 Cgroup Driver: cgroupfs
 Plugins:
  Volume: local
  Network: bridge host ipvlan macvlan null overlay
  Log: awslogs fluentd gcplogs gelf journald json-file local logentries splunk syslog
 Swarm: inactive
 Runtimes: runc
 Default Runtime: runc
 Init Binary: docker-init
 containerd version: 7ad184331fa3e55e52b890ea95e65ba581ae3429
 runc version: dc9208a3303feef5b3839f4323d9beb36df0a9dd
 init version: fec3683
 Security Options:
  apparmor
  seccomp
   Profile: default
 Kernel Version: 4.15.0-76-generic
 Operating System: Ubuntu 18.04.4 LTS
 OSType: linux
 Architecture: x86_64
 CPUs: 1
 Total Memory: 3.852GiB
 Name: magi
 ID: 53WF:R22P:ZLLX:5564:H5MV:2WDA:S7UK:CK5Y:G647:TH6W:D74Z:UPDZ
 Docker Root Dir: /var/lib/docker
 Debug Mode: false
 Registry: <https://index.docker.io/v1/>
 Labels:
 Experimental: false
 Insecure Registries:
  127.0.0.0/8
 Live Restore Enabled: false

WARNING: No swap limit support

우분투 18.04에 네트워크 카드 추가하기

우분투 18.04 부터는 네트워크 카드를 설정하려면, netplan을 사용해야 합니다.

네트워크 인터페이스 추가

네트워크 인터페이스를 추가한 다음, ifconfig 명령어를 실행해 봅니다. 별다른 옵션을 주기 않았기 때문에, 추가된 네트워크 인터페이스가 보이지 않습니다.

ifconfig
lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 944  bytes 67408 (67.4 KB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 944  bytes 67408 (67.4 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

추가한 네트워크 인터페이스 확인

ifconfig -a 명령어를 이용하여, 추가한 네트워크 인터페이스를 확인할 수 있습니다.

ifconfig -a

eth0 이 추가된 것을 확인할 수 있습니다.

eth0: flags=4098<BROADCAST,MULTICAST>  mtu 1500
        ether 00:15:5d:15:0e:00  txqueuelen 1000  (Ethernet)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 944  bytes 67408 (67.4 KB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 944  bytes 67408 (67.4 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

설정에 네트워크 인터페이스를 추가하기

/etc/netplan/*.yaml 파일에 네트워크 설정을 추가해 줘야 합니다

cat /etc/netplan/*.yaml
# This file is generated from information provided by the datasource.  Changes
# to it will not persist across an instance reboot.  To disable cloud-init's
# network configuration capabilities, write a file
# /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg with the following:
# network: {config: disabled}
network:
    ethernets: {}
    version: 2

현재 설정된 네트워크 인터페이스가 없기 때문에, ethernets 필드에 아무런 값이 없습니다.

/etc/netplan/*.yaml 파일에 네트워크 설정을 추가합니다.

sudo vi /etc/netplan/*.yaml

ifconfig -a 명령어를 통해서 확인한 네트워크 인터페이스 이름을 ethernets 필드에 추가하고, 설정값을 지정해줍니다. 아래 예제에서는 dhcp 를 사용하기 때문에, IP 직접 명시하지 않았습니다.

# This file is generated from information provided by the datasource.  Changes
# to it will not persist across an instance reboot.  To disable cloud-init's
# network configuration capabilities, write a file
# /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg with the following:
# network: {config: disabled}
network:
    ethernets:
        eth0:
            addresses: []
            dhcp4: true
    version: 2

만약 고정 IP를 사용한다면 아래처럼 설정할 수 있습니다.

# This file is generated from information provided by the datasource.  Changes
# to it will not persist across an instance reboot.  To disable cloud-init's
# network configuration capabilities, write a file
# /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg with the following:
# network: {config: disabled}
network:
    ethernets:
        eth0:
            addresses: [192.168.21.100/24]
            gateway4: 192.168.56.1
            nameservers:
                    addresses: [8.8.8.8,8.8.4.4]
            dhcp4: no
            dhcp6: no
    version: 2

설정 적용하기

다음 명령어를 실행하여, 변경한 설정을 적용합니다.

sudo netplan apply

설정이 적용되면 ifconfig 명령어를 실행하여, 적용한 내용을 확인할 수 있습니다.

ifconfig

정상적으로 적용되었다면, 추가한 eth0 을 확인할 수 있습니다.

eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 192.168.21.39  netmask 255.255.255.0  broadcast 192.168.21.255
        inet6 fe80::215:5dff:fe15:e00  prefixlen 64  scopeid 0x20<link>
        ether 00:15:5d:15:0e:00  txqueuelen 1000  (Ethernet)
        RX packets 47668  bytes 70216376 (70.2 MB)
        RX errors 0  dropped 6  overruns 0  frame 0
        TX packets 9362  bytes 772780 (772.7 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 120  bytes 9592 (9.5 KB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 120  bytes 9592 (9.5 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

Graceful Shutdown Pods in a Kubernetes Cluster

애플리케이션 서버를 직접 클라이언트에 노출하지 않는 것이 좋습니다. 로드 밸런서나, 리버스 프록시 같은 것을 중간에 둬서 서비스 트래픽을 제어할 수 있도록 합니다. 애플리케이션을 종료할 필요가 있을 경우, 로드 밸런서나 리버스 프록시에서 해당 애플리케이션을 제외 시켜버리면, 서비스 트랙이 해당 애플리케이션으로 전달되지 않으므로, 애플리케이션의 입장에서는 새로운 요청을 들어오지 않게됩니다.

로드 밸런서에 특정 서버를 제외할 수 있는 방법은 크게 두가지 있습니다.

  • 로드 밸런서에 서버를 제외 시키는 명령어를 보내기
  • 로드 밸런서에서 서버의 상태를 체크하여, 정상 상태가 아닐 경우 자동으로 제외하기

일반적으로는 두 번째 방법을 많이 사용합니다. 로드 밸런서에서 주기적으로 서버들을 체크하여, 정상 상태가 아닐 경우, 자동으로 해당 서버를 제외시켜버리는 것입니다. 그리고 정상 상태로 돌아올 경우 다시 로드 밸런서에 해당 서버를 추가 시킵니다.

쿠버네티스의 상태 프로브(Health Probe)

쿠버네티스는 컨테이너의 상태를 주기적으로 진단합니다. 각 노드에 설치된 kubelet 에 의하여 컨테이너의 상태를 진단하게 됩니다. 컨테이너의 상태를 진단하기 위하여, 다음과 같은 세가지 타입의 핸들러를 제공하고 있습니다.

  • HTTP : 지정한 경로와 포트에 HTTP GET 요청을 수행합니다. HTTP 응답 코드가 200 보드 크거나 같고, 400보다 작으면 진단이 성공한것으로 간주합니다.
  • TCP : 지정한 포트에 대하여 TCP 검사를 수행합니다. 포트가 활성화 되어 있으면, 진단이 성공한 것으로 간주합니다.
  • Exec : 컨테이너 안에서 지정한 명령어를 실행합니다. 명령어의 종료 코드가 0이면 진단이 성공한것으로 간주합니다.

라이브니스 프로브(Liveness Probe)

애플리케이션이 교착 상태 같은 비정상 상태에 빠졌을 경우, 단순히 프로세스의 상태 확인 만으로는 정상인지 아닌지 판단하기가 어렵습니다. 애플리케이션이 정상 작동 하지 않는 상태에서도, 프로세스의 상태는 정상으로 나올 수 있기 때문입니다. 이런 종류의 문제와, 비즈니스 로직에 따른 다른 형태의 장애를 감지가기 위해서, 쿠버네티스는 라이브니스 프로브를 사용합니다.

쿠버네티스의 노드에 설치된 kubelet이 정기적으로 파드 컨테이너의 라이브니스 상태를 점검하게 됩니다. 만약 비정상 상태가 감지된다면, 컨테이너를 재시작 시킵니다.

애플리케이션의 상태를 확인 할 수 있는 방법은 다음과 같습니다.

애플리케이션이 정상상태인지 아닌지를 판단하는 것은 개발자의 구현에 달려있습니다. 정상상태가 아닐 경우, 컨테이너가 다시 시작된다는 사실을 잘 기억하고 있어야 합니다. 컨테이너 재시작이 아무 소용 없는 경우라면, 해당 라이브니스의 상태값은 아무런 도움이 되지 않기 때문입니다.

레디니스 프로브(Readiness Probe)

쿠버네티스는 파드(Pod)를 이용하여, 애플리케이션을 실행 시킵니다. 그리고 이 파드에 주어진 주소를 이용하여 애플리케이션에 접근할 수 있습니다. 하지만 파드란 것은 상황에 따라 생성되고 없어지는 성질을 가지고 있습니다. 예를 들어, 새로운 배포에 의해 기존 파드가 제거되고, 새로운 파드가 생성될 수 있습니다. 그리고 스케일 아웃을 하기 위하여, 파드의 개수를 늘리 수도 있습니다.

이러한 이유로, 파드의 주소 만으로는 애플리케이션에 접근하는게 쉽지 않습니다. 그래서 쿠버네티스에서는 서비스(Service) 라는 개념을 만들어서, 파드의 애플리케이션으로 접근할 수 있게 하였습니다. 서비스는 레이블 셀렉터를 이용하여, 자신에게 속한 포드들의 목록을 가져올 수 있습니다. 그래서 파드들이 생성되고, 사라지더라도 대상 파드들 중 하나에게 트래픽을 보낼 수 있습니다. 하지만 파드들이 실행중에 있더라도, 무조건 트래픽을 보내면 문제가 생길 수 있습니다. 파드가 비정상 상태에 있을 수도 있기 때문입니다. 그래서 서비스는 파드의 상태를 체크할 필요가 있습니다. 이럴때 사용되는게 레니니스(Readniess) 프로브 입니다. 서비스는 파드의 레디니스(Readiness) 상태를 체크하고, 정상 상태일 때문에 해당 파드로 트래픽을 보냅니다. (정확히 말하면, 서비스가 트래픽을 보내는 것은 아니지만, 개념적으로는 그렇게 이해하시는게 편할것입니다.) 그리고 비정상 상황 파드일 경우, 트래픽을 보내는 대상에서 제외시켜버립니다.

정리하자면, 애플리케이션이 작업을 처리할 준비가 되어있는지를 판별하고, 준비가 되었다면 트래픽을 수신할 수 있도록 해줍니다.

파드 종료 생명주기

애플리케이션의 배포 단위는 파드입니다. 파드는 하나 또는 그 이상의 컨테이너로 이루어져 있습니다. 파드가 종료되면, 파드에 속한 컨테이너도 종료됩니다.

컨테이너가 종료될때 다음과 같은 절차를 따르게 됩니다.

  • 노드에 있는 kubelet이 파드에 정의한 preStop 훅(hook)을 호출합니다.
  • preStop 훅이 완료되면, kubelet 은 파드 컨테이너에서 실행중인 애플리케이션에게 SIGTERM 신호를 보냅니다.
  • kubelet 은 컨테이너가 종료될때 까지 유예 시간(기본값 30초) 동안 기다립니다. 그 후 SIGKILL 을 사용하여 프로세스를 강제로 종료 시킵니다. 이 유예 시간은 preStop 훅을 실행하는 시간까지 포함됩니다.
https://s3-us-west-2.amazonaws.com/secure.notion-static.com/5dc89ac3-b345-4f1f-aa3d-1a572ea8c46b/Container_Stop.png

이러한 흐름을 참조하여, preStop 훅이나, SIGTERM 신호를 이용하여, 애플리케이션이 정상적으로 종료될 수 있도록 정리 작업 같은 것을 할 수 있습니다. 예를 들면, 새로운 요청이 들어오지 못하게 하고, 이미 대기열에 있는 작업들의 처리가 완료될때까지 종료가 되지 않도록 기다리게 할 수 있습니다.

물론, preStop 훅이나, SIGTERM 신호를 이용하여 블록킹하더라도, 컨테이너가 종료되는것을 막을 수 없습니다. 유예 기간이 지나면 강제적으로 종료되기 때문입니다.

종료전 훅

preStop 훅은 컨테이너가 종료되기 전에 호출하는 블럭킹 호출입니다. SIGTERM 신호와 동일한 의미를 가지고 있으며, 컨테이너가 SIGTERM 신호를 처리하는 것이 불가능할 때 사용합니다.

preStop 훅 에서 사용할 수 있는 핸들러는 다음과 같습니다.

  • httpGet: 지정한 경로와 포트에 HTTP GET 요청을 수행합니다.
  • exec: 컨테이너 안에서 지정한 명령어를 실행합니다.

다음은 preStop 훅을 사용하는 컨테이너 예제입니다. 애플리케이션의 xxx 엔드포인트를 호출합니다.

apiVersion: v1
kind: Pod
metadata:
  name: pre-stop-hook
spec:
  containers:
  - name: demo-app
    image: xxxx
    lifecycle:
      preStop:
        httpGet:
          path: /shutdown
          port: 8080

SIGTERM 신호

컨테이너를 종료하려고 할때, kubelet 은 컨테이너에게 SIGTERM 신호를 보냅니다. SIGTERM 신호는 컨테이너한테, 종료할거라는 것을 미리 알려주는 역할을 합니다. SIGTERM 신호를 받은 애플리케이션은 가능한 한 빠르게 애플리케이션을 종료시켜야 합니다. 그리고 안전하고 깨끗하게 애플리케이션을 종료하기 위한 작업들도 진행할 수 있습니다.

SIGKILL 신호

SIGTERM 신호 후에도 컨테이너가 종료되지 않는다면, SIGKILL 신호를 발생시켜 강제로 종료시킵니다. SIGTERM 신호 발생 후, 지정된 유예 시간 동안 컨테이너가 종료되지 않으면, SIGKILL 신호를 발생시키는 것입니다. 이 유예 시간은 .spec.termicationGracePeriodSeconds 필드를 이용하여 설정할 수 있습니다.

종료 후 트래픽

파드의 정상적인 종료는, 종료 전에 들어온 트래픽을 처리하도록 보장할 수 있습니다. 하지만 파드가 종료된 후에도 트래픽을 계속 수신하여, 서비스에서 다운타임이 발생할 수 도 있습니다.

어떻게 해서 이런 문제가 발생하는지에 대해서 살펴보겠습니다. 다음 예제에서는 두 개의 포드가 실행되어 있고, 트래픽을 받기 위해서 하나의 서비스 가 있습니다. 트래픽은 서비스를 거처 두 개의 포드 중 하나로 전달됩니다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/6a050a05-fa7f-4b24-8141-7591171354c5/Kubernetes-service_(1).png

이 시점에서 파드 A1을 삭제한다가 가정하겠습니다. 파드 A1을 종료하기 위해서 kubectlpreStop 훅을 먼저 실행하게 되고, 파드 A1의 애플리케이션을 정상적인 종료 절차가 시작됩니다.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/5217f1df-6adc-4491-9c7e-5c0ce1776eff/Kubernetes-preStop_(1).png

파드 A1의 종료를 위하여, preStop 훅을 호출 하는 시점에서도, 파드는 서비스에 등록되어 있을 수 있기 때문에 여전히 트래픽을 받을 수 있습니다.

파드 A1의 애플리케이션이 preStop 훅을 수신 받으면, 정상적인 종료를 위한 절차를 실행할 것입니다. 일반적인 종료 절차는, 이미 들어온 요청을 처리하고, 애플리케이션을 종료시키는 등의 작업일 것입니다. 그런데 이런 절차에 의해서, 애플리케이션이 종료되었는데, 새롭게 들어오는 추가 트래픽이 발생한다면, 오류를 발생시킬 수 있습니다.

그래서, 보다 안전하게 파드를 종료시키려면, 해당 파드를 서비스로부터 제거해야 하는 것입니다.

파드 종료 절차

API를 통해서 파드를 삭제한다고 가정해보겠습니다. API를 통해서 파드를 삭제하면, 메타데이터 서버에 파드가 삭제되길 원한다고 표시되기만 합니다. 이렇게 되면, 파드 삭제 통지가 전파가 됩니다. 그리고, 파드 삭제에 관련있는 시스템은 다음과 같은 처리를 하게 됩니다.

  • 파드를 실행하는 kubelet은 앞에 설명한 “파드 종료 생명주기”의 종료 절차를 시작하게 됩니다.
  • 엔드포인트 컨트롤러(endpoints controller) 가 유효한 엔드포인트 목록에서 파드를 제거하게 되고, 해당 서비스에서 파드가 제거됩니다.

여기서 중요한 점은, 여러 시스템이 관련이 있고, 서로 다른 노드에서 실행될 수도 있기 때문에, 이러한 절차가 병렬로 처리될 수도 있다는 것입니다. 그래서 종료 절차가 시작된 후에도 트래픽을 계속 수신할 수도 있는 것입니다.

문제 완화

불행히도 이러한 문제점을 완벽하게 해결할 수 있는 방법은 없습니다. 하지만 충분한 종료 절차 지연을 두어서, 대부분의 경우에는 이문제를 회피할 수 있습니다. 가장 간단한 방법은 preStop 훅에, sleep을 실행하여, 종료 절차를 지연시키는 것입니다.

다음은 preStop 훅에 지연을 추가한 매니페스트의 일부분입니다. 정확하게 몇초를 지연시키는것이 좋다는 것은 알 수 없습니다. 하지만, “Kubernete in Action”책에서 5-10초를 추천하였기 때문에, 예제에서는 5초를 사용하였습니다.

lifecycle:
  preStop:
    exec:
      command: [
        "sh", "-c",
        # Introduce a delay to the shutdown sequence to wait for the
        # pod eviction event to propagate. Then, gracefully shutdown
        "sleep 5",
      ]
https://s3-us-west-2.amazonaws.com/secure.notion-static.com/dcd36ceb-3ceb-4137-b11c-3c85e121b568/Kubernetes-sleep.png

preStop 훅에 의해서 5초간 지연을 시켰기 때문에, 유효한 엔드포인트 목록에서 파드를 제거하고, 해당 서비스에서도 파드를 제거하기 충분한 시간을 확보할 수 있게 됩니다.