Skip to content

Source code for the ZenML Interactive Tutorial VS Code Extension - a hands-on learning experience with 10 guided pipeline examples to help users master ZenML fundamentals.

License

Notifications You must be signed in to change notification settings

zenml-io/vscode-tutorial-extension

Repository files navigation

Welcome to the ZenML Interactive Tutorial Extension 👋

This VS Code extension provides an interactive, hands-on learning experience for ZenML - the open-source MLOps framework. Master ZenML fundamentals through 10 guided pipeline examples with step-by-step tutorials and one-click execution!

Welcome page screenshot

✨ What You'll Learn

  • Pipeline Fundamentals - Create your first ZenML pipeline
  • Data Flow - Pass data between pipeline steps
  • Parameters - Make pipelines flexible with parameters
  • Organization - Tag and organize your pipeline runs
  • Tracking - Log metadata to record useful facts about runs
  • Visualizations - Create automatic & custom charts
  • Performance - Use caching and parallel processing
  • Reliability - Handle errors with retries and hooks
  • Configuration - Use YAML to separate configuration from code

10 Progressive Tutorials that build from basic concepts to advanced ZenML patterns.

Architecture

🚀 Get Started

GitHub Codespaces (Recommended)

The fastest way to get started - no local setup required.

  1. Click Code ▶ Codespaces ▶ Create codespace on develop
  2. Wait ~2 min for setup (container, dependencies, extension)
  3. The extension will launch automatically

💻 Alternative: Local Setup

Requirements:

Steps:

  1. Clone this repo & open in VS Code
  2. Click Reopen in Container when prompted
  3. Extension starts automatically

🎓 Tutorial Structure

Tutorial Topic Skills
1 Hello World Basic pipeline creation
2 Step I/O Data flow between steps
3 Parameters Pipeline configuration
4 Tagging Run organization
5 Metadata Logging and tracking
6 Caching Performance optimization
7 Visualizations Charts and plots
8 Fan-out/Fan-in Parallel processing
9 Retries & Hooks Error handling
10 YAML Config Configuration management

🎮 How to Use

  • Run pipelines via the “Run Pipeline” button
  • Navigate with Previous/Next buttons
  • Inspect output in the terminal and Dashboard link
  • Experiment by editing any example code

🛟 Getting Help

About

Source code for the ZenML Interactive Tutorial VS Code Extension - a hands-on learning experience with 10 guided pipeline examples to help users master ZenML fundamentals.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8