模型卡模板

Jinja 模板 是模型卡文档的后台结构。模型卡工具包附带了一些预制模板,但您可以随意修改这些模板,甚至构建自己的模板。在本文件中,我们将讨论如何做到这一点。

以下是初始化模型卡工具包的标准方法。

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 传回 MCT,使用 toolkit.update_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')

修改模型卡模板

您可以随意修改预制模板以更改样式、重新组织信息等。您应该熟悉 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