Szablony kart modelowych

Szablony Jinja to struktura zaplecza dokumentu karty modelu. Zestaw narzędzi karty modelu zawiera kilka gotowych szablonów, ale możesz je dowolnie modyfikować, a nawet tworzyć własne. W tym dokumencie omówimy, jak to zrobić.

Poniżej przedstawiono standardowy sposób inicjowania zestawu narzędzi karty modelu.

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)

Kiedy uruchomisz toolkit.scaffold_assets() , zawartość model_card_toolkit/template zostanie skopiowana do mct_directory/template . Obejmuje to gotowe szablony, takie jak default_template.html.jinja i default_template.md.jinja .

Wygenerowany powyżej obiekt model_card można wypełnić ręcznie. Gdy będziesz gotowy do wygenerowania dokumentu Model Card, możesz przekazać model_card z powrotem do MCT za pomocą toolkit.update_model_card(model_card) .

Użyj gotowego szablonu karty modelu

Następnie możemy wygenerować dokument Karty Modelu, korzystając z jednego z domyślnych szablonów, korzystając z poniższego kodu.

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

Zmodyfikuj szablon karty modelu

Gotowy szablon możesz dowolnie modyfikować, zmieniając styl, reorganizując informacje itp. Powinieneś znać Jinja API i struktury kontrolne . Nazwy pól karty modelu pochodzą z model_card.py .

Tworzenie nowego szablonu karty modelu

Tworzenie nowego szablonu Karty Modelu działa tak samo, jak modyfikowanie istniejącego.

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