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
  • Accessing the Tutorial
  • What to expect?
  • Want to Discover More?
  1. Quickstart

Tutorial project

PreviousQuickstart projectNextFAQ

The tutorial is designed to guide you through creating project documentation with ease and efficiency. Whether you’re new to the platform or looking to enhance your workflow, this tutorial highlights best practices for generating documentation and using key features within the system.

By following this tutorial, you will:

  • Learn to create and customize documentation with Macros for fast, automated documentation.

  • Refine your documentation effortlessly using Ask AI for suggestions and missing sections.

  • Understand how to manage and execute project requirements.

  • Navigate the simplified user interface for a seamless experience.

  • Use built-in guidance tools, including progress tracking and AskAI prompts, to complete your documentation faster.

Accessing the Tutorial

To access the tutorial in the app navigate to your personal workspace and select the Tutorial project.

What to expect?

In the tutorial, you will follow these steps to get your model development document in no time.

  1. Review the Requirements to understand what's needed in your notebook to easily document your work.

  2. Access the pre-defined Notebook () and run it to generate asset metadata.

  3. Go to the Documentation tab and use the Macro console in the outline to auto-document your model.

  4. Review the output and add sections where needed using AskAI for quick improvements.

Once complete, your document is ready for sharing or export!

Want to Discover More?

Watch the covering templates, guidance tools, and progress tracking for a detailed walkthrough. If you need additional support, contact us at support@vectice.com.

🏁
Feature Videos
here