In the first part of this QuickStart, we will re-use the classical Iris modeling example to demonstrate how you can automatically document your assets, such as datasets, models, graphs, and comments, using a few lines of code from your favorite notebook environment.
In the second part of this QuickStart, we will demonstrate how you can easily access and combine the assets you've captured from your notebook to create a comprehensive documentation summary with just a few clicks from the Vectice UI.
Before you run the QuickStart Python notebook, we need to decide the project and the phase where we want to document our work. This will ensure your work is captured within the right context and easily accessible for future reference.
For the purpose of this QuickStart example, we will be using the QuickStart (xx/xx/xxxx) that was automatically added to your personal workspace when you created your account.
Refer to the Navigate Vectice Application section If unsure how to navigate to your personal workspace.
Open the QuickStart project and click on the To Do Phase, then copy the Phase Id from the UI as shown below.
We will use this Phase Id in the QuickStart notebook to indicate where to log your work.
Below, you will find our QuickStart sample notebook available for download from our GitHub public repo. You can use this notebook from your preferred Python environment. Alternatively, if you prefer to run the notebook in a hosted environment, we also provide the same notebook in Colab for your convenience.
To use the sample notebooks, please replace "my_api_token" at the top of the notebook with your API key. If you have lost your API Token, open the JSON file you downloaded on the previous page to retrieve the key or create a new token by following the instruction on the "Create an API Token" page in the left menu under GETTING STARTED.
QuickStart Notebook in Colab:
QuickStart Notebook Downloadable from GitHub:
The QuickStart notebook demonstrates how to use Vectice APIs to log a dataset, a model, a graph and a comment inside a project phase.
We recommend you follow the instructions in the notebook and come back here once you have completed the notebook execution.
Let's navigate back to the To Do Phase of your QuickStart project.
By logging your work using the Vectice APIs, Vectice has automatically generated detailed documentation within the last iteration of the To Do Phase. To find the page, select the To Do Phase > Iteration > Iteration 1.
This should look similar to the QuickStart Completed phase, whose Iteration 1 was already completed, as seen below.
If you don't see the created items, you can try to refresh the page or go to your home to see your latest API activities and make sure you are looking at the right phase.
This auto-generated iteration documentation ensures that your progress and contributions are captured with minimum effort allowing for easy reference and review.
Vectice provides widgets that streamline documenting asset details in machine-learning projects at each phase.
Widgets help visualize asset lineage, compare metrics across model versions, and integrate visualizations logged from your notebooks.
In the rest of this section, we will illustrate how to leverage those widgets to update your To Do Phase documentation.
Navigate to the phase documentation by clicking the "To Do Phase" on the left menu.
On the documentation page, click on the Add iteration widget, select the last iteration you logged from the QuickStart notebook, then click Insert, as illustrated below.
On the documentation page, click the Add a Dataset button, select the Dataset > Version > Attachment you want to add to the report, then click Insert, as illustrated below.
On the documentation page, click the Add Model button, select the model version you want to add to the report, then click Insert, as illustrated below.
The end result is a simplified and always up-to-date documentation experience that saves you valuable time and effort to document, review and share knowledge with your team.
To keep learning more about how to organize phases within your project and more in-depth concepts, go to the next page to follow the more advanced Tutorial Project.
If you would like to invite your colleagues you can skip ahead to the Invite your Colleagues section and come back to the tutorial page right after.
Congrats! You now have learned how to effortlessly log your work and assets from your favorite notebook environment and generate extensive documentation in a few clicks with Vectice pre-defined widgets.
