Macros in Vectice use internal metadata to fill your reports with specific project information. You can create your own macros, and Vectice provides some predefined macros for you. Those macros are:
| Macro | Description | Requirement |
|---|---|---|
Below, we provide how to meet Macro requirements to use them seamlessly within your reports.
This Macro will insert specific phase documentation into your report. To use this Macro, phase documentation is required. You can find the phase documentation within the Documentation tab of your phase.
This Macro requires a project description. To add a description, go to your project settings and add a description.
To use this Macro, the Model of interest must include a description. You can add a Model description by selecting the Models tab, selecting your model, and then add a description.
To use this Macro, the Model version must have properly updated information. To update your model page with the right info, select the Models tab, select a version, and edit the model page where needed.
To use this Macro, the Model version must have properties logged to Vectice either through the API or within the Vectice app. Refer to our guide "How to log models" for adding properties via the API.
To use this Macro, the Model version must have a description. To add a description, select the Models tab, choose your model, select a model version, and then add a description.
To use this Macro, the Model version must have metrics logged to Vectice either through the API or within the Vectice app. Refer to our guide "How to log models" for adding metrics via the API.
To use this Macro, the Model requires an upload of the feature importance graph to the Vectice app, or log it from the API. To add attachments via API, view our Log attachments and notes guide.
The API requires you to name the logged graph feature_importance.png.
To add a graph in the Vectice app, select the Models tab, pick your model and its version, and beside "Attachments" select the Add button.
Insert phase content
Inserts information from your project's phase documentation.
Project info
Inserts your project's details and description.
Project structure
Displays your project's structure overview.
Model stakeholders
Displays your model's stakeholders.
Model intent
Inserts your model's description.
Model version summary
Provides a summary of your model's version.
Dataset columns description
Displays a table of your dataset's columns with key statistics.
Data overview
Provides a general summary of your dataset.
Model properties
Displays all properties of your model version.
Model version description
Displays the description of your model version.
Model performance
Displays the metrics of your model version's performance.
Model feature importance
Displays the graph showing the importance of each feature in your model.
A logged graph named feature_importance.png
Model alternative
Displays a summary table of the the different model alternatives tested.
Must have at least 4 model versions (1 main model version and 3 model alternatives to compare).
Model comparison
Compares the current model with the baseline or prior production model.
Must have ROC curve and feature importance graph logged to Vectice with their respective labels ('ROC' or 'Importance') in the graph names. (See model feature importance for reference.)
