SIG TFX-Addonsコミュニティに参加して、TFXをさらに改善するのを手伝ってください! SIGTFXに参加-アドオン

カスタム Python 関数コンポーネント

注:TFX 0.22 以降、新しい Python 関数ベースのコンポーネント定義スタイルの実験的なサポートが利用可能になりました。

Python 関数ベースのコンポーネント定義を使用すると、コンポーネント仕様クラス、実行クラス、およびコンポーネントインターフェイスクラスを定義する手間が省けるため、TFX カスタムコンポーネントを簡単に作成できます。このコンポーネント定義スタイルでは、型ヒントで注釈が付けられた関数を記述します。型ヒントは、コンポーネントの入力アーティファクト、出力アーティファクト、およびパラメータを記述します。

次の例のように、簡単にカスタムコンポーネントを作成できます。

@component
def MyValidationComponent(
    model: InputArtifact[Model],
    blessing: OutputArtifact[Model],
    accuracy_threshold: Parameter[int] = 10,
    ) -> OutputDict(accuracy=float):
  '''My simple custom model validation component.'''

  accuracy = evaluate_model(model)
  if accuracy >= accuracy_threshold:
    write_output_blessing(blessing)

  return {
    'accuracy': accuracy
  }

TFX パイプラインが初めての方は、TFX パイプラインの中心的概念の学習をご確認ください。

入力、出力、およびパラメータ

TFX では、入力と出力は、基になるデータの場所とそれに関連付けられたメタデータプロパティを記述するアーティファクトオブジェクトとして追跡されます。この情報は ML メタデータに保存されます。アーティファクトは、int、float、bytes、unicode 文字列などの複雑なデータ型または単純なデータ型を記述できます。

パラメータは、パイプラインの構築時に認識されているコンポーネントへの引数(int、float、bytes、または Unicode 文字列)です。パラメータは、引数と、トレーニングの反復回数、ドロップアウト率、その他の構成などのハイパーパラメータをコンポーネントに指定するのに役立ちます。パラメータは、ML メタデータで追跡される際に、コンポーネント実行のプロパティとして保存されます。

注:現在、出力された単純なデータ型の値は、実行時に不明であるため、パラメータとして使用できません。同様に、入力された単純なデータ型の値は、現在、パイプラインの構築時に既知の具象値を取ることはできません。TFX の今後のリリースでは、この制限が削除される可能性があります。

定義

カスタムコンポーネントを作成するには、カスタムロジックを実装する関数を記述し、tfx.dsl.component.experimental.decoratorsモジュールからの@componentデコレータでデコレートします。コンポーネントの入力スキーマと出力スキーマを定義するには、tfx.dsl.component.experimental.annotationsモジュールの注釈を使用して、関数の引数と戻り値に注釈を付けます。

  • それぞれのアーティファクトの入力に、InputArtifact[ArtifactType]型のヒント注釈を適用します。ArtifactTypeを、tfx.types.Artifactのサブクラスであるアーティファクトの型に置き換えます。これらの入力はオプションの引数にすることができます。

  • それぞれの出力アーティファクトに、OutputArtifact[ArtifactType]型のヒント注釈を適用します。ArtifactTypeを、tfx.types.Artifactのサブクラスであるアーティファクトの型に置き換えます。コンポーネントの出力アーティファクトは、関数の入力引数として渡す必要があります。これにより、コンポーネントは、システム管理の場所に出力を書き込み、適切なアーティファクトメタデータプロパティを設定できます。パラメータごとに、型ヒント注釈Parameter[T]を使用します。Tを、intfloatstr、または、bytesなどのパラメータの型に置き換えます。この引数はオプションにすることも、デフォルト値で定義することもできます。

  • パイプラインの構築時に不明な単純なデータ型の入力(intfloatstrまたはbytes)には、それぞれ型ヒントTを使用してください。TFX 0.22 リリースでは、この型の入力のパイプライン構築時に具象値を渡すことができないことに注意してください(前のセクションで説明したように、代わりにParameter注釈を使用します)。この引数はオプションにすることも、デフォルト値で定義することもできます。コンポーネントに単純なデータ型出力(intfloatstrまたはbytes)がある場合、これらの出力は、OutputDictインスタンスを使用して返すことができます。OutputDict 型のヒントをコンポーネントの戻り値として適用します。

  • それぞれの出力に、引数<output_name>=<T>OutputDictコンストラクタに追加します。<output_name>は出力名、<T>は出力の型です(intfloatstrまたはbytesなど)。

関数の本体では、入力アーティファクトと出力アーティファクトはtfx.types.Artifactオブジェクトとして渡されます。.uriを調べて、システム管理の場所を取得し、プロパティを読み取り/設定できます。入力パラメータと単純なデータ型の入力は、指定された型のオブジェクトとして渡されます。単純なデータ型の出力はディクショナリとして返される必要があります。鍵は適切な出力名であり、値は期待される戻り値です。

完成した関数コンポーネントは次のようになります。

from tfx.dsl.component.experimental.annotations import OutputDict
from tfx.dsl.component.experimental.annotations import InputArtifact
from tfx.dsl.component.experimental.annotations import OutputArtifact
from tfx.dsl.component.experimental.annotations import Parameter
from tfx.dsl.component.experimental.decorators import component
from tfx.types.standard_artifacts import Examples
from tfx.types.standard_artifacts import Model

@component
def MyTrainerComponent(
    training_data: InputArtifact[Examples],
    model: OutputArtifact[Model],
    dropout_hyperparameter: float,
    num_iterations: Parameter[int] = 10
    ) -> OutputDict(loss=float, accuracy=float):
  '''My simple trainer component.'''

  records = read_examples(training_data.uri)
  model_obj = train_model(records, num_iterations, dropout_hyperparameter)
  model_obj.write_to(model.uri)

  return {
    'loss': model_obj.loss,
    'accuracy': model_obj.accuracy
  }

# Example usage in a pipeline graph definition:
# ...
trainer = MyTrainerComponent(
    examples=example_gen.outputs['examples'],
    dropout_hyperparameter=other_component.outputs['dropout'],
    num_iterations=1000)
pusher = Pusher(model=trainer.outputs['model'])
# ...

上記の例では、MyTrainerComponentを Python 関数ベースのカスタムコンポーネントとして定義しています。このコンポーネントは、入力としてexamplesアーティファクトを消費し、出力としてmodelアーティファクトを生成します。コンポーネントはartifact_instance.uriを使用して、システム管理の場所でアーティファクトの読み取りまたは書き込みを行います。コンポーネントはnum_iterations入力パラメータとdropout_hyperparameterの単純なデータ型値を取り、コンポーネントは単純なデータ型の出力値としてlossaccuracyメトリックを出力します。出力されたmodelアーティファクトは、Pusherコンポーネントにより使用されます。