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
  • Log attachments and notes
  • Dataset attachments
  • Model attachments
  • Add attachments to phase documentation in Vectice app
  • #1 Add attachments from iterations, datasets, or models
  • #2 Add attachments uploaded from your computer

Was this helpful?

  1. Log and Manage Assets with Vectice API
  2. Log assets to Vectice

Log attachments and notes

When exploring assets or creating analyses, adding attachments can be helpful in showcasing charts and data. To add an attachment, log it directly to your iteration.

Log attachments and notes

To log an image and note to an iteration, use the following:

# Log an image to an iteration
iteration.log("path/data_analysis_chart.png")

# Log a note to an iteration
iteration.log("This is a good model output.")

You can have multiple images and notes for each iteration.

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 log the dataset and its attachments to the Vectice app, simply log them to your current iteration:

iteration.log(origin_dataset)

Model attachments

from vectice import Model

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 log the model and its attachments to the Vectice app:

iteration.log(model)

Add attachments to phase documentation in Vectice app

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

#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.

PreviousLog modelsNextLog code

Last updated 1 year ago

Was this helpful?

🚀