Vectice Docs
API Reference (Latest)Vectice WebsiteStart Free Trial
24.4
24.4
  • 🏠Introduction
    • Vectice overview
      • Autolog
      • 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
    • Define phase requirements
    • Invite colleagues
    • 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
    • Auto-document models with AskAI
    • Streamline documentation with Macros
    • Create model documentation with Vectice Reports
    • Document phase outcomes
  • 🗂️Admin Guides
    • Organization management
    • Workspace management
    • User management
      • User roles and permissions
      • Update a user role in your organization
      • Activate and deactivate users
      • Reset a user's password
  • 🔗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
    • 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
  • 'Ask Me Anything' example prompts
  • Summarize model
  • Compare models
  • Compare datasets
  • Explain model
  • Customize your own prompt
  1. Create Model documentation and reports

Auto-document models with AskAI

PreviousPreserve your code and asset lineageNextStreamline documentation with Macros

AskAI enables data scientists to automatically document their work using AI. Users can generate documentation for iterations, models, or datasets or use the "Ask me anything" feature to prompt AI for custom documentation.

Use "AskAI" to generate documentation directly from your iterations or assets. This feature provides a straightforward way to document your work quickly, ensuring that all necessary details are captured without added effort.

Simply select AskAI and then choose your iterations or assets. AskAI will help you create clear and concise documentation for your projects. You can also use the "Ask Me Anything" feature to produce customized documentation based on your prompts, tailoring the content to meet your needs.

'Ask Me Anything' example prompts

Click the AskAI button, then select Ask Me Anything. Use the following prompt examples to generate asset documentation.

To generate documentation based on your assets and phases, use AskAI's "Ask me anything" feature and use the / character to select the desired assets or phrases.

Summarize model

The following AI prompt will summarize your model's architecture, parameters, and performance metrics.

Generate a summary of the model {{ MDV-XXX }}.

Compare models

The following AI prompt will generate a detailed comparison of multiple models, highlighting differences in technique, training data, and results.

Compare the following models {{ MDV-XXX }} and {{ MDV-YYY }}. Focus on differences in their techniques, training data, and performance outcomes.

Compare datasets

The following AI prompt will generate a comparative analysis of various datasets, focusing on key attributes, data distribution, and suitability for different models.

Compare these datasets {{ DTV-XXX }} and {{ DTV-YYY }} by analyzing their key attributes, data distribution, and suitability for model {{ MDV-XXX }}.

Explain model

The following AI prompt will comprehensively explain your model's functioning, including feature importance and decision-making processes.

Explain the functioning of the model {{ MDV-XXX }} along with its feature importance and decision-making processes.

Customize your own prompt

You can even customize a prompt to help you create specific documentation tailored to your needs.

Document the latest model's performance on the validation set compared to the previous model {{ MDV-XXX }}.
🤝