Add Attachments and Comments

When exploring assets or creating analyses, adding attachments can be helpful in showcasing charts and data. To add an attachment, assign it directly to your step or use the attachement parameter in the provided methods to attach a file.

Step attachments and comments

To attach an image and comment to a step, use the following:

# Attach an image to a step
my_iteration.step_attach_charts = "path/data_analysis_chart.png"

# To add more images, use the += operator
my_iteration.step_attach_charts += "path/regression_chart.png"

# Add a comment to a step
my_iteration.step_model_output = "This is a good model output."

# To add more comments, use the += operator
my_iteration.step_model_output += "We will proceed with the regression model."

You can have multiple images and comments for each step.

Dataset attachments

from vectice import Dataset, FileResource

origin_dataset = Dataset.origin(name="performance ds", resource=FileResource(paths="./perfs.csv"), attachments=["attachment1.png", "attachment2.png"])

To register the dataset and its attachments to the Vectice UI, simply assign them to your current iteration step for registration.

my_iteration.step_register_dataset = origin_dataset

Model attachments

from vectice import Model

my_model = Model(name="Unit Sales Predictor", library="scikit-learn", technique="linear regression", metrics=metrics, attachments="regression_graph.png")

To complete the process, you need to register the model and its attachments to the Vectice UI by assigning them to your current iteration step.

my_iteration.step_build_model = my_model

Add attachments to phase documentation in UI

There are two ways to add attachments to your phase documentation in the Vectice UI.

#1 Add attachments from iterations, datasets, or models

The gif below shows how you could add attachments from your assets. This workflow is the same for adding attachments from iterations, datasets, and models.

#2 Add attachments uploaded from your computer

You can also upload attachments to your phase documentation from your computer. To do so, select Insert > Image > Add an Image in the phase documentation, then select and upload your image from your files.