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
  • Use Widgets to Highlight Key Asset Elements
  • Streamline Documentation with AskAI and Macros

Was this helpful?

  1. Create Model documentation and reports

Document phase outcomes

PreviousAuto-document Models and Datasets with AskAI PromptsNextOrganization management

Last updated 6 months ago

Was this helpful?

Documenting phase outcomes is about summarizing what you've achieved and what improvements may come after completing each phase. It's crucial for understanding each project phase and presenting this info to stakeholders and decision-makers.

How you explain and present results can impact your company's decisions, so be clear and thorough to validate your conclusions.

Here are some suggestions to consider while summarizing the phase outcome:

  • Check if the model meets the business success criteria.

  • Review and document the work done in each iteration.

  • Decide if there's a need for future improvements, iterations, or new projects based on the phase.

Use Widgets to Highlight Key Asset Elements

Widgets allow you to display specific elements from your logged assets, such as lineage, metrics (for models), properties, or attachments. By default, all dataset or model version artifacts are included, but you can customize the widget to focus on what's most relevant as your project evolves.

When adding a dataset or model to your phase documentation, select "Customize widget" to tailor the displayed artifacts to your needs. Note that you must choose a specific version of the asset to customize its widget.

Streamline Documentation with AskAI and Macros

Use AskAI and Macros in the documentation editor to quickly gather and document essential information. These tools allow you to pull in logged metadata—like iterations, datasets, and models used—making it easy to create thorough, accurate summaries without extra manual entry.

To learn more about using AskAI and Macros, check out the following guides:

🤝
Auto-document models with AskAI
Streamline documentation with Macros