Vectice Docs
API Reference (Latest)Vectice WebsiteStart Free Trial
Latest
Latest
  • 🏠Introduction
    • Vectice overview
      • Autolog
      • Next-Gen Autolog [BETA]
      • AskAI
      • Vectice for financial services
  • 🏁Quickstart
    • Getting started
    • Quickstart project
    • Tutorial project
    • FAQ
  • ▶️Demo Center
    • Feature videos
  • 📊Manage AI/ML projects
    • Organize workspaces
      • Create a workspace
      • Workspace Dashboard
    • Organize projects
      • Create a project
      • Project templates best practices
    • Invite colleagues
    • Define phase requirements
    • Collaborate with your team
  • 🚀Log and Manage Assets with Vectice API
    • API cheatsheets
      • Vectice Python API cheatsheet
      • Vectice R API cheatsheet
    • Connect to API
    • Log assets to Vectice
      • Autolog your assets
      • Log datasets
      • Log models
      • Log attachments and notes
      • Log code
      • Log a custom data source
      • Log assets using Vectice IDs
      • Log dataset structure and statistics
      • Log custom metadata in a table format
      • Log MLFLow runs
    • Retrieve assets from app
    • Manage your assets
    • Manage your iteration
    • Preserve your code and asset lineage
  • 🤝Create Model documentation and reports
    • Create model documentation with Vectice Reports
    • Streamline documentation with Macros
    • Auto-document Models and Datasets with AskAI Prompts
    • Document phase outcomes
  • 🗂️Admin Guides
    • Organization management
    • Workspace management
    • Teams management
    • User management
      • User roles and permissions
      • Update a user role in your organization
      • Activate and deactivate users
      • Reset a user's password
    • Manage report templates
  • 🔗Integrations
    • Integrations Overview
    • Integrate Vectice with your data platform
  • 💻IT & Security
    • IT & Security Overview
    • Secure Evaluation Environment Overview
    • Deployment
      • SaaS offering (Multi-Tenant SaaS)
      • Kubernetes self-hosted offering
        • General Architecture & Infrastructure
        • Kubernetes on GCP
          • Appendices
        • Kubernetes on AWS
          • Appendices
        • Kubernetes on Azure
          • Appendices
        • GCP Marketplace deployment
        • On premise
        • Configuration
      • Bring Your Own LLM Guide
    • Data privacy
    • User management
    • SSO management
      • Generic SAML integration
      • Okta SSO integration
    • Security
      • Data storage security
      • Network Security
        • HTTPS communication
        • Reverse proxy
        • CORS/CSRF
        • VPC segregation
      • Sessions
      • Secrets and certificates
      • Audit logs
      • SOC2
      • Security updates
      • Best practices
      • Business continuity
    • Monitoring
      • Installation guide
      • Customizing the deployments
    • Maintenance & upgrades
    • Integrating Vectice Securely
  • ⭐Glossary
    • Concepts
      • Workspaces
      • Projects
        • Setup a project
      • Phases
      • Iterations
        • Iterative development
      • Datasets
        • Dataset resources
        • Dataset properties
        • Dataset lineage and versions
      • Models
      • Reports
  • 🎯Release notes
    • Release notes
  • ↗️References
    • Vectice Python API Reference
    • Vectice R API Cheatsheet
    • Notebooks and code samples
    • Vectice website
Powered by GitBook
On this page
  • Model artifacts in Vectice
  • Models best practices
  • How to log models to Vectice?

Was this helpful?

  1. Glossary
  2. Concepts

Models

Learn more about Models within Vectice.

Models reflect the model metadata logged to Vectice during model development. All models are versioned and tagged with their deployment environment within Vectice.

Model artifacts in Vectice

Below is a list of artifacts you can find in the Vectice app after data scientists log the models artifacts from their iterative development.

Artifacts
Description

Model snapshot

Highlights the number of model versions grouped by model status.

Model Status

The model status states whether the model is in Production, Staging, or Experimentation mode.

Model creation details

Creation details show when the model was created and who it was created by.

Model type

Classifies the model by model type. For example, clustering, classification, or regression.

Technique

The technique highlights the exact modeling algorithm used for the model. (i.e., Linear Regression)

Model lineage

The model lineage can showcase the dataset used for the model, the code captured from git and the model version output.

Model metrics

The model metrics captures metrics used to evaluate model performance. (i.e., MAE and RSME values)

Versions

Models with the same name as another model you already logged in Vectice. As you log models with the same name, the versions are incremented, maintaining the model's history.

Attachments

Attachments showcase files that were logged with the model. For example, this could be notebooks, images, or excel sheets of data analysis, model results, etc. All file types are supported for model attachments and can be downloaded from the Vectice app.

However, the supported previews types in the Vectice app are PNG, JPEG, CSV, Notebook, and TXT files.

Models best practices

  • Project phases that aim to train, test, or validate models should have iteration sections to log the models accordingly. This is typically completed in the Modeling phase of a CRISP-DM project.

  • Mark your most valuable iterations and assets in the Vectice app by selecting the star next to the corresponding iteration and assets before beginning the phase review. This will make it easier for stakeholders and subject matter experts to identify the iterations and assets in review.

Select the star next to the valuable iterations before completing a phase, even without review. This allows you to identify the most valuable iterations for that phase.

How to log models to Vectice?

PreviousDataset lineage and versionsNextReports

Last updated 5 months ago

Was this helpful?

View our guide for more information on logging models during iterative development.

⭐
How to log models