Streamline documentation with Macros

Macros offer an easy way to keep your documentation uniform and accessible, helping everyone stay on the same page. Macros use internal metadata to fill your reports with specific project information. You can create your own macros, and Vectice provides predefined macros.

Benefits of Macros:

• Save time on routine documentation tasks

• Ensure consistency across projects and teams

• Reduce errors by pre-configuring fields and prompts

🧩 Available Pre-defined Macros

You can easily create and customize your macros directly from the admin menu, customizing them to suit your specific needs.

Here are the main macros available in Vectice, each designed to meet different documentation needs:

Asset Documentation Macros

Quickly document new assets with standardized fields for name, type, and description, ensuring all asset entries are clear and uniform.

Example Usage: When a new data source is added to a project, use the "Data overview" macro to instantly capture a general summary of the new data.

Model-Related Macros

Macro	Description
Model version stakeholders	Displays your model's stakeholders.
Model version properties	Displays all properties of your model version.
Model feature importance	Displays a graph showing the importance of each feature in your model.
Model version summary	Provides a summary of your model's version.
Model version description	Displays the description of your model version.
Model version performance	Displays the performance metrics of your model.
Model version feature importance	Displays the graph showing the importance of each feature in your model version.
Model version comparison	Compares a model with the baseline or prior production model.
Model version alternative	Displays a summary table of the different model alternatives tested.

Dataset-Related Macros

Macro	Description
Dataset version overview	Provides a general summary of your dataset.
Dataset version columns description	Displays a table of your dataset's columns with key statistics.
Dataset version comparison	Compares a new dataset to a reference dataset.
Dataset version lineage comparison	Compares the evolution of a dataset to its input dataset within the lineage.

Project Information Macros

Use project macro to enter key project details, such as objectives, timelines, and team members. This makes it easy to onboard new team members and provides a quick project overview for stakeholders.

Example Usage: At the start of the project documentation, use the Project Information Macro to set up the project’s essential information, ensuring everyone has a clear understanding of the project’s scope and goals.

Macro	Description
Project info	Inserts your project's details and description.
Project structure	Displays an overview of your project's structure.
Project title	Displays the title of your project.

Phase Details Macros

Document phase-specific information to track the progress and current status of each project phase. This macro ensures each phase update includes relevant, consistent information.

Example Usage: Use the Insert Phase Content macro to automatically add phase details—like status and deliverables—into the final model report for seamless documentation.

Macro	Description
Insert phase content	Inserts information from your project's phase documentation.
Phases pages	Lists or displays pages related to different project phases.

Additional or Specific Macros

These macros offer specialized functionality for enhanced documentation.

Macro	Description
MDD Header	Adds a structured header table to the model development document for organized reporting.

Macro requirements

Note: Some macros have requirements to work properly. For example, the "Insert phase content" macro requires content in the selected phase to display information.

Here are a few examples of macro requirements and tips to ensure you have the necessary information for proper macro use:

Insert phase content

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.

Project info

This Macro requires a project description. To add a description, go to your project settings and add a description.

Model intent

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 adding a description.

Model version summary

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.

Model properties

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.

Model version description

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.

Model performance

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.

Model feature importance

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.