Model Card 範本

Jinja 範本是 Model Card 文件的後端結構。Model Card Toolkit 隨附一些預先製作的範本,但您可以自由修改這些範本,甚至建立自己的範本。在本文件中,我們將討論如何執行這項操作。

以下是初始化 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.jinjadefault_template.md.jinja

上方產生的 model_card 物件可以手動填入。準備好產生 Model Card 文件後,您可以透過 toolkit.update_model_card(model_card)model_card 傳回 MCT。

使用預先製作的 Model Card 範本

接著,我們可以透過以下程式碼,使用其中一個預設範本產生 Model Card 文件。

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')

修改 Model Card 範本

您可以自由修改預先製作的範本,以變更樣式、重新組織資訊等。您應熟悉 Jinja API控制結構。Model Card 欄位名稱取自 model_card.py

建立新的 Model Card 範本

建立新的 Model Card 範本與修改現有範本的方式相同。

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