Tutorial
Get ramped up quickly with Vectice by walking through the Tutorial project.
If you need access to the latest tutorial, jump to the How to access the latest tutorial section.
The tutorial project is located in your personal workspace. It provides step-by-step instructions to guide you through the iterative development methodology in Vectice.
Before starting the tutorial, you should watch our Vectice Introduction video for a brief overview of Vectice.
What will you do in the tutorial?
Each phase on the left menu of the Tutorial project has an instruction section written in blue for you to follow. Some of the actions you would complete include:
Create a new iteration and log your first model version using the Vectice API in a notebook environment. You will find this part of the tutorial in the Modeling phase.
Access and display the list of model versions to evaluate your models and find model lineage and metadata.
Leverage the documentation features of Vectice to document and report your findings by inserting a supporting graph about the performance of your selected model version. You will find this part of the tutorial in the Evaluation phase.
What will you learn?
Completion of the tutorial will take about 10 to 20 minutes. After completing the tutorial, you will learn how:
Data scientists can leverage Vectice Python APIs to log key models, datasets, and code in a few lines of code
Managers can structure the team's work using phases, steps, and iterations
Data scientists can auto-document model data and metadata within a data science project
How to access your tutorial?
As a Vectice user, you will have access to a personal workspace. The name of your personal workspace is the first part of your email address used with your Vectice account. For example, if your email address isasmith@email.com,
your personal workspace is named .asmith.
Follow these steps to access your tutorial project:
Select your personal workspace.
On the Projects page, select "Tutorial Project: Forecast in-store unit sales (23.1)".
To begin the tutorial, select the first phase "📚 Tutorial Instructions".
Read the documentation of the tutorial instructions for a walk-through of how to utilize Vectice with a sample project.
How to access the latest tutorial?
If you do not have the latest tutorial, create a Sample Tutorial Project to access the latest tutorial guide. You can create a Sample Tutorial Project by completing the following:
Select the workspace where you want to create a new Tutorial project.
On the Projects page, select Create Project.
Enter a name for your tutorial project, add a description (optional), and choose Create Sample Tutorial Project.
You can always create a new tutorial project to get the latest version.
If you are interested in the Python API tutorial, we have prepared Colab Notebooks that you can use to become acquainted with the Vectice Python API where you can:
Experience the data science lifecycle using Vectice
See how simple it is to connect your notebook to Vectice
Learn how to structure and log your work using Vectice
Let's get started by selecting one of the API notebooks below!
1️⃣ Data Understanding Notebook
This tutorial provides an example of an iteration and related steps in a data understanding phase.
2️⃣ Data Preparation Notebook
This tutorial provides an example of an iteration and related steps in a data preparation phase.
3️⃣ Modeling Notebook
This tutorial provides an example of an iteration and related steps in a modeling phase.
🎉You're all set!
Last updated