Modèles de cartes modèles

Les modèles Jinja constituent la structure backend d’un document Model Card. Le Model Card Toolkit est livré avec quelques modèles prédéfinis, mais vous pouvez librement modifier ces modèles ou même créer les vôtres. Dans ce document, nous verrons comment procéder.

Voici la manière standard d'initialiser le 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)

Lorsque vous exécutez toolkit.scaffold_assets() , le contenu de model_card_toolkit/template est copié dans mct_directory/template . Cela inclut des modèles prédéfinis tels que default_template.html.jinja et default_template.md.jinja .

L'objet model_card généré ci-dessus peut être renseigné manuellement. Une fois que vous êtes prêt à générer un document Model Card, vous pouvez renvoyer la model_card dans MCT avec toolkit.update_model_card(model_card) .

Utilisez un modèle de carte modèle prédéfini

Nous pouvons ensuite générer un document Model Card en utilisant l'un des modèles par défaut, via le code ci-dessous.

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

Modifier le modèle de carte modèle

Vous pouvez librement modifier un modèle prédéfini pour changer le style, réorganiser les informations, etc. Vous devez être familier avec l' API Jinja et les structures de contrôle . Les noms des champs de la carte modèle proviennent de model_card.py .

Création d'un nouveau modèle de carte modèle

La création d'un nouveau modèle de carte modèle fonctionne de la même manière que la modification d'un modèle existant.

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