模型卡片模板

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.jinjadefault_template.md.jinja

上面生成的 model_card 对象可以手动填充。一旦准备好生成模型卡片文档,您可以将 model_card 通过 toolkit.update_model_card(model_card) 传回 MCT。

使用预制的模型卡片模板

然后,我们可以通过下面的代码使用默认模板之一生成模型卡片文档。

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