TFX のモデル カード

ModelCardGenerator TFX パイプライン コンポーネントはモデル カードを生成します。

モデル カードの形式の詳細については、 「モデル カード API」を参照してください。

TFX に関する一般的な情報については、 「TFX ユーザー ガイド」を参照してください。

ModelCardGenerator コンポーネントの構成

ModelCardGenerator は、データセット統計、モデル評価、およびプッシュされたモデルを取得して、モデル カードの一部を自動的に設定します。

モデル カード フィールドには、JSON 文字列を明示的に入力することもできます (これは、 jsonモジュールを使用して生成できます。以下の例を参照してください)。フィールドに TFX と JSON の両方が入力されている場合、JSON 値が TFX 値を上書きします。

ModelCardGenerator は、モデル カード ドキュメントをそのアーティファクト出力のmodel_card/ディレクトリに書き込みます。これは、 model_card.htmlの生成に使用されるデフォルトの HTML モデル カード テンプレートを使用します。カスタムテンプレートも使用できます。各テンプレート入力には、 template_io引数内のファイル名出力が伴う必要があります。

例

from model_card_toolkit import ModelCardGenerator
import json

...
model_card_fields = {
  'model_details': {
    'name': 'my_model',
    'owners': 'Google',
    'version': 'v0.1'
  },
  'considerations': {
    'limitations': 'This is a demo model.'
  }
}
mc_gen = ModelCardGenerator(
    statistics=statistics_gen.outputs['statistics'],
    evaluation=evaluator.outputs['evaluation'],
    pushed_model=pusher.outputs['pushed_model'],
    json=json.dumps(model_card_fields),
    template_io=[
        ('html/default_template.html.jinja', 'model_card.html'),
        ('md/default_template.md.jinja', 'model_card.md')
    ]
)

詳細については、 ModelCardGenerator API リファレンスを参照してください。

完全な動作例については、エンドツーエンドのデモをご覧ください。