Шаблоны карточек моделей

Шаблоны Jinja — это внутренняя структура документа карты модели. В комплект Model Card Toolkit входит несколько готовых шаблонов, но вы можете свободно изменять эти шаблоны или даже создавать свои собственные. В этом документе мы обсудим, как это сделать.

Ниже приведен стандартный способ инициализации набора инструментов Model Card.

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 toolkit.scaffold_assets() , содержимое model_card_toolkit/template копируется в mct_directory/template . Сюда входят готовые шаблоны, такие как default_template.html.jinja и default_template.md.jinja .

Созданный выше объект model_card можно заполнить вручную. Когда вы будете готовы создать документ 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')

Измените шаблон карточки модели.

Вы можете свободно изменять готовый шаблон, меняя стиль, реорганизовывая информацию и т. д. Вы должны быть знакомы с API Jinja и структурами управления . Имена полей карты модели взяты из 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