Skip to content

Commit 155064d

Browse files
strickvlclaude
andcommitted
Remove h1 headers from tutorial markdown files
Removed the h1 headers and top-level descriptions from all tutorial markdown files to avoid duplication with the tutorial header display in the VSCode extension. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent aff6bae commit 155064d

File tree

10 files changed

+17
-44
lines changed

10 files changed

+17
-44
lines changed

pipelines/caching/caching.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Caching - Smart Re-runs
2-
3-
Learn how ZenML's caching system can save you time by avoiding redundant computations.
4-
51
## What you'll learn
62

73
- How to enable caching on steps
@@ -28,4 +24,5 @@ def slow_step() -> Annotated[int, "answer"]:
2824

2925
## Try it yourself
3026

31-
Run this pipeline twice! The first run takes ~3 seconds, the second is instant thanks to caching.
27+
Run this pipeline twice! The first run takes ~3 seconds, the second is instant
28+
thanks to caching.

pipelines/fanOut/fanOut.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Fan-out/Fan-in - Parallel Processing
2-
3-
Learn how to create parallel workflows that split work across multiple steps and then combine the results.
4-
51
## What you'll learn
62

73
- How to create parallel processing patterns
@@ -29,4 +25,5 @@ def fan_pipeline(parallel: int = 4):
2925

3026
## Try it yourself
3127

32-
Run this pipeline to see how it processes data in parallel across multiple steps, then combines the results!
28+
Run this pipeline to see how it processes data in parallel across multiple
29+
steps, then combines the results!

pipelines/helloWorld/helloWorld.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Hello World - Steps & Pipelines
2-
31
Welcome to your first ZenML pipeline! This tutorial introduces the fundamental concepts of **steps** and **pipelines**.
42

53
## What you'll learn
@@ -30,4 +28,5 @@ def hello_pipeline():
3028

3129
## Try it yourself
3230

33-
Click the **Run Pipeline** button to execute your first ZenML pipeline and see the output!
31+
Click the **Run Pipeline** button to execute your first ZenML pipeline and see
32+
the output!

pipelines/metadata/metadata.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Metadata - Recording Useful Facts
2-
3-
Learn how to log metadata to track important information about your pipeline runs.
4-
51
## What you'll learn
62

73
- How to use `log_metadata()` to record key information
@@ -29,4 +25,4 @@ def compute_accuracy() -> Annotated[float, "accuracy_metric"]:
2925

3026
## Try it yourself
3127

32-
Run this pipeline and check the ZenML dashboard to see the metadata card!
28+
Run this pipeline and check the ZenML dashboard to see the metadata card!

pipelines/parameters/parameters.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Parameters - Configurable Behavior
2-
3-
Learn how to make your pipelines configurable with parameters.
4-
51
## What you'll learn
62

73
- How to add parameters to steps and pipelines
@@ -31,4 +27,4 @@ def param_pipeline(number: int = 3, factor: int = 2):
3127

3228
## Try it yourself
3329

34-
Run this pipeline to see how parameters control the multiplication operation!
30+
Run this pipeline to see how parameters control the multiplication operation!

pipelines/retries/retries.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Retries & Hooks - Robust Pipelines
2-
3-
Learn how to build resilient pipelines that can handle failures gracefully with automatic retries and hooks.
4-
51
## What you'll learn
62

73
- How to configure automatic retries for flaky steps
@@ -32,4 +28,5 @@ def flaky() -> Annotated[str, "result"]:
3228

3329
## Try it yourself
3430

35-
Run this pipeline multiple times! Sometimes it succeeds immediately, sometimes it needs retries to handle the random failures.
31+
Run this pipeline multiple times! Sometimes it succeeds immediately, sometimes
32+
it needs retries to handle the random failures.

pipelines/stepIO/stepIO.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Step I/O - Typed Inputs and Outputs
2-
3-
Now let's learn how to pass data between steps with proper type annotations.
4-
51
## What you'll learn
62

73
- How to define typed step outputs using `Annotated` types
@@ -37,4 +33,5 @@ def count_rows(
3733

3834
## Try it yourself
3935

40-
Run this pipeline to see how data flows from the `load_data` step to the `count_rows` step!
36+
Run this pipeline to see how data flows from the `load_data` step to the
37+
`count_rows` step!

pipelines/tagging/tagging.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Tagging - Keep Runs Organized
2-
3-
Learn how to use tags to organize and categorize your pipeline runs.
4-
51
## What you'll learn
62

73
- How to add simple tags to pipelines
@@ -27,4 +23,5 @@ def tagged_pipeline():
2723

2824
## Try it yourself
2925

30-
Run this pipeline multiple times and watch how the exclusive tag automatically moves to the latest run!
26+
Run this pipeline multiple times and watch how the exclusive tag automatically
27+
moves to the latest run!

pipelines/visualizations/visualizations.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Visualizations - Custom Charts
2-
3-
Learn how to create automatic and custom visualizations that appear in the ZenML dashboard.
4-
51
## What you'll learn
62

73
- How ZenML automatically visualizes common data types
@@ -32,4 +28,5 @@ def scatter(df: pd.DataFrame) -> Annotated[HTMLString, "scatter_plot"]:
3228

3329
## Try it yourself
3430

35-
Run this pipeline and check the dashboard to see both the automatic DataFrame visualization and the custom scatter plot!
31+
Run this pipeline and check the dashboard to see both the automatic DataFrame
32+
visualization and the custom scatter plot!

pipelines/welcome/welcome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div class="two-column-content">
22
<div class="left-column">
33

4-
# Welcome to ZenML Interactive Tutorial!
4+
# Welcome to the ZenML Interactive Tutorial!
55

66
This hands-on tutorial will teach you **ZenML fundamentals** through 10 progressive lessons. Each lesson introduces exactly **one new concept** with copy-paste code examples.
77

0 commit comments

Comments
 (0)