模型卡工具包
model-card-toolkit的Python项目详细描述
模型卡工具包
ModelCardToolkit(MCT)简化并自动生成Model Cards[1],机器学习文档为模型的开发和性能提供上下文和透明度。将MCT集成到ML管道中可以与研究人员、开发人员、记者等共享模型元数据和度量。在
模型卡的一些用例包括:
- 促进模型构建者和产品开发人员之间的信息交换。在
- 告知ML模型的用户,让他们对如何使用它们(或如何不使用它们)做出更明智的决定。在
- 提供有效的公众监督和问责所需的示范信息。在
安装
模型卡工具包托管在PyPI,可以与pip install model-card-toolkit
一起安装。在
入门
import model_card_toolkit
# Initialize the Model Card Toolkit with a path to store generate assets
model_card_output_path = ...
mct = model_card_toolkit.ModelCardToolkit(model_card_output_path)
# Initialize the model_card_toolkit.ModelCard, which can be freely populated
model_card = mct.scaffold_assets()
model_card.model_details.name = 'My Model'
# Write the model card data to a JSON file
mct.update_model_card_json(model_card)
# Return the model card document as an HTML page
html = mct.export_format()
模型卡自动生成
如果机器学习管道使用TensorFlow Extended (TFX)平台或ML Metadata,则可以自动生成模型卡。有关如何将MCT集成到您的管道中的演示,请参见this demo notebook。在
架构
模型卡作为中间格式存储在JSON中。您可以在schema
目录中看到模型卡JSON模式。请注意,这不是最终确定的路径,将来可能会在其他地方托管。在
参考文献
[1]https://arxiv.org/abs/1810.03993
- 项目
标签: