Skip to content

Commit 9397746

Browse files
refactor Components / Kubeflow Pipelines section (#3063)
* refactor pipelines section * fix links & move "introduction" to root * revert rename of "TFX Compatibility Matrix"
1 parent e7f5353 commit 9397746

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+134
-124
lines changed

content/en/_redirects

+10
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,16 @@ docs/started/requirements/ /docs/started/getting-started/
167167
/docs/components/notebooks/troubleshoot /docs/components/notebooks/troubleshooting
168168
/docs/components/notebooks/why-use-jupyter-notebook /docs/components/notebooks/overview
169169

170+
# Refactor Pipelines section
171+
/docs/components/pipelines/caching /docs/components/pipelines/overview/caching
172+
/docs/components/pipelines/caching-v2 /docs/components/pipelines/overview/caching-v2
173+
/docs/components/pipelines/multi-user /docs/components/pipelines/overview/multi-user
174+
/docs/components/pipelines/pipeline-root /docs/components/pipelines/overview/pipeline-root
175+
/docs/components/pipelines/pipelines-overview /docs/components/pipelines/introduction
176+
/docs/components/pipelines/pipelines-quickstart /docs/components/pipelines/overview/quickstart
177+
/docs/components/pipelines/overview/concepts/* /docs/components/pipelines/concepts/:splat
178+
/docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat
179+
170180
# ===============
171181
# IMPORTANT NOTE:
172182
# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
title = "Concepts"
3+
description = "Concepts used in Kubeflow Pipelines"
4+
weight = 30
5+
+++

content/en/docs/components/pipelines/overview/concepts/component.md content/en/docs/components/pipelines/concepts/component.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ deserialize the data for use in the downstream component.
5757

5858
## Next steps
5959

60-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
61-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
60+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
61+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
6262
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
6363
Pipelines UI.
6464
* Build your own

content/en/docs/components/pipelines/overview/concepts/experiment.md content/en/docs/components/pipelines/concepts/experiment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ weight = 40
88
An *experiment* is a workspace where you can try different configurations of
99
your pipelines. You can use experiments to organize your runs into logical
1010
groups. Experiments can contain arbitrary runs, including
11-
[recurring runs](/docs/components/pipelines/overview/concepts/run/).
11+
[recurring runs](/docs/components/pipelines/concepts/run/).
1212

1313
## Next steps
1414

15-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
16-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
15+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
16+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
1717
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
1818
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/graph.md content/en/docs/components/pipelines/concepts/graph.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parent contains a conditional clause.)
2424

2525
## Next steps
2626

27-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
28-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
27+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
28+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2929
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
3030
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/output-artifact.md content/en/docs/components/pipelines/concepts/output-artifact.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ data to rich interactive visualizations.
1515

1616
## Next steps
1717

18-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
19-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
18+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
19+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2020
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2121
Pipelines UI.
2222
* Read more about the available

content/en/docs/components/pipelines/overview/concepts/pipeline.md content/en/docs/components/pipelines/concepts/pipeline.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ weight = 10
66
+++
77

88
A *pipeline* is a description of a machine learning (ML) workflow, including all
9-
of the [components](/docs/components/pipelines/overview/concepts/component/) in the workflow and how the components relate to each other in
10-
the form of a [graph](/docs/components/pipelines/overview/concepts/graph/). The pipeline
9+
of the [components](/docs/components/pipelines/concepts/component/) in the workflow and how the components relate to each other in
10+
the form of a [graph](/docs/components/pipelines/concepts/graph/). The pipeline
1111
configuration includes the definition of the inputs (parameters) required to run
1212
the pipeline and the inputs and outputs of each component.
1313

1414
When you run a pipeline, the system launches one or more Kubernetes Pods
15-
corresponding to the [steps](/docs/components/pipelines/overview/concepts/step/) (components) in your workflow (pipeline). The Pods
15+
corresponding to the [steps](/docs/components/pipelines/concepts/step/) (components) in your workflow (pipeline). The Pods
1616
start Docker containers, and the containers in turn start your programs.
1717

1818
After developing your pipeline, you can upload your pipeline using the Kubeflow Pipelines UI or the Kubeflow Pipelines SDK.
1919

2020
## Next steps
21-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
22-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
21+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
22+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2323
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2424
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/run-trigger.md content/en/docs/components/pipelines/concepts/run-trigger.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ available:
1515

1616
## Next steps
1717

18-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/overview/pipelines-overview/).
19-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
18+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
19+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
2020
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
2121
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/run.md content/en/docs/components/pipelines/concepts/run.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ output artifacts, and logs for each step in the run.
1515
A *recurring run*, or job in the Kubeflow Pipelines [backend APIs](https://github.com/kubeflow/pipelines/tree/06e4dc660498ce10793d566ca50b8d0425b39981/backend/api/go_http_client/job_client), is a repeatable run of
1616
a pipeline. The configuration for a recurring run includes a copy of a pipeline
1717
with all parameter values specified and a
18-
[run trigger](/docs/components/pipelines/overview/concepts/run-trigger/).
18+
[run trigger](/docs/components/pipelines/concepts/run-trigger/).
1919
You can start a recurring run inside any experiment, and it will periodically
2020
start a new copy of the run configuration. You can enable/disable the recurring
2121
run from the Kubeflow Pipelines UI. You can also specify the maximum number of
@@ -25,7 +25,7 @@ triggered to run frequently.
2525

2626
## Next steps
2727

28-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
29-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
28+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
29+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
3030
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
3131
Pipelines UI.

content/en/docs/components/pipelines/overview/concepts/step.md content/en/docs/components/pipelines/concepts/step.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ an if/else like clause in the pipeline code.
1313

1414
## Next steps
1515

16-
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/pipelines-overview/).
17-
* Follow the [pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart/)
16+
* Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/).
17+
* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/)
1818
to deploy Kubeflow and run a sample pipeline directly from the Kubeflow
1919
Pipelines UI.
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Installing Pipelines"
2+
title = "Installation"
33
description = "Options for installing Kubeflow Pipelines"
4-
weight = 15
4+
weight = 35
55
+++

content/en/docs/components/pipelines/installation/choose-executor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title = "Argo Workflow Executors"
3-
description = "How to choose and configure the Argo Workflow Executor?"
4-
weight = 40
2+
title = "Choosing an Argo Workflows Executor"
3+
description = "How to choose an Argo Workflows Executor"
4+
weight = 80
55
+++
66

77
An Argo workflow executor is a process that conforms to a specific interface that allows Argo to perform certain actions like monitoring pod logs, collecting artifacts, managing container lifecycles, etc.
@@ -81,7 +81,7 @@ Pipelines test infrastructure has been running stably with the emissary executor
8181
* Cannot escape the privileges of the pod's service account.
8282
* Migration: `command` must be specified in [Kubeflow Pipelines component specification](https://www.kubeflow.org/docs/components/pipelines/reference/component-spec/).
8383

84-
Note, the same migration requirement is required by [Kubeflow Pipelines v2 compatible mode](https://www.kubeflow.org/docs/components/pipelines/sdk/v2/v2-compatibility/), refer to
84+
Note, the same migration requirement is required by [Kubeflow Pipelines v2 compatible mode](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/v2-compatibility/), refer to
8585
[known caveats & breaking changes](https://github.com/kubeflow/pipelines/issues/6133).
8686

8787
#### Migrate to Emissary Executor

content/en/docs/components/pipelines/installation/compatibility-matrix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Compatibility Matrix"
33
description = "Kubeflow Pipelines compatibility matrix with TensorFlow Extended (TFX)"
4-
weight = 50
4+
weight = 100
55
+++
66

77
## Kubeflow Pipelines Backend and TFX compatibility

content/en/docs/components/pipelines/installation/localcluster-deployment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title = "Deploying Kubeflow Pipelines on a local cluster"
3-
description = "How to deploy Kubeflow Pipelines locally with kind, K3s, and K3ai for testing purposes"
4-
weight = 30
2+
title = "Local Deployment"
3+
description = "Information about local Deployment of Kubeflow Pipelines (kind, K3s, K3ai)"
4+
weight = 20
55
+++
66

77
This guide shows how to deploy Kubeflow Pipelines standalone on a local

content/en/docs/components/pipelines/installation/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Installation Options for Kubeflow Pipelines"
2+
title = "Installation Options"
33
description = "Overview of the ways to deploy Kubeflow Pipelines"
44
weight = 10
55

content/en/docs/components/pipelines/installation/standalone-deployment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title = "Kubeflow Pipelines Standalone Deployment"
3-
description = "Instructions to deploy Kubeflow Pipelines standalone to a cluster"
4-
weight = 20
2+
title = "Standalone Deployment"
3+
description = "Information about Standalone Deployment of Kubeflow Pipelines"
4+
weight = 30
55
+++
66

77
As an alternative to deploying Kubeflow Pipelines (KFP) as part of the

content/en/docs/components/pipelines/installation/upgrade.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Upgrade Notes"
33
description = "Notices and breaking changes when you upgrade Kubeflow Pipelines Backend"
4-
weight = 35
4+
weight = 90
55
+++
66

77
This page introduces notices and breaking changes you need to know when upgrading Kubeflow Pipelines Backend.
@@ -24,4 +24,4 @@ For upgrade instructions, refer to distribution specific documentations:
2424

2525
For detailed configuration and migration instructions for both options, refer to [Argo Workflow Executors](https://www.kubeflow.org/docs/components/pipelines/installation/choose-executor/).
2626

27-
* **Notice**: [Kubeflow Pipelines SDK v2 compatibility mode](/docs/components/pipelines/sdk/v2/v2-compatibility/) (Beta) was recently released. The new mode adds support for tracking pipeline runs and artifacts using ML Metadata. In v1.7 backend, complete UI support and caching capabilities for v2 compatibility mode are newly added. We welcome any [feedback](https://github.com/kubeflow/pipelines/issues/6451) on positive experiences or issues you encounter.
27+
* **Notice**: [Kubeflow Pipelines SDK v2 compatibility mode](/docs/components/pipelines/sdk-v2/v2-compatibility/) (Beta) was recently released. The new mode adds support for tracking pipeline runs and artifacts using ML Metadata. In v1.7 backend, complete UI support and caching capabilities for v2 compatibility mode are newly added. We welcome any [feedback](https://github.com/kubeflow/pipelines/issues/6451) on positive experiences or issues you encounter.

content/en/docs/components/pipelines/overview/pipelines-overview.md content/en/docs/components/pipelines/introduction.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
2-
title = "Overview of Kubeflow Pipelines"
3-
description = "Understanding the goals and main concepts of Kubeflow Pipelines"
2+
title = "Introduction"
3+
description = "An introduction to the goals and main concepts of Kubeflow Pipelines"
44
weight = 10
55

66
+++
@@ -13,7 +13,7 @@ scalable machine learning (ML) workflows based on Docker containers.
1313
## Quickstart
1414

1515
Run your first pipeline by following the
16-
[pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart).
16+
[pipelines quickstart guide](/docs/components/pipelines/overview/quickstart).
1717

1818
## What is Kubeflow Pipelines?
1919

@@ -56,7 +56,7 @@ A _pipeline component_ is a self-contained set of user code, packaged as a
5656
performs one step in the pipeline. For example, a component can be responsible
5757
for data preprocessing, data transformation, model training, and so on.
5858

59-
See the conceptual guides to [pipelines](/docs/components/pipelines/overview/concepts/pipeline/)
59+
See the conceptual guides to [pipelines](/docs/components/pipelines/concepts/pipeline/)
6060
and [components](/docs/components/pipelines/concepts/component/).
6161

6262
## Example of a pipeline
@@ -275,7 +275,7 @@ At a high level, the execution of a pipeline proceeds as follows:
275275
## Next steps
276276

277277
* Follow the
278-
[pipelines quickstart guide](/docs/components/pipelines/pipelines-quickstart) to
278+
[pipelines quickstart guide](/docs/components/pipelines/overview/quickstart) to
279279
deploy Kubeflow and run a sample pipeline directly from the
280280
Kubeflow Pipelines UI.
281281
* Build machine-learning pipelines with the [Kubeflow Pipelines
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Understanding Pipelines"
3-
description = "Overview and concepts in Kubeflow Pipelines"
2+
title = "Overview"
3+
description = "Overview of Kubeflow Pipelines"
44
weight = 20
55
+++

content/en/docs/components/pipelines/caching-v2.md content/en/docs/components/pipelines/overview/caching-v2.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
+++
22
title = "Caching v2"
33
description = "Getting started with Kubeflow Pipelines caching v2"
4-
weight = 50
4+
weight = 41
55

66
+++
77
{{% beta-status
88
feedbacklink="https://github.com/kubeflow/pipelines/issues" %}}
99

10-
Starting from [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk/v2/) and Kubeflow Pipelines 1.7.0, Kubeflow Pipelines supports step caching capabilities in both [standalone deployment](https://www.kubeflow.org/docs/components/pipelines/installation/standalone-deployment/) and [AI platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs).
10+
Starting from [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) and Kubeflow Pipelines 1.7.0, Kubeflow Pipelines supports step caching capabilities in both [standalone deployment](https://www.kubeflow.org/docs/components/pipelines/installation/standalone-deployment/) and [AI platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs).
1111

1212
## Before you start
1313
This guide tells you the basic concepts of Kubeflow Pipelines caching and how to use it.
@@ -17,7 +17,7 @@ guide](/docs/components/pipelines/installation/) to deploy Kubeflow Pipelines.
1717
## What is step caching?
1818

1919
Kubeflow Pipelines caching provides step-level output caching, a process that helps to reduce costs by skipping computations that were completed in a previous pipeline run.
20-
Caching is enabled by default for all tasks of pipelines built with [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk/v2/) using `kfp.dsl.PipelineExecutionMode.V2_COMPATIBLE` mode.
20+
Caching is enabled by default for all tasks of pipelines built with [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) using `kfp.dsl.PipelineExecutionMode.V2_COMPATIBLE` mode.
2121
When Kubeflow Pipeline runs a pipeline, it checks to see whether
2222
an execution exists in Kubeflow Pipeline with the interface of each pipeline task.
2323
The task's interface is defined as the combination of the pipeline task specification (base image, command, args), the pipeline task's inputs (the name and id of artifacts, the name and value of parameters),
@@ -33,6 +33,6 @@ If there is a matching execution in Kubeflow Pipelines, the outputs of that exec
3333

3434
## Disabling/enabling caching
3535

36-
Cache is enabled by default with [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk/v2/) using `kfp.dsl.PipelineExecutionMode.V2_COMPATIBLE` mode.
36+
Cache is enabled by default with [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) using `kfp.dsl.PipelineExecutionMode.V2_COMPATIBLE` mode.
3737

3838
You can turn off execution caching for pipeline runs that are created using Python. When you run a pipeline using [create_run_from_pipeline_func](https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.client.html#kfp.Client.create_run_from_pipeline_func) or [create_run_from_pipeline_package](https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.client.html#kfp.Client.create_run_from_pipeline_package) or [run_pipeline](https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.client.html#kfp.Client.run_pipeline,) you can use the `enable_caching` argument to specify that this pipeline run does not use caching.

content/en/docs/components/pipelines/caching.md content/en/docs/components/pipelines/overview/caching.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Caching"
33
description = "Getting started with Kubeflow Pipelines step caching"
4-
weight = 50
4+
weight = 40
55

66
+++
77
{{% alpha-status

content/en/docs/components/pipelines/overview/concepts/_index.md

-5
This file was deleted.

content/en/docs/components/pipelines/overview/interfaces.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Introduction to the Pipelines Interfaces"
2+
title = "Pipelines Interfaces"
33
description = "The ways you can interact with the Kubeflow Pipelines system"
44
weight = 20
55

@@ -25,15 +25,15 @@ From the Kubeflow Pipelines UI you can perform the following tasks:
2525
that someone has shared with you.
2626
* Create an *experiment* to group one or more of your pipeline runs.
2727
See the [definition of an
28-
experiment](/docs/components/pipelines/overview/concepts/experiment/).
28+
experiment](/docs/components/pipelines/concepts/experiment/).
2929
* Create and start a *run* within the experiment. A run is a single execution
3030
of a pipeline. See the [definition of a
31-
run](/docs/components/pipelines/overview/concepts/run/).
31+
run](/docs/components/pipelines/concepts/run/).
3232
* Explore the configuration, graph, and output of your pipeline run.
3333
* Compare the results of one or more runs within an experiment.
3434
* Schedule runs by creating a recurring run.
3535

36-
See the [quickstart guide](/docs/components/pipelines/pipelines-quickstart/) for more
36+
See the [quickstart guide](/docs/components/pipelines/overview/quickstart/) for more
3737
information about accessing the Kubeflow Pipelines UI and running the samples.
3838

3939
When building a pipeline component, you can write out information for display

content/en/docs/components/pipelines/multi-user.md content/en/docs/components/pipelines/overview/multi-user.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Multi-user Isolation for Pipelines"
33
description = "Getting started with Kubeflow Pipelines multi-user isolation"
4-
weight = 35
4+
weight = 30
55
+++
66

77
Multi-user isolation for Kubeflow Pipelines is an integration to [Kubeflow multi-user isolation](/docs/components/multi-tenancy/).

0 commit comments

Comments
 (0)