Jinja テンプレートは、モデル カード ドキュメントのバックエンド構造です。モデル カード ツールキットには、いくつかの既成のテンプレートが付属していますが、これらのテンプレートを自由に変更したり、独自のテンプレートを作成したりすることもできます。このドキュメントでは、これを行う方法について説明します。
以下は、Model Card Toolkit を初期化する標準的な方法です。
mct_directory = ... # where the Model Card assets will be generated
toolkit = ModelCardToolkit(mct_directory)
model_card = toolkit.scaffold_assets()
... # set the model_card's fields here
toolkit.update_model_card(model_card)
toolkit.scaffold_assets()を実行すると、 model_card_toolkit/templateの内容がmct_directory/templateにコピーされます。これには、 default_template.html.jinjaやdefault_template.md.jinjaなどの事前に作成されたテンプレートが含まれます。
上記で生成されたmodel_cardオブジェクトは手動で設定できます。モデル カード ドキュメントを生成する準備ができたら、 toolkit.update_model_card(model_card)を使用してmodel_cardを MCT に戻すことができます。
既製のモデル カード テンプレートを使用する
次に、以下のコードを介して、デフォルトのテンプレートの 1 つを使用してモデル カード ドキュメントを生成できます。
template_path = os.path.join(mct_directory, 'template/html/default_template.html.jinja')
toolkit.export_format(template_path=template_path, output_file='model_card.html')
モデルカードテンプレートを変更する
事前に作成されたテンプレートを自由に変更して、スタイルを変更したり、情報を再編成したりできます。Jinja APIと制御構造に精通している必要があります。モデル カードのフィールド名は、 model_card.pyから取得されます。
新しいモデルカードテンプレートの作成
新しいモデル カード テンプレートの作成は、既存のモデル カード テンプレートを変更するのと同じように機能します。
my_custom_template_path = ... # where the template is stored
toolkit.export_format(template_path=my_custom_template_path, output_file'model_card.html') # generate the final Model Card