[DEV] VESSL Docs
  • Welcome to VESSL Docs!
  • GETTING STARTED
    • Overview
    • Quickstart
    • End-to-end Guides
      • CLI-driven Workflow
      • SDK-driven Workflow
  • USER GUIDE
    • Organization
      • Creating an Organization
      • Organization Settings
        • Add Members
        • Set Notifications
        • Configure Clusters
        • Add Integrations
        • Billing Information
    • Project
      • Creating a Project
      • Project Overview
      • Project Repository & Project Dataset
    • Clusters
      • Cluster Integrations
        • Fully Managed Cloud
        • Personal Laptops
        • On-premise Clusters
        • Private Cloud (AWS)
      • Cluster Monitoring
      • Cluster Administration
        • Resource Specs
        • Access Control
        • Quotas and Limits
        • Remove Cluster
    • Dataset
      • Adding New Datasets
      • Managing Datasets
      • Tips & Limitations
    • Experiment
      • Creating an Experiment
      • Managing Experiments
      • Experiment Results
      • Distributed Experiments
      • Local Experiments
    • Model Registry
      • Creating a Model
      • Managing Models
    • Sweep
      • Creating a Sweep
      • Sweep Results
    • Workspace
      • Creating a Workspace
      • Exploring Workspaces
      • SSH Connection
      • Downloading / Attaching Datasets
      • Running a Server Application
      • Tips & Limitations
      • Building Custom Images
    • Serve
      • Quickstart
      • Serve Web Workflow
        • Monitoring Dashboard
        • Service Logs
        • Service Revisions
        • Service Rollouts
      • Serve YAML Workflow
        • YAML Schema Reference
    • Commons
      • Running Spot Instances
      • Volume Mount
  • API REFERENCE
    • What is the VESSL CLI/SDK?
    • CLI
      • Getting Started
      • vessl run
      • vessl cluster
      • vessl dataset
      • vessl experiment
      • vessl image
      • vessl model
      • vessl organization
      • vessl project
      • vessl serve
      • vessl ssh-key
      • vessl sweep
      • vessl volume
      • vessl workspace
    • Python SDK
      • Integrations
        • Keras
        • TensorBoard
      • Utilities API
        • configure
        • vessl.init
        • vessl.log
          • vessl.Image
          • vessl.Audio
        • vessl.hp.update
        • vessl.progress
        • vessl.upload
        • vessl.finish
      • Dataset API
      • Experiment API
      • Cluster API
      • Image API
      • Model API
        • Model Serving API
      • Organization API
      • Project API
      • Serving API
      • SSH Key API
      • Sweep API
      • Volume API
      • Workspace API
    • Rate Limits
  • TROUBLESHOOTING
    • GitHub Issues
    • VESSL Flare
Powered by GitBook
On this page
  • Key Metrics
  • Sample Media
  • Starred Experiment
  • Project Notes
  1. USER GUIDE
  2. Project

Project Overview

PreviousCreating a ProjectNextProject Repository & Project Dataset

Last updated 3 years ago

Project Overview provides a bird's-eye view of the progress of your machine learning projects. On the project overview dashboard, you can manage and track key information about your project:

  • Key Metrics: Keep track of essential evaluation metrics of your experiments such as accuracy, loss, and MSE.

  • Sample Media: Log images, audio, and other media from your experiment and explore your model's prediction results to compare your experiments visually.

  • Starred Experiments: Star and keep track of meaningful experiments.

  • Project Notes: Make a note of important information about your project and share it with your teammates – similar to README.md of Git codebase.

Key Metrics

VESSL AI automatically marks metrics of best-performing experiments as key metrics. You can also manually bookmark key metrics and keep track of your model's meaningful evaluation metrics.

To add or remove Key Metrics

2. Select up to 4 metrics and choose whether your goal is to minimize or maximize the target value.

  • If you select Minimize, an experiment with the smallest target value will be updated to the key metric charts.

  • If you select Maximize, an experiment with the greatest target value will be updated to the key metric chart.

Sample Media

You can log images or audio clips generated from your experiment to explore your model's prediction results and make visual (or auditory) comparisons.

To see the media file, select an experiment and specify the media type using the dropdown menu on the upper right corner of Sample Media card.

Starred Experiment

You can mark important experiments as Starred Experiments to keep track of meaningful achievements in the project. Starred Experiments displayed with the tags and key metrics.

To star or unstar experiments

  1. Go to the experiment tracking dashboard

  2. Select experiments

  3. Click 'Star' or 'Unstar' on the dropdown menu.

You can also star or unstar experiments on the experiment summary page.

Project Notes

Project Notes is a place for noting and sharing important information about the project together with your team. It works like README.md of your Git codebase.

Click the settings icon() on top of the Key Metrics card.

For more information about logging media during your experiment, refer to in our Python SDK.

To modify project note, click the settings icon() on top of Project Notes card. You will be given a markdown editor to update your notes.

vessl.log