From 810f8130a67b9e486a777f4e643c4127e2de1584 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 17 May 2024 18:16:36 -0300 Subject: [PATCH 01/35] Restructured Kubeflow Pipelines docs Signed-off-by: hbelmiro --- content/en/_index.html | 4 +- content/en/_redirects | 29 +- .../components/pipelines/how-to/_index.md | 5 + .../{v2/data-types => how-to}/artifacts.md | 19 +- .../how-to/build-advanced-pipeline.md | 147 ++++++++ .../pipelines/{v2 => how-to}/caching.md | 4 +- .../pipelines/{v2 => how-to}/cli.md | 9 +- .../{v2 => how-to}/compile-a-pipeline.md | 2 +- .../{v2/pipelines => how-to}/control-flow.md | 9 +- .../create-components}/_index.md | 5 +- .../additional-functionality.md | 4 +- .../compose-components-into-pipelines.md} | 15 +- .../container-components.md | 4 +- .../containerized-python-components.md | 4 +- .../create-components}/importer-component.md | 4 +- .../lightweight-python-components.md | 8 +- .../execute-kfp-pipelines-locally.md} | 11 +- .../load-and-share-components.md | 4 +- .../pipelines/{v2 => how-to}/migration.md | 28 +- .../{v2/data-types => how-to}/parameters.md | 13 +- .../platform-specific-features.md | 9 +- .../{v2 => how-to}/run-a-pipeline.md | 6 +- .../server-config.md | 2 +- .../pipelines/{v1 => legacy-v1}/_index.md | 4 +- .../{v1 => legacy-v1}/concepts/_index.md | 0 .../{v1 => legacy-v1}/concepts/component.md | 0 .../{v1 => legacy-v1}/concepts/experiment.md | 0 .../{v1 => legacy-v1}/concepts/graph.md | 0 .../{v1 => legacy-v1}/concepts/metadata.md | 0 .../concepts/output-artifact.md | 0 .../{v1 => legacy-v1}/concepts/pipeline.md | 0 .../{v1 => legacy-v1}/concepts/run-trigger.md | 0 .../{v1 => legacy-v1}/concepts/run.md | 0 .../{v1 => legacy-v1}/concepts/step.md | 0 .../{v1 => legacy-v1}/installation/_index.md | 0 .../installation/choose-executor.md | 0 .../installation/compatibility-matrix.md | 0 .../installation/localcluster-deployment.md | 0 .../installation/overview.md | 0 .../installation/standalone-deployment.md | 0 .../{v1 => legacy-v1}/installation/upgrade.md | 2 +- .../{v1 => legacy-v1}/introduction.md | 0 .../{v1 => legacy-v1}/overview/_index.md | 0 .../{v1 => legacy-v1}/overview/caching.md | 0 .../{v1 => legacy-v1}/overview/interfaces.md | 0 .../{v1 => legacy-v1}/overview/multi-user.md | 0 .../overview/pipeline-root.md | 0 .../{v1 => legacy-v1}/overview/quickstart.md | 0 .../{v1 => legacy-v1}/reference/_index.md | 0 .../api/kubeflow-pipeline-api-spec.html | 0 .../reference/component-spec.md | 0 .../{v1 => legacy-v1}/reference/sdk.md | 0 .../pipelines/{v1 => legacy-v1}/sdk/OWNERS.md | 0 .../pipelines/{v1 => legacy-v1}/sdk/_index.md | 0 .../{v1 => legacy-v1}/sdk/best-practices.md | 0 .../sdk/build-pipeline.ipynb | 0 .../{v1 => legacy-v1}/sdk/build-pipeline.md | 8 +- .../sdk/component-development.md | 0 .../{v1 => legacy-v1}/sdk/connect-api.md | 0 .../{v1 => legacy-v1}/sdk/dsl-recursion.md | 0 .../sdk/enviroment_variables.md | 0 .../pipelines/{v1 => legacy-v1}/sdk/gcp.md | 0 .../{v1 => legacy-v1}/sdk/install-sdk.md | 0 .../sdk/manipulate-resources.md | 0 .../{v1 => legacy-v1}/sdk/output-viewer.md | 0 .../{v1 => legacy-v1}/sdk/parameters.md | 0 .../sdk/pipelines-with-tekton.md | 0 .../sdk/python-based-visualizations.md | 0 .../sdk/python-function-components.ipynb | 0 .../sdk/python-function-components.md | 8 +- .../{v1 => legacy-v1}/sdk/sdk-overview.md | 0 .../sdk/static-type-checking.md | 0 .../{v1 => legacy-v1}/troubleshooting.md | 0 .../{v1 => legacy-v1}/tutorials/_index.md | 0 .../tutorials/api-pipelines.md | 0 .../tutorials/benchmark-examples.md | 0 .../tutorials/build-pipeline.md | 0 .../tutorials/cloud-tutorials.md | 0 .../tutorials/sdk-examples.md | 0 .../components/pipelines/overview/_index.md | 5 + .../getting-started.md} | 6 +- .../{v2 => overview}/installation/_index.md | 4 +- .../{v2 => overview}/introduction.md | 6 +- .../pipelines/{v2 => }/reference/_index.md | 2 +- .../api/kubeflow-pipeline-api-spec.html | 2 +- .../community-and-support.md | 2 +- .../pipelines/{v2 => }/reference/sdk.md | 2 +- .../version-compatibility.md | 2 +- .../en/docs/components/pipelines/v2/_index.md | 7 - .../pipelines/v2/administration/_index.md | 8 - .../pipelines/v2/data-types/_index.md | 19 - .../pipelines/v2/installation/quickstart.md | 353 ------------------ .../pipelines/v2/pipelines/_index.md | 9 - 93 files changed, 287 insertions(+), 507 deletions(-) create mode 100644 content/en/docs/components/pipelines/how-to/_index.md rename content/en/docs/components/pipelines/{v2/data-types => how-to}/artifacts.md (94%) create mode 100644 content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md rename content/en/docs/components/pipelines/{v2 => how-to}/caching.md (98%) rename content/en/docs/components/pipelines/{v2 => how-to}/cli.md (94%) rename content/en/docs/components/pipelines/{v2 => how-to}/compile-a-pipeline.md (99%) rename content/en/docs/components/pipelines/{v2/pipelines => how-to}/control-flow.md (97%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/_index.md (93%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/additional-functionality.md (95%) rename content/en/docs/components/pipelines/{v2/pipelines/pipeline-basics.md => how-to/create-components/compose-components-into-pipelines.md} (94%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/container-components.md (98%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/containerized-python-components.md (96%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/importer-component.md (93%) rename content/en/docs/components/pipelines/{v2/components => how-to/create-components}/lightweight-python-components.md (95%) rename content/en/docs/components/pipelines/{v2/local-execution.md => how-to/execute-kfp-pipelines-locally.md} (93%) rename content/en/docs/components/pipelines/{v2 => how-to}/load-and-share-components.md (94%) rename content/en/docs/components/pipelines/{v2 => how-to}/migration.md (93%) rename content/en/docs/components/pipelines/{v2/data-types => how-to}/parameters.md (91%) rename content/en/docs/components/pipelines/{v2 => how-to}/platform-specific-features.md (94%) rename content/en/docs/components/pipelines/{v2 => how-to}/run-a-pipeline.md (95%) rename content/en/docs/components/pipelines/{v2/administration => how-to}/server-config.md (99%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/_index.md (64%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/component.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/experiment.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/graph.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/metadata.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/output-artifact.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/pipeline.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/run-trigger.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/run.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/concepts/step.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/choose-executor.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/compatibility-matrix.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/localcluster-deployment.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/overview.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/standalone-deployment.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/installation/upgrade.md (98%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/introduction.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/caching.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/interfaces.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/multi-user.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/pipeline-root.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/overview/quickstart.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/reference/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/reference/api/kubeflow-pipeline-api-spec.html (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/reference/component-spec.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/reference/sdk.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/OWNERS.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/best-practices.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/build-pipeline.ipynb (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/build-pipeline.md (98%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/component-development.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/connect-api.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/dsl-recursion.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/enviroment_variables.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/gcp.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/install-sdk.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/manipulate-resources.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/output-viewer.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/parameters.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/pipelines-with-tekton.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/python-based-visualizations.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/python-function-components.ipynb (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/python-function-components.md (98%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/sdk-overview.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/sdk/static-type-checking.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/troubleshooting.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/_index.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/api-pipelines.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/benchmark-examples.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/build-pipeline.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/cloud-tutorials.md (100%) rename content/en/docs/components/pipelines/{v1 => legacy-v1}/tutorials/sdk-examples.md (100%) create mode 100644 content/en/docs/components/pipelines/overview/_index.md rename content/en/docs/components/pipelines/{v2/hello-world.md => overview/getting-started.md} (93%) rename content/en/docs/components/pipelines/{v2 => overview}/installation/_index.md (74%) rename content/en/docs/components/pipelines/{v2 => overview}/introduction.md (92%) rename content/en/docs/components/pipelines/{v2 => }/reference/_index.md (87%) rename content/en/docs/components/pipelines/{v2 => }/reference/api/kubeflow-pipeline-api-spec.html (99%) rename content/en/docs/components/pipelines/{v2 => reference}/community-and-support.md (99%) rename content/en/docs/components/pipelines/{v2 => }/reference/sdk.md (95%) rename content/en/docs/components/pipelines/{v2 => reference}/version-compatibility.md (99%) delete mode 100644 content/en/docs/components/pipelines/v2/_index.md delete mode 100644 content/en/docs/components/pipelines/v2/administration/_index.md delete mode 100644 content/en/docs/components/pipelines/v2/data-types/_index.md delete mode 100644 content/en/docs/components/pipelines/v2/installation/quickstart.md delete mode 100644 content/en/docs/components/pipelines/v2/pipelines/_index.md diff --git a/content/en/_index.html b/content/en/_index.html index 518dd553df..f56ebc6dee 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -41,7 +41,7 @@

Kubeflow Components

- + Kubeflow Components
Pipelines

- Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes. + Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes.

diff --git a/content/en/_redirects b/content/en/_redirects index 7d3d484422..8b9e380d98 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -21,6 +21,33 @@ # Removed redundant UI guide. Quickstart is a better destination. /docs/pipelines/pipelines-ui/ /docs/components/pipelines/pipelines-quickstart/ +# Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) +/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ +/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ +/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ +/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ +/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ +/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ +/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ +/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ +/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ +/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ +/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ +/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ +/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ +/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ +/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ +/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ +/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ +/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ +/docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ +/docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ +/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ + # Restructured the pipelines docs. /docs/pipelines/ /docs/components/pipelines /docs/pipelines/output-viewer/ /docs/components/pipelines/sdk/output-viewer/ @@ -184,7 +211,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat # pipelines v1 -> v2 redirects -/docs/components/pipelines/* /docs/components/pipelines/v1/:splat +/docs/components/pipelines/* /docs/components/pipelines/legacy-v1/:splat # Restructure About section /docs/about/kubeflow /docs/started/introduction diff --git a/content/en/docs/components/pipelines/how-to/_index.md b/content/en/docs/components/pipelines/how-to/_index.md new file mode 100644 index 0000000000..e589995726 --- /dev/null +++ b/content/en/docs/components/pipelines/how-to/_index.md @@ -0,0 +1,5 @@ ++++ +title = "How-to/User guides" +description = "Documentation for Kubeflow Pipelines." +weight = 2 ++++ diff --git a/content/en/docs/components/pipelines/v2/data-types/artifacts.md b/content/en/docs/components/pipelines/how-to/artifacts.md similarity index 94% rename from content/en/docs/components/pipelines/v2/data-types/artifacts.md rename to content/en/docs/components/pipelines/how-to/artifacts.md index 0ba5a3cb7d..036c5a60a3 100644 --- a/content/en/docs/components/pipelines/v2/data-types/artifacts.md +++ b/content/en/docs/components/pipelines/how-to/artifacts.md @@ -1,7 +1,6 @@ +++ -title = "Artifacts" -description = "Create, use, pass, and track ML artifacts" -weight = 2 +title = "Create, use, pass, and track ML artifacts" +weight = 10 +++ {{% kfp-v2-keywords %}} @@ -241,14 +240,14 @@ On the [KFP open source][oss-be] UI, `ClassificationMetrics`, `SlicedClassificat [dsl-slicedclassificationmetrics]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.SlicedClassificationMetrics [dsl-html]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.HTML [dsl-markdown]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Markdown -[type-checking]: /docs/components/pipelines/v2/compile-a-pipeline#type-checking +[type-checking]: /docs/components/pipelines/how-to/compile-a-pipeline#type-checking [oss-be]: /docs/components/pipelines/v2/installation/ [pipelines]: /docs/components/pipelines/v2/pipelines/pipelines-basics/ -[container-components]: /docs/components/pipelines/v2/components/lightweight-python-components/ -[python-components]: /docs/components/pipelines/v2/components/container-components +[container-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// +[python-components]: /docs/components/pipelines/how-to/create-components/container-components [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Collected -[parallel-looping]: https://www.kubeflow.org/docs/components/pipelines/v2/pipelines/control-flow/#parallel-looping-dslparallelfor -[traditional-artifact-syntax]: /docs/components/pipelines/v2/data-types/artifacts/#traditional-artifact-syntax -[multiple-outputs]: /docs/components/pipelines/v2/data-types/parameters/#multiple-output-parameters -[pythonic-artifact-syntax]: /docs/components/pipelines/v2/data-types/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file +[parallel-looping]: https://www.kubeflow.org/docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor +[traditional-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#traditional-artifact-syntax +[multiple-outputs]: /docs/components/pipelines/how-to/parameters/#multiple-output-parameters +[pythonic-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md b/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md new file mode 100644 index 0000000000..6b151a0802 --- /dev/null +++ b/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md @@ -0,0 +1,147 @@ ++++ +title = "Build a More Advanced ML Pipeline" +weight = 11 ++++ + +{{% kfp-v2-keywords %}} + +This step demonstrates how to build a more advanced machine learning (ML) pipeline that leverages additional KFP pipeline composition features. + +The following ML pipeline creates a dataset, normalizes the features of the dataset as a preprocessing step, and trains a simple ML model on the data using different hyperparameters: + +```python +from typing import List + +from kfp import client +from kfp import dsl +from kfp.dsl import Dataset +from kfp.dsl import Input +from kfp.dsl import Model +from kfp.dsl import Output + + +@dsl.component(packages_to_install=['pandas==1.3.5']) +def create_dataset(iris_dataset: Output[Dataset]): + import pandas as pd + + csv_url = 'https://archive.ics.uci.edu/ml/machine-learning-databases/iris/iris.data' + col_names = [ + 'Sepal_Length', 'Sepal_Width', 'Petal_Length', 'Petal_Width', 'Labels' + ] + df = pd.read_csv(csv_url, names=col_names) + + with open(iris_dataset.path, 'w') as f: + df.to_csv(f) + + +@dsl.component(packages_to_install=['pandas==1.3.5', 'scikit-learn==1.0.2']) +def normalize_dataset( + input_iris_dataset: Input[Dataset], + normalized_iris_dataset: Output[Dataset], + standard_scaler: bool, + min_max_scaler: bool, +): + if standard_scaler is min_max_scaler: + raise ValueError( + 'Exactly one of standard_scaler or min_max_scaler must be True.') + + import pandas as pd + from sklearn.preprocessing import MinMaxScaler + from sklearn.preprocessing import StandardScaler + + with open(input_iris_dataset.path) as f: + df = pd.read_csv(f) + labels = df.pop('Labels') + + if standard_scaler: + scaler = StandardScaler() + if min_max_scaler: + scaler = MinMaxScaler() + + df = pd.DataFrame(scaler.fit_transform(df)) + df['Labels'] = labels + with open(normalized_iris_dataset.path, 'w') as f: + df.to_csv(f) + + +@dsl.component(packages_to_install=['pandas==1.3.5', 'scikit-learn==1.0.2']) +def train_model( + normalized_iris_dataset: Input[Dataset], + model: Output[Model], + n_neighbors: int, +): + import pickle + + import pandas as pd + from sklearn.model_selection import train_test_split + from sklearn.neighbors import KNeighborsClassifier + + with open(normalized_iris_dataset.path) as f: + df = pd.read_csv(f) + + y = df.pop('Labels') + X = df + + X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=0) + + clf = KNeighborsClassifier(n_neighbors=n_neighbors) + clf.fit(X_train, y_train) + with open(model.path, 'wb') as f: + pickle.dump(clf, f) + + +@dsl.pipeline(name='iris-training-pipeline') +def my_pipeline( + standard_scaler: bool, + min_max_scaler: bool, + neighbors: List[int], +): + create_dataset_task = create_dataset() + + normalize_dataset_task = normalize_dataset( + input_iris_dataset=create_dataset_task.outputs['iris_dataset'], + standard_scaler=True, + min_max_scaler=False) + + with dsl.ParallelFor(neighbors) as n_neighbors: + train_model( + normalized_iris_dataset=normalize_dataset_task + .outputs['normalized_iris_dataset'], + n_neighbors=n_neighbors) + + +endpoint = '' +kfp_client = client.Client(host=endpoint) +run = kfp_client.create_run_from_pipeline_func( + my_pipeline, + arguments={ + 'min_max_scaler': True, + 'standard_scaler': False, + 'neighbors': [3, 6, 9] + }, +) +url = f'{endpoint}/#/runs/details/{run.run_id}' +print(url) +``` + +This example introduces the following new features in the pipeline: + +* Some Python **packages to install** are added at component runtime, using the `packages_to_install` argument on the `@dsl.component` decorator, as follows: + + `@dsl.component(packages_to_install=['pandas==1.3.5'])` + + To use a library after installing it, you must include its import statements within the scope of the component function, so that the library is imported at component runtime. + +* **Input and output artifacts** of types `Dataset` and `Model` are introduced in the component signature to describe the input and output artifacts of the components. This is done using the type annotation generics `Input[]` and `Output[]` for input and output artifacts respectively. + + Within the scope of a component, artifacts can be read (for inputs) and written (for outputs) via the `.path` attribute. The KFP backend ensures that *input* artifact files are copied *to* the executing pod's local file system from the remote storage at runtime, so that the component function can read input artifacts from the local file system. By comparison, *output* artifact files are copied *from* the local file system of the pod to remote storage, when the component finishes running. This way, the output artifacts persist outside the pod. In both cases, the component author needs to interact with the local file system only to create persistent artifacts. + + The arguments for the parameters annotated with `Output[]` are not passed to components by the pipeline author. The KFP backend passes this artifact during component runtime, so that component authors don't need to be concerned about the path to which the output artifacts are written. After an output artifact is written, the backend executing the component recognizes the KFP artifact types (`Dataset` or `Model`), and organizes them on the Dashboard. + + An output artifact can be passed as an input to a downstream component using the `.outputs` attribute of the source task and the output artifact parameter name, as follows: + + `create_dataset_task.outputs['iris_dataset']` + +* One of the **DSL control flow features**, `dsl.ParallelFor`, is used. It is a context manager that lets pipeline authors create tasks. These tasks execute in parallel in a loop. Using `dsl.ParallelFor` to iterate over the `neighbors` pipeline argument lets you execute the `train_model` component with different arguments and test multiple hyperparameters in one pipeline run. Other control flow features include `dsl.Condition` and `dsl.ExitHandler`. + +Congratulations! You now have a KFP deployment, an end-to-end ML pipeline, and an introduction to the UI. That's just the beginning of KFP pipeline and Dashboard features. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/caching.md b/content/en/docs/components/pipelines/how-to/caching.md similarity index 98% rename from content/en/docs/components/pipelines/v2/caching.md rename to content/en/docs/components/pipelines/how-to/caching.md index 340b8c0370..7803380f4b 100644 --- a/content/en/docs/components/pipelines/v2/caching.md +++ b/content/en/docs/components/pipelines/how-to/caching.md @@ -1,7 +1,7 @@ +++ -title = "Caching" +title = "Use Caching" description = "How to use caching in Kubeflow Pipelines." -weight = 13 +weight = 12 +++ Kubeflow Pipelines support caching to eliminate redundant executions and improve diff --git a/content/en/docs/components/pipelines/v2/cli.md b/content/en/docs/components/pipelines/how-to/cli.md similarity index 94% rename from content/en/docs/components/pipelines/v2/cli.md rename to content/en/docs/components/pipelines/how-to/cli.md index 2177248aa8..9ce4186c9f 100644 --- a/content/en/docs/components/pipelines/v2/cli.md +++ b/content/en/docs/components/pipelines/how-to/cli.md @@ -1,7 +1,6 @@ +++ -title = "Command Line Interface" -description = "Interact with KFP via the CLI" -weight = 10 +title = "Interact with KFP via the CLI" +weight = 4 +++ {{% kfp-v2-keywords %}} @@ -158,5 +157,5 @@ For more information about the arguments and flags supported by the `kfp compone [cli-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/stable/index.html -[lightweight-python-component]: /docs/components/pipelines/v2/components/lightweight-python-components -[containerized-python-components]: /docs/components/pipelines/v2/components/containerized-python-components +[lightweight-python-component]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components diff --git a/content/en/docs/components/pipelines/v2/compile-a-pipeline.md b/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md similarity index 99% rename from content/en/docs/components/pipelines/v2/compile-a-pipeline.md rename to content/en/docs/components/pipelines/how-to/compile-a-pipeline.md index a9f3285119..77542f31d2 100644 --- a/content/en/docs/components/pipelines/v2/compile-a-pipeline.md +++ b/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md @@ -1,7 +1,7 @@ +++ title = "Compile a Pipeline" description = "Compile pipelines and components to YAML" -weight = 7 +weight = 2 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/v2/pipelines/control-flow.md b/content/en/docs/components/pipelines/how-to/control-flow.md similarity index 97% rename from content/en/docs/components/pipelines/v2/pipelines/control-flow.md rename to content/en/docs/components/pipelines/how-to/control-flow.md index aa7ded927f..95554aaacc 100644 --- a/content/en/docs/components/pipelines/v2/pipelines/control-flow.md +++ b/content/en/docs/components/pipelines/how-to/control-flow.md @@ -1,7 +1,6 @@ +++ -title = "Control Flow" -description = "Create pipelines with control flow" -weight = 2 +title = "Create pipelines with control flow" +weight = 8 +++ {{% kfp-v2-keywords %}} @@ -209,8 +208,8 @@ def my_pipeline(text: str = 'message'): Note that the component used for the caller task (`print_op` in the example above) requires a default value for all inputs it consumes from an upstream task. The default value is applied if the upstream task fails to produce the outputs that are passed to the caller task. Specifying default values ensures that the caller task always succeeds, regardless of the status of the upstream task. -[data-passing]: /docs/components/pipelines/v2/pipelines/pipeline-basics#data-passing-and-task-dependencies -[pipeline-basics]: /docs/components/pipelines/v2/pipelines/pipeline-basics +[data-passing]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines#data-passing-and-task-dependencies +[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines [dsl-condition]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Condition [dsl-exithandler]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ExitHandler [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor diff --git a/content/en/docs/components/pipelines/v2/components/_index.md b/content/en/docs/components/pipelines/how-to/create-components/_index.md similarity index 93% rename from content/en/docs/components/pipelines/v2/components/_index.md rename to content/en/docs/components/pipelines/how-to/create-components/_index.md index d071bc09e3..2aa77d2bf6 100644 --- a/content/en/docs/components/pipelines/v2/components/_index.md +++ b/content/en/docs/components/pipelines/how-to/create-components/_index.md @@ -1,7 +1,6 @@ +++ -title = "Components" -description = "Author KFP components" -weight = 5 +title = "Create components" +weight = 6 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/v2/components/additional-functionality.md b/content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md similarity index 95% rename from content/en/docs/components/pipelines/v2/components/additional-functionality.md rename to content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md index ba1a2dd3c1..a52603084c 100644 --- a/content/en/docs/components/pipelines/v2/components/additional-functionality.md +++ b/content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md @@ -62,9 +62,9 @@ def dataset_concatenator( Note that if you provide a `description` argument to the [`@dsl.pipeline`][dsl-pipeline] decorator, KFP will use this description instead of the docstring description. -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [google-docstring-style]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline -[output-artifacts]: /docs/components/pipelines/v2/data-types/artifacts#declaring-inputoutput-artifacts +[output-artifacts]: /docs/components/pipelines/how-to/artifacts#declaring-inputoutput-artifacts [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [output-type-marker]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Output \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/pipelines/pipeline-basics.md b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md similarity index 94% rename from content/en/docs/components/pipelines/v2/pipelines/pipeline-basics.md rename to content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md index e4e00dbee0..7261a71eab 100644 --- a/content/en/docs/components/pipelines/v2/pipelines/pipeline-basics.md +++ b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md @@ -1,7 +1,6 @@ +++ -title = "Pipeline Basics" -description = "Compose components into pipelines" -weight = 1 +title = "Compose components into pipelines" +weight = 2 +++ {{% kfp-v2-keywords %}} @@ -203,14 +202,14 @@ def pythagorean(a: float = 1.2, b: float = 1.2) -> float: [dsl-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline -[control-flow]: /docs/components/pipelines/v2/pipelines/control-flow +[control-flow]: /docs/components/pipelines/how-to/control-flow [components]: /docs/components/pipelines/v2/components [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [oss-be]: /docs/components/pipelines/v2/installation/ [data-types]: /docs/components/pipelines/v2/data-types -[output-artifacts]: /docs/components/pipelines/v2/data-types/artifacts#using-output-artifacts -[container-component-outputs]: /docs/components/pipelines/v2/components/container-components#create-component-outputs -[parameters-namedtuple]: /docs/components/pipelines/v2/data-types/parameters#multiple-output-parameters +[output-artifacts]: /docs/components/pipelines/how-to/artifacts#using-output-artifacts +[container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs +[parameters-namedtuple]: /docs/components/pipelines/how-to/parameters#multiple-output-parameters [dsl-pipeline-job-name-placeholder]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PIPELINE_JOB_NAME_PLACEHOLDER -[component-docstring-format]: /docs/components/pipelines/v2/components/additional-functionality#component-docstring-format +[component-docstring-format]: /docs/components/pipelines/how-to/create-components/additional-functionality#component-docstring-format diff --git a/content/en/docs/components/pipelines/v2/components/container-components.md b/content/en/docs/components/pipelines/how-to/create-components/container-components.md similarity index 98% rename from content/en/docs/components/pipelines/v2/components/container-components.md rename to content/en/docs/components/pipelines/how-to/create-components/container-components.md index 9a002b3371..1045097ee0 100644 --- a/content/en/docs/components/pipelines/v2/components/container-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/container-components.md @@ -184,8 +184,8 @@ def hello_someone(optional_name: str = None): Arguments to `then` and `else_` may be a list of any combination of static strings, upstream outputs, pipeline parameters, or other instances of `dsl.ConcatPlaceholder` or `dsl.IfPresentPlaceholder` -[hello-world-pipeline]: /docs/components/pipelines/v2/hello-world -[pipeline-basics]: /docs/components/pipelines/v2/pipelines/pipeline-basics +[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines [alpine]: https://hub.docker.com/_/alpine [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.container_component diff --git a/content/en/docs/components/pipelines/v2/components/containerized-python-components.md b/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md similarity index 96% rename from content/en/docs/components/pipelines/v2/components/containerized-python-components.md rename to content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md index 5d3c32dfe6..220ab2810f 100644 --- a/content/en/docs/components/pipelines/v2/components/containerized-python-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md @@ -103,10 +103,10 @@ Since `add`'s `target_image` uses [Google Cloud Artifact Registry][artifact-regi [kfp-component-build]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html#kfp-component-build -[lightweight-python-components]: /docs/components/pipelines/v2/components/lightweight-python-components +[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ [image-tag]: https://docs.docker.com/engine/reference/commandline/tag/ [docker-from]: https://docs.docker.com/engine/reference/builder/#from [artifact-registry]: https://cloud.google.com/artifact-registry/docs/docker/authentication [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [iam]: https://cloud.google.com/iam -[packages-to-install]: https://www.kubeflow.org/docs/components/pipelines/v2/components/lightweight-python-components/#packages_to_install \ No newline at end of file +[packages-to-install]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/lightweight-python-components//#packages_to_install \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/components/importer-component.md b/content/en/docs/components/pipelines/how-to/create-components/importer-component.md similarity index 93% rename from content/en/docs/components/pipelines/v2/components/importer-component.md rename to content/en/docs/components/pipelines/how-to/create-components/importer-component.md index 7f97a3b6c6..223e27f10e 100644 --- a/content/en/docs/components/pipelines/v2/components/importer-component.md +++ b/content/en/docs/components/pipelines/how-to/create-components/importer-component.md @@ -34,7 +34,7 @@ The `importer` component permits setting artifact metadata via the `metadata` ar You may also specify a boolean `reimport` argument. If `reimport` is `False`, KFP will check to see if the artifact has already been imported to ML Metadata and, if so, use it. This is useful for avoiding duplicative artifact entries in ML Metadata when multiple pipeline runs import the same artifact. If `reimport` is `True`, KFP will reimport the artifact as a new artifact in ML Metadata regardless of whether it was previously imported. -[pipeline-basics]: /docs/components/pipelines/v2/pipelines/pipeline-basics +[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines [dsl-importer]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.importer -[artifacts]: /docs/components/pipelines/v2/data-types/artifacts +[artifacts]: /docs/components/pipelines/how-to/artifacts [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/components/lightweight-python-components.md b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md similarity index 95% rename from content/en/docs/components/pipelines/v2/components/lightweight-python-components.md rename to content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md index ca4eabaecd..4a6783cc39 100644 --- a/content/en/docs/components/pipelines/v2/components/lightweight-python-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md @@ -126,12 +126,12 @@ By default, Python Components install `kfp` at runtime. This is required to defi Note that setting `install_kfp_package` to `False` is rarely necessary and is discouraged for the majority of use cases. -[hello-world-pipeline]: /docs/components/pipelines/v2/hello-world -[containerized-python-components]: /docs/components/pipelines/v2/components/containerized-python-components +[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component [data-types]: /docs/components/pipelines/v2/data-types -[parameters]: /docs/components/pipelines/v2/data-types/parameters -[artifacts]: /docs/components/pipelines/v2/data-types/artifacts +[parameters]: /docs/components/pipelines/how-to/parameters +[artifacts]: /docs/components/pipelines/how-to/artifacts [requirements-txt]: https://pip.pypa.io/en/stable/reference/requirements-file-format/ [pypi-org]: https://pypi.org/ [pip-install]: https://pip.pypa.io/en/stable/cli/pip_install/ diff --git a/content/en/docs/components/pipelines/v2/local-execution.md b/content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md similarity index 93% rename from content/en/docs/components/pipelines/v2/local-execution.md rename to content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md index 820d72f9d8..ea1a03cd0a 100644 --- a/content/en/docs/components/pipelines/v2/local-execution.md +++ b/content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md @@ -1,7 +1,6 @@ +++ -title = "Local Execution" -description = "Execute KFP pipelines locally" -weight = 9 +title = "Execute KFP pipelines locally" +weight = 3 +++ {{% kfp-v2-keywords %}} @@ -133,9 +132,9 @@ Local execution comes with several limitations: While local pipeline execution has full support for sequential and nested pipelines, it does not yet support `dsl.Condition`, `dsl.ParallelFor`, or `dsl.ExitHandler`. -[lightweight-python-component]: /docs/components/pipelines/v2/components/lightweight-python-components -[containerized-python-components]: /docs/components/pipelines/v2/components/containerized-python-components -[container-components]: /docs/components/pipelines/v2/components/container-components +[lightweight-python-component]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components +[container-components]: /docs/components/pipelines/how-to/create-components/container-components diff --git a/content/en/docs/components/pipelines/v2/load-and-share-components.md b/content/en/docs/components/pipelines/how-to/load-and-share-components.md similarity index 94% rename from content/en/docs/components/pipelines/v2/load-and-share-components.md rename to content/en/docs/components/pipelines/how-to/load-and-share-components.md index b3cbe6e7a2..16da4cd26e 100644 --- a/content/en/docs/components/pipelines/v2/load-and-share-components.md +++ b/content/en/docs/components/pipelines/how-to/load-and-share-components.md @@ -1,7 +1,7 @@ +++ title = "Load and Share Components" description = "Load and use an ecosystem of components" -weight = 8 +weight = 7 +++ {{% kfp-v2-keywords %}} @@ -51,7 +51,7 @@ def my_pipeline(): Some libraries, such as [Google Cloud Pipeline Components][gcpc] package and provide reusable components in a pip-installable [Python package][gcpc-pypi]. -[pipeline-as-component]: /docs/components/pipelines/v2/pipelines/pipeline-basics#pipelines-as-components +[pipeline-as-component]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines#pipelines-as-components [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction [gcpc-pypi]: https://pypi.org/project/google-cloud-pipeline-components/ [components-module]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/components.html diff --git a/content/en/docs/components/pipelines/v2/migration.md b/content/en/docs/components/pipelines/how-to/migration.md similarity index 93% rename from content/en/docs/components/pipelines/v2/migration.md rename to content/en/docs/components/pipelines/how-to/migration.md index 8223480c42..9d3b505b27 100644 --- a/content/en/docs/components/pipelines/v2/migration.md +++ b/content/en/docs/components/pipelines/how-to/migration.md @@ -1,7 +1,7 @@ +++ title = "Migrate from KFP SDK v1" description = "v1 to v2 migration instructions and breaking changes" -weight = 3 +weight = 14 +++ {{% kfp-v2-keywords %}} @@ -409,7 +409,7 @@ def flip_coin(rand: int, result: dsl.OutputPath(str)): `VolumeOp` and `ResourceOp` expose direct access to Kubernetes resources within a pipeline definition. There is no support for these features on a non-Kubernetes platforms. -KFP v2 enables support for [platform-specific features](/docs/components/pipelines/v2/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. +KFP v2 enables support for [platform-specific features](/docs/components/pipelines/how-to/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. #### v1 component YAML support @@ -575,27 +575,27 @@ def training_pipeline(number_of_epochs: int = 1): If you believe we missed a breaking change or an important migration step, please [create an issue][new-issue] describing the change in the [kubeflow/pipelines repository][pipelines-repo]. -[artifacts]: /docs/components/pipelines/v2/data-types/artifacts -[cli]: /docs/components/pipelines/v2/cli/ -[compile]: /docs/components/pipelines/v2/compile-a-pipeline +[artifacts]: /docs/components/pipelines/how-to/artifacts +[cli]: /docs/components/pipelines/how-to/cli/ +[compile]: /docs/components/pipelines/how-to/compile-a-pipeline [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler.compile [components-load-component-from-file]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html#kfp.components.load_component_from_file -[container-components]: https://www.kubeflow.org/docs/components/pipelines/v2/components/containerized-python-components/ -[containerized-python-components]: /docs/components/pipelines/v2/components/containerized-python-components/ +[container-components]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/containerized-python-components/ +[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components/ [create-custom-training-job-from-component]: https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.Collected [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.container_component [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.ParallelFor [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline/#ir-yaml -[lightweight-python-components]: /docs/components/pipelines/v2/components/lightweight-python-components/ -[load]: /docs/components/pipelines/v2/load-and-share-components/ +[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline/#ir-yaml +[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// +[load]: /docs/components/pipelines/how-to/load-and-share-components/ [new-issue]: https://github.com/kubeflow/pipelines/issues/new -[oss-be-v1]: /docs/components/pipelines/v1/ +[oss-be-v1]: /docs/components/pipelines/legacy-v1/ [oss-be-v2]: /docs/components/pipelines/v2/installation/ -[parallelfor-control-flow]: /docs/components/pipelines/v2/pipelines/control-flow/#parallel-looping-dslparallelfor -[parameters]: /docs/components/pipelines/v2/data-types/parameters +[parallelfor-control-flow]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor +[parameters]: /docs/components/pipelines/how-to/parameters [pipelines-repo]: https://github.com/kubeflow/pipelines [semver-minor-version]: https://semver.org/#:~:text=MINOR%20version%20when%20you%20add%20functionality%20in%20a%20backwards%20compatible%20manner [v1-component-yaml-example]: https://github.com/kubeflow/pipelines/blob/01c87f8a032e70a6ca92cdbefa974a7da387f204/sdk/python/test_data/v1_component_yaml/add_component.yaml @@ -604,4 +604,4 @@ If you believe we missed a breaking change or an important migration step, pleas [vertex-sdk]: https://cloud.google.com/vertex-ai/docs/pipelines/run-pipeline#vertex-ai-sdk-for-python [argo]: https://argoproj.github.io/argo-workflows/ [dsl-pipelinetask-set-env-variable]: https://kubeflow-pipelines.readthedocs.io/en/2.0.0b13/source/dsl.html#kfp.dsl.PipelineTask.set_env_variable -[task-configuration-methods]: https://www.kubeflow.org/docs/components/pipelines/v2/pipelines/pipeline-basics/#task-configurations \ No newline at end of file +[task-configuration-methods]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/data-types/parameters.md b/content/en/docs/components/pipelines/how-to/parameters.md similarity index 91% rename from content/en/docs/components/pipelines/v2/data-types/parameters.md rename to content/en/docs/components/pipelines/how-to/parameters.md index fe81485bf7..9502499f34 100644 --- a/content/en/docs/components/pipelines/v2/data-types/parameters.md +++ b/content/en/docs/components/pipelines/how-to/parameters.md @@ -1,7 +1,6 @@ +++ -title = "Parameters" -description = "Pass small amounts of data between components" -weight = 1 +title = "Pass small amounts of data between components" +weight = 9 +++ {{% kfp-v2-keywords %}} @@ -167,10 +166,10 @@ def my_pipeline() -> NamedTuple('pipeline_outputs', c=int, d=str): [ml-metadata]: https://github.com/google/ml-metadata -[lightweight-python-components]: /docs/components/pipelines/v2/components/lightweight-python-components -[containerized-python-components]: /docs/components/pipelines/v2/components/containerized-python-components -[container-component]: /docs/components/pipelines/v2/components/container-components -[container-component-outputs]: /docs/components/pipelines/v2/components/container-components#create-component-outputs +[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components +[container-component]: /docs/components/pipelines/how-to/create-components/container-components +[container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [ml-metadata]: https://github.com/google/ml-metadata diff --git a/content/en/docs/components/pipelines/v2/platform-specific-features.md b/content/en/docs/components/pipelines/how-to/platform-specific-features.md similarity index 94% rename from content/en/docs/components/pipelines/v2/platform-specific-features.md rename to content/en/docs/components/pipelines/how-to/platform-specific-features.md index dff9fb1c2b..4ab934e110 100644 --- a/content/en/docs/components/pipelines/v2/platform-specific-features.md +++ b/content/en/docs/components/pipelines/how-to/platform-specific-features.md @@ -1,7 +1,6 @@ +++ -title = "Platform-specific Features" -description = "Author tasks with platform-specific functionality" -weight = 12 +title = "Author Tasks with Platform-Specific Functionality" +weight = 15 +++ @@ -106,10 +105,10 @@ Finally, we can schedule deletion of the PVC after `task2` finishes to clean up For the full pipeline and more information, see a [similar example][full-example] in the [`kfp-kubernetes` documentation][kfp-kubernetes-docs]. -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [oss-be]: /docs/components/pipelines/v2/installation/ [kfp-kubernetes-pypi]: https://pypi.org/project/kfp-kubernetes/ -[task-level-config-methods]: /docs/components/pipelines/v2/pipelines/pipeline-basics/#task-configurations +[task-level-config-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations [kfp-kubernetes-docs]: https://kfp-kubernetes.readthedocs.io/ [persistent-volume]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/ [storage-class]: https://kubernetes.io/docs/concepts/storage/storage-classes/ diff --git a/content/en/docs/components/pipelines/v2/run-a-pipeline.md b/content/en/docs/components/pipelines/how-to/run-a-pipeline.md similarity index 95% rename from content/en/docs/components/pipelines/v2/run-a-pipeline.md rename to content/en/docs/components/pipelines/how-to/run-a-pipeline.md index a74e558ce8..c3b0e83227 100644 --- a/content/en/docs/components/pipelines/v2/run-a-pipeline.md +++ b/content/en/docs/components/pipelines/how-to/run-a-pipeline.md @@ -1,7 +1,7 @@ +++ title = "Run a Pipeline" description = "Execute a pipeline on the KFP backend" -weight = 8 +weight = 1 +++ {{% kfp-v2-keywords %}} @@ -77,7 +77,7 @@ kfp run create --experiment-name my-experiment --package-file path/to/pipeline.y For more information about the `kfp run create` command, see [Command Line Interface][kfp-run-create-reference-docs] in the [KFP SDK reference documentation][kfp-sdk-api-ref]. For a summary of the available commands in the KFP CLI, see [Command-line Interface][kfp-cli]. [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/master/index.html -[compile-a-pipeline]: /docs/components/pipelines/v2/compile-a-pipeline/ +[compile-a-pipeline]: /docs/components/pipelines/how-to/compile-a-pipeline/ [kfp-sdk-api-ref-client]: https://kubeflow-pipelines.readthedocs.io/en/master/source/client.html -[kfp-cli]: /docs/components/pipelines/v2/cli/ +[kfp-cli]: /docs/components/pipelines/how-to/cli/ [kfp-run-create-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/master/source/cli.html#kfp-run-create diff --git a/content/en/docs/components/pipelines/v2/administration/server-config.md b/content/en/docs/components/pipelines/how-to/server-config.md similarity index 99% rename from content/en/docs/components/pipelines/v2/administration/server-config.md rename to content/en/docs/components/pipelines/how-to/server-config.md index 1f68b884a5..3593230fb1 100644 --- a/content/en/docs/components/pipelines/v2/administration/server-config.md +++ b/content/en/docs/components/pipelines/how-to/server-config.md @@ -1,7 +1,7 @@ +++ title = "Server Configuration" description = "Guidance on managing your Kubeflow Pipelines instances" -weight = 1 +weight = 13 +++ diff --git a/content/en/docs/components/pipelines/v1/_index.md b/content/en/docs/components/pipelines/legacy-v1/_index.md similarity index 64% rename from content/en/docs/components/pipelines/v1/_index.md rename to content/en/docs/components/pipelines/legacy-v1/_index.md index ce38915e21..d94954e55b 100644 --- a/content/en/docs/components/pipelines/v1/_index.md +++ b/content/en/docs/components/pipelines/legacy-v1/_index.md @@ -1,5 +1,5 @@ +++ -title = "v1" +title = "Legacy-v1" description = "Kubeflow Pipelines v1 Documentation" -weight = 15 +weight = 999 +++ diff --git a/content/en/docs/components/pipelines/v1/concepts/_index.md b/content/en/docs/components/pipelines/legacy-v1/concepts/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/_index.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/_index.md diff --git a/content/en/docs/components/pipelines/v1/concepts/component.md b/content/en/docs/components/pipelines/legacy-v1/concepts/component.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/component.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/component.md diff --git a/content/en/docs/components/pipelines/v1/concepts/experiment.md b/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/experiment.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md diff --git a/content/en/docs/components/pipelines/v1/concepts/graph.md b/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/graph.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/graph.md diff --git a/content/en/docs/components/pipelines/v1/concepts/metadata.md b/content/en/docs/components/pipelines/legacy-v1/concepts/metadata.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/metadata.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/metadata.md diff --git a/content/en/docs/components/pipelines/v1/concepts/output-artifact.md b/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/output-artifact.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md diff --git a/content/en/docs/components/pipelines/v1/concepts/pipeline.md b/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/pipeline.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md diff --git a/content/en/docs/components/pipelines/v1/concepts/run-trigger.md b/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/run-trigger.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md diff --git a/content/en/docs/components/pipelines/v1/concepts/run.md b/content/en/docs/components/pipelines/legacy-v1/concepts/run.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/run.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/run.md diff --git a/content/en/docs/components/pipelines/v1/concepts/step.md b/content/en/docs/components/pipelines/legacy-v1/concepts/step.md similarity index 100% rename from content/en/docs/components/pipelines/v1/concepts/step.md rename to content/en/docs/components/pipelines/legacy-v1/concepts/step.md diff --git a/content/en/docs/components/pipelines/v1/installation/_index.md b/content/en/docs/components/pipelines/legacy-v1/installation/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/_index.md rename to content/en/docs/components/pipelines/legacy-v1/installation/_index.md diff --git a/content/en/docs/components/pipelines/v1/installation/choose-executor.md b/content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/choose-executor.md rename to content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md diff --git a/content/en/docs/components/pipelines/v1/installation/compatibility-matrix.md b/content/en/docs/components/pipelines/legacy-v1/installation/compatibility-matrix.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/compatibility-matrix.md rename to content/en/docs/components/pipelines/legacy-v1/installation/compatibility-matrix.md diff --git a/content/en/docs/components/pipelines/v1/installation/localcluster-deployment.md b/content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/localcluster-deployment.md rename to content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md diff --git a/content/en/docs/components/pipelines/v1/installation/overview.md b/content/en/docs/components/pipelines/legacy-v1/installation/overview.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/overview.md rename to content/en/docs/components/pipelines/legacy-v1/installation/overview.md diff --git a/content/en/docs/components/pipelines/v1/installation/standalone-deployment.md b/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md similarity index 100% rename from content/en/docs/components/pipelines/v1/installation/standalone-deployment.md rename to content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md diff --git a/content/en/docs/components/pipelines/v1/installation/upgrade.md b/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md similarity index 98% rename from content/en/docs/components/pipelines/v1/installation/upgrade.md rename to content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md index 646003ab03..5c83d73b14 100644 --- a/content/en/docs/components/pipelines/v1/installation/upgrade.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md @@ -12,7 +12,7 @@ For upgrade instructions, refer to distribution specific documentations: ## Upgrading to v2.0 -* **Notice**: In v2.0 frontend, run metrics columns are deprecated in the run list page, but users can still get the same information by using [KFPv2 Scalar metrics](/docs/components/pipelines/v1/sdk/output-viewer/#scalar-metrics) +* **Notice**: In v2.0 frontend, run metrics columns are deprecated in the run list page, but users can still get the same information by using [KFPv2 Scalar metrics](/docs/components/pipelines/legacy-v1/sdk/output-viewer/#scalar-metrics) ## Upgrading to [v1.7] diff --git a/content/en/docs/components/pipelines/v1/introduction.md b/content/en/docs/components/pipelines/legacy-v1/introduction.md similarity index 100% rename from content/en/docs/components/pipelines/v1/introduction.md rename to content/en/docs/components/pipelines/legacy-v1/introduction.md diff --git a/content/en/docs/components/pipelines/v1/overview/_index.md b/content/en/docs/components/pipelines/legacy-v1/overview/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/_index.md rename to content/en/docs/components/pipelines/legacy-v1/overview/_index.md diff --git a/content/en/docs/components/pipelines/v1/overview/caching.md b/content/en/docs/components/pipelines/legacy-v1/overview/caching.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/caching.md rename to content/en/docs/components/pipelines/legacy-v1/overview/caching.md diff --git a/content/en/docs/components/pipelines/v1/overview/interfaces.md b/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/interfaces.md rename to content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md diff --git a/content/en/docs/components/pipelines/v1/overview/multi-user.md b/content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/multi-user.md rename to content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md diff --git a/content/en/docs/components/pipelines/v1/overview/pipeline-root.md b/content/en/docs/components/pipelines/legacy-v1/overview/pipeline-root.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/pipeline-root.md rename to content/en/docs/components/pipelines/legacy-v1/overview/pipeline-root.md diff --git a/content/en/docs/components/pipelines/v1/overview/quickstart.md b/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md similarity index 100% rename from content/en/docs/components/pipelines/v1/overview/quickstart.md rename to content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md diff --git a/content/en/docs/components/pipelines/v1/reference/_index.md b/content/en/docs/components/pipelines/legacy-v1/reference/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/reference/_index.md rename to content/en/docs/components/pipelines/legacy-v1/reference/_index.md diff --git a/content/en/docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec.html b/content/en/docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec.html similarity index 100% rename from content/en/docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec.html rename to content/en/docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec.html diff --git a/content/en/docs/components/pipelines/v1/reference/component-spec.md b/content/en/docs/components/pipelines/legacy-v1/reference/component-spec.md similarity index 100% rename from content/en/docs/components/pipelines/v1/reference/component-spec.md rename to content/en/docs/components/pipelines/legacy-v1/reference/component-spec.md diff --git a/content/en/docs/components/pipelines/v1/reference/sdk.md b/content/en/docs/components/pipelines/legacy-v1/reference/sdk.md similarity index 100% rename from content/en/docs/components/pipelines/v1/reference/sdk.md rename to content/en/docs/components/pipelines/legacy-v1/reference/sdk.md diff --git a/content/en/docs/components/pipelines/v1/sdk/OWNERS.md b/content/en/docs/components/pipelines/legacy-v1/sdk/OWNERS.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/OWNERS.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/OWNERS.md diff --git a/content/en/docs/components/pipelines/v1/sdk/_index.md b/content/en/docs/components/pipelines/legacy-v1/sdk/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/_index.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/_index.md diff --git a/content/en/docs/components/pipelines/v1/sdk/best-practices.md b/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/best-practices.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md diff --git a/content/en/docs/components/pipelines/v1/sdk/build-pipeline.ipynb b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/build-pipeline.ipynb rename to content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb diff --git a/content/en/docs/components/pipelines/v1/sdk/build-pipeline.md b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md similarity index 98% rename from content/en/docs/components/pipelines/v1/sdk/build-pipeline.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md index 43974f4fdc..8fd670e2b6 100644 --- a/content/en/docs/components/pipelines/v1/sdk/build-pipeline.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md @@ -26,8 +26,8 @@ background-position: left center; } @@ -455,6 +455,6 @@ client.create_run_from_pipeline_func( diff --git a/content/en/docs/components/pipelines/v1/sdk/component-development.md b/content/en/docs/components/pipelines/legacy-v1/sdk/component-development.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/component-development.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/component-development.md diff --git a/content/en/docs/components/pipelines/v1/sdk/connect-api.md b/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/connect-api.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md diff --git a/content/en/docs/components/pipelines/v1/sdk/dsl-recursion.md b/content/en/docs/components/pipelines/legacy-v1/sdk/dsl-recursion.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/dsl-recursion.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/dsl-recursion.md diff --git a/content/en/docs/components/pipelines/v1/sdk/enviroment_variables.md b/content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/enviroment_variables.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md diff --git a/content/en/docs/components/pipelines/v1/sdk/gcp.md b/content/en/docs/components/pipelines/legacy-v1/sdk/gcp.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/gcp.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/gcp.md diff --git a/content/en/docs/components/pipelines/v1/sdk/install-sdk.md b/content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/install-sdk.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md diff --git a/content/en/docs/components/pipelines/v1/sdk/manipulate-resources.md b/content/en/docs/components/pipelines/legacy-v1/sdk/manipulate-resources.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/manipulate-resources.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/manipulate-resources.md diff --git a/content/en/docs/components/pipelines/v1/sdk/output-viewer.md b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/output-viewer.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md diff --git a/content/en/docs/components/pipelines/v1/sdk/parameters.md b/content/en/docs/components/pipelines/legacy-v1/sdk/parameters.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/parameters.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/parameters.md diff --git a/content/en/docs/components/pipelines/v1/sdk/pipelines-with-tekton.md b/content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/pipelines-with-tekton.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md diff --git a/content/en/docs/components/pipelines/v1/sdk/python-based-visualizations.md b/content/en/docs/components/pipelines/legacy-v1/sdk/python-based-visualizations.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/python-based-visualizations.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/python-based-visualizations.md diff --git a/content/en/docs/components/pipelines/v1/sdk/python-function-components.ipynb b/content/en/docs/components/pipelines/legacy-v1/sdk/python-function-components.ipynb similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/python-function-components.ipynb rename to content/en/docs/components/pipelines/legacy-v1/sdk/python-function-components.ipynb diff --git a/content/en/docs/components/pipelines/v1/sdk/python-function-components.md b/content/en/docs/components/pipelines/legacy-v1/sdk/python-function-components.md similarity index 98% rename from content/en/docs/components/pipelines/v1/sdk/python-function-components.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/python-function-components.md index 451a92ab36..0d23302d38 100644 --- a/content/en/docs/components/pipelines/v1/sdk/python-function-components.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/python-function-components.md @@ -26,8 +26,8 @@ background-position: left center; } @@ -576,6 +576,6 @@ client.create_run_from_pipeline_func(calc_pipeline, arguments=arguments) \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v1/sdk/sdk-overview.md b/content/en/docs/components/pipelines/legacy-v1/sdk/sdk-overview.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/sdk-overview.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/sdk-overview.md diff --git a/content/en/docs/components/pipelines/v1/sdk/static-type-checking.md b/content/en/docs/components/pipelines/legacy-v1/sdk/static-type-checking.md similarity index 100% rename from content/en/docs/components/pipelines/v1/sdk/static-type-checking.md rename to content/en/docs/components/pipelines/legacy-v1/sdk/static-type-checking.md diff --git a/content/en/docs/components/pipelines/v1/troubleshooting.md b/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md similarity index 100% rename from content/en/docs/components/pipelines/v1/troubleshooting.md rename to content/en/docs/components/pipelines/legacy-v1/troubleshooting.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/_index.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/_index.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/_index.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/_index.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/api-pipelines.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/api-pipelines.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/api-pipelines.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/api-pipelines.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/benchmark-examples.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/benchmark-examples.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/build-pipeline.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/build-pipeline.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/cloud-tutorials.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/cloud-tutorials.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/cloud-tutorials.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/cloud-tutorials.md diff --git a/content/en/docs/components/pipelines/v1/tutorials/sdk-examples.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/sdk-examples.md similarity index 100% rename from content/en/docs/components/pipelines/v1/tutorials/sdk-examples.md rename to content/en/docs/components/pipelines/legacy-v1/tutorials/sdk-examples.md diff --git a/content/en/docs/components/pipelines/overview/_index.md b/content/en/docs/components/pipelines/overview/_index.md new file mode 100644 index 0000000000..1605a038f1 --- /dev/null +++ b/content/en/docs/components/pipelines/overview/_index.md @@ -0,0 +1,5 @@ ++++ +title = "Overview" +description = "Documentation for Kubeflow Pipelines." +weight = 1 ++++ diff --git a/content/en/docs/components/pipelines/v2/hello-world.md b/content/en/docs/components/pipelines/overview/getting-started.md similarity index 93% rename from content/en/docs/components/pipelines/v2/hello-world.md rename to content/en/docs/components/pipelines/overview/getting-started.md index ec0e123477..047b8579b9 100644 --- a/content/en/docs/components/pipelines/v2/hello-world.md +++ b/content/en/docs/components/pipelines/overview/getting-started.md @@ -1,5 +1,5 @@ +++ -title = "Hello World Pipeline" +title = "Getting started" description = "Create your first pipeline" weight = 3 +++ @@ -60,7 +60,7 @@ In the next few sections, you'll learn more about the core concepts of authoring [installation]: /docs/components/pipelines/v2/installation/ [client]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html#kfp.client.Client [compiler]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline#ir-yaml -[compile-a-pipeline]: /docs/components/pipelines/v2/compile-a-pipeline/ +[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml +[compile-a-pipeline]: /docs/components/pipelines/how-to/compile-a-pipeline/ [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component diff --git a/content/en/docs/components/pipelines/v2/installation/_index.md b/content/en/docs/components/pipelines/overview/installation/_index.md similarity index 74% rename from content/en/docs/components/pipelines/v2/installation/_index.md rename to content/en/docs/components/pipelines/overview/installation/_index.md index 6831f54664..0614b012e0 100644 --- a/content/en/docs/components/pipelines/v2/installation/_index.md +++ b/content/en/docs/components/pipelines/overview/installation/_index.md @@ -1,11 +1,11 @@ +++ title = "Installation" description = "Options for deploying Kubeflow Pipelines" -weight = 4 +weight = 2 +++ {{% kfp-v2-keywords %}} This page will be available soon. For similar information, see [KFP v1 installation documentation][v1-installation]. -[v1-installation]: /docs/components/pipelines/v1/installation/ \ No newline at end of file +[v1-installation]: /docs/components/pipelines/legacy-v1/installation/ \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/introduction.md b/content/en/docs/components/pipelines/overview/introduction.md similarity index 92% rename from content/en/docs/components/pipelines/v2/introduction.md rename to content/en/docs/components/pipelines/overview/introduction.md index 7e2a74d07a..573040edaf 100644 --- a/content/en/docs/components/pipelines/v2/introduction.md +++ b/content/en/docs/components/pipelines/overview/introduction.md @@ -40,7 +40,7 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more [components]: /docs/components/pipelines/v2/components [pipelines]: /docs/components/pipelines/v2/pipelines [installation]: /docs/components/pipelines/v2/installation -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ -[hello-world-pipeline]: /docs/components/pipelines/v2/hello-world -[control-flow]: /docs/components/pipelines/v2/pipelines/control-flow +[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[control-flow]: /docs/components/pipelines/how-to/control-flow diff --git a/content/en/docs/components/pipelines/v2/reference/_index.md b/content/en/docs/components/pipelines/reference/_index.md similarity index 87% rename from content/en/docs/components/pipelines/v2/reference/_index.md rename to content/en/docs/components/pipelines/reference/_index.md index 9db0aaf73e..a2ebea6c9e 100644 --- a/content/en/docs/components/pipelines/v2/reference/_index.md +++ b/content/en/docs/components/pipelines/reference/_index.md @@ -1,5 +1,5 @@ +++ title = "Reference" description = "Reference docs for Kubeflow Pipelines Version 2" -weight = 100 +weight = 3 +++ diff --git a/content/en/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec.html b/content/en/docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec.html similarity index 99% rename from content/en/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec.html rename to content/en/docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec.html index 61b77350c2..3b3ff44332 100644 --- a/content/en/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec.html +++ b/content/en/docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec.html @@ -1,7 +1,7 @@ +++ title = "Pipelines API Reference" description = "Reference documentation for the Kubeflow Pipelines API Version 2" -weight = 10 +weight = 3 +++ diff --git a/content/en/docs/components/pipelines/v2/community-and-support.md b/content/en/docs/components/pipelines/reference/community-and-support.md similarity index 99% rename from content/en/docs/components/pipelines/v2/community-and-support.md rename to content/en/docs/components/pipelines/reference/community-and-support.md index 9f60088b8b..d91d5191f0 100644 --- a/content/en/docs/components/pipelines/v2/community-and-support.md +++ b/content/en/docs/components/pipelines/reference/community-and-support.md @@ -1,7 +1,7 @@ +++ title = "Community and Support" description = "Where to get help, contribute, and learn more" -weight = 11 +weight = 1 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/v2/reference/sdk.md b/content/en/docs/components/pipelines/reference/sdk.md similarity index 95% rename from content/en/docs/components/pipelines/v2/reference/sdk.md rename to content/en/docs/components/pipelines/reference/sdk.md index ea160a2fc5..f333a2d5ac 100644 --- a/content/en/docs/components/pipelines/v2/reference/sdk.md +++ b/content/en/docs/components/pipelines/reference/sdk.md @@ -1,7 +1,7 @@ +++ title = " Pipelines SDK Reference" description = "Reference documentation for the Kubeflow Pipelines SDK Version 2" -weight = 20 +weight = 4 +++ diff --git a/content/en/docs/components/pipelines/v2/version-compatibility.md b/content/en/docs/components/pipelines/reference/version-compatibility.md similarity index 99% rename from content/en/docs/components/pipelines/v2/version-compatibility.md rename to content/en/docs/components/pipelines/reference/version-compatibility.md index a39607cb4b..1c4404ab53 100644 --- a/content/en/docs/components/pipelines/v2/version-compatibility.md +++ b/content/en/docs/components/pipelines/reference/version-compatibility.md @@ -1,7 +1,7 @@ +++ title = "Version Compatibility" description = "Version compatibility between KFP Runtime and KFP SDK" -weight = 80 +weight = 2 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/v2/_index.md b/content/en/docs/components/pipelines/v2/_index.md deleted file mode 100644 index 512c757502..0000000000 --- a/content/en/docs/components/pipelines/v2/_index.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = "v2" -description = "Kubeflow Pipelines v2 Documentation" -weight = 16 -+++ - -{{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/v2/administration/_index.md b/content/en/docs/components/pipelines/v2/administration/_index.md deleted file mode 100644 index b31690201e..0000000000 --- a/content/en/docs/components/pipelines/v2/administration/_index.md +++ /dev/null @@ -1,8 +0,0 @@ -+++ -title = "Administration" -description = "Guidance on managing your Kubeflow Pipelines instances" -weight = 5 -+++ - -When hosting Kubeflow and Kubeflow Pipelines, there are customizations and best practices -you can apply to faciliate the administration of the Kubeflow Pipelines control plane. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/data-types/_index.md b/content/en/docs/components/pipelines/v2/data-types/_index.md deleted file mode 100644 index ad7b8c396e..0000000000 --- a/content/en/docs/components/pipelines/v2/data-types/_index.md +++ /dev/null @@ -1,19 +0,0 @@ -+++ -title = "Data Types" -description = "Component and pipeline I/O types" -weight = 6 -+++ - -{{% kfp-v2-keywords %}} - -KFP components and pipelines can accept inputs and create outputs. To do so, they must declare typed interfaces through their function signatures and annotations. - -There are two groups of types in KFP: parameters and artifacts. Parameters are useful for passing small amounts of data between components. Artifacts types are the mechanism by which KFP provides first-class support for ML artifact outputs, such as datasets, models, metrics, etc. - -So far [Hello World pipeline][hello-world] and the examples in [Components][components] have demonstrated how to use input and output parameters. - -KFP automatically tracks the way parameters and artifacts are passed between components and stores the this data passing history in [ML Metadata][ml-metadata]. This enables out-of-the-box ML artifact lineage tracking and easily reproducible pipeline executions. Furthermore, KFP's strongly-typed components provide a data contract between tasks in a pipeline. - -[hello-world]: /docs/components/pipelines/v2/hello-world -[components]: /docs/components/pipelines/v2/components -[ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/v2/installation/quickstart.md b/content/en/docs/components/pipelines/v2/installation/quickstart.md deleted file mode 100644 index 1e1461a2de..0000000000 --- a/content/en/docs/components/pipelines/v2/installation/quickstart.md +++ /dev/null @@ -1,353 +0,0 @@ -+++ -title = "Quickstart" -description = "Get started with Kubeflow Pipelines" -weight = 2 -+++ - -{{% kfp-v2-keywords %}} - - - - -This tutorial helps you get started with deploying a KFP standalone instance, using KFP dashboard, and creating a pipeline with the KFP SDK. - -Before you begin, you need the following prerequisites: - -* **An existing Kubernetes cluster**: If you don't have a Kubernetes cluster, see [Installation][installation] for instructions about how to get one. - -* **The [kubectl](https://kubernetes.io/docs/tasks/tools/) command-line tool**: Install and configure your [kubectl context](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) to connect with your cluster. - -After you complete the prerequisites, click each section to view the instructions: - -
-

Deploy a KFP standalone instance into your cluster

- -This step demonstrates how to deploy a KFP standalone instance into an existing Kubernetes cluster. - -Run the following script after replacing `PIPELINE_VERSION` with the desired version of KFP (release are listed [here][releases]): - -```shell -export PIPELINE_VERSION={{% pipelines/latest-version %}} - -kubectl apply -k "github.com/kubeflow/pipelines/manifests/kustomize/cluster-scoped-resources?ref=$PIPELINE_VERSION" -kubectl wait --for condition=established --timeout=60s crd/applications.app.k8s.io -kubectl apply -k "github.com/kubeflow/pipelines/manifests/kustomize/env/dev?ref=$PIPELINE_VERSION" -``` - -After you deploy Kubernetes, obtain your KFP endpoint by following [these instructions][installation]. - -
- -
-

Run a basic pipeline - using KFP Dashboard and SDK

- -### **KFP Dashboard** ### - Kubeflow Pipelines offers a few samples that you can use to try out - Kubeflow Pipelines quickly. The steps below show you how to run a basic sample that - includes some Python operations, but doesn't include a machine learning (ML) - workload: - -1. Click the name of the sample, **[Tutorial] Data passing in python components**, on the pipelines UI: - Pipelines UI - -2. Click **Create run**: - Creating a run on the pipelines UI - -3. Follow the prompts to create a **run**. - The sample supplies default values for all the parameters you need. The - following screenshot assumes you are now creating a run named _My first run_: - Details page of creating a run on the pipelines UI - -4. Click **Start** to run the pipeline. - -5. Explore the graph and other aspects of your run by clicking on the nodes - (components) of the graph and the other UI elements: - Run results on the pipelines UI - -You can find the [source code for the **Data passing in python components** tutorial](https://github.com/kubeflow/pipelines/tree/2.0.0/samples/tutorials/Data%20passing%20in%20python%20components) in the Kubeflow Pipelines repo. - -### **KFP SDK** ### - This section shows how to use the KFP SDK to compose a pipeline and submit it for execution by KFP. - -* Run the following script to install the KFP SDK: - ```shell - pip install kfp - ``` - -The following simple pipeline adds two integers, and then adds another integer to the result to come up with a final sum. - -```python -from kfp import dsl -from kfp import client - - -@dsl.component -def addition_component(num1: int, num2: int) -> int: - return num1 + num2 - - -@dsl.pipeline(name='addition-pipeline') -def my_pipeline(a: int, b: int, c: int = 10): - add_task_1 = addition_component(num1=a, num2=b) - add_task_2 = addition_component(num1=add_task_1.output, num2=c) - - -endpoint = '' -kfp_client = client.Client(host=endpoint) -run = kfp_client.create_run_from_pipeline_func( - my_pipeline, - arguments={ - 'a': 1, - 'b': 2 - }, -) -url = f'{endpoint}/#/runs/details/{run.run_id}' -print(url) -``` - -The above code consists of the following parts: - -* In the first part, the following lines create a [Lightweight Python Component][lightweight-python-component] by using the `@dsl.component` decorator: - - ```python - @dsl.component - def addition_component(num1: int, num2: int) -> int: - return num1 + num2 - ``` - - The `@dsl.component` decorator transforms a Python function into a component, which can be used within a pipeline. You are required to specify the type annotations on the parameters as well as the return value, as these inform the KFP executor how to serialize and deserialize the data passed between components. The type annotations and return value also enable the KFP compiler to type check any data that is passed between pipeline tasks. - -* In the second part, the following lines [create a pipeline][pipelines] by using the `@dsl.pipeline` decorator: - - ```python - @dsl.pipeline(name='addition-pipeline') - def my_pipeline(a: int, b: int, c: int = 10): - ... - ``` - - Like the component decorator, the `@dsl.pipeline` decorator transforms a Python function into a pipeline that can be executed by the KFP backend. The pipeline can have arguments. These arguments also require type annotations. In this example, the argument `c` has a default value of `10`. - -* In the third part, the following lines connect the components together to form a computational directed acyclic graph (DAG) within the body of the pipeline function: - - ```python - add_task_1 = addition_component(num1=a, num2=b) - add_task_2 = addition_component(num1=add_task_1.output, num2=c) - ``` - - This example instantiates two different addition tasks from the same component named `addition_component`, by passing different arguments to the component function for each task, as follows: - * The first task accepts pipeline parameters `a` and `b` as input arguments. - * The second task accepts `add_task_1.output`, which is the output from `add_task_1`, as the first input argument. The pipeline parameter `c` is the second input argument. - - You must always pass component arguments as keyword arguments. - -* In the fourth part, the following lines instantiate a KFP client using the endpoint obtained in [deployment step](#kfp_qs_deployment) and submit the pipeline to the KFP backend with the required pipeline arguments: - - ```python - endpoint = '' - kfp_client = client.Client(host=endpoint) - run = kfp_client.create_run_from_pipeline_func( - my_pipeline, - arguments={ - 'a': 1, - 'b': 2 - }, - ) - url = f'{endpoint}/#/runs/details/{run.run_id}' - print(url) - ``` - - In this example, replace `endpoint` with the KFP endpoint URL you obtained in [deployment step](#kfp_qs_deployment). - - Alternatively, you can compile the pipeline to [IR YAML][ir-yaml] for use at another time: - - ```python - from kfp import compiler - - compiler.Compiler().compile(pipeline_func=my_pipeline, package_path='pipeline.yaml') - ``` -To view the pipeline run on the KFP Dashboard, go to the URL printed above. - -To view the details of each task, including input and output, click the appropriate task node. - - - - - -
- -
-

Build a more advanced ML pipeline

- -This step demonstrates how to build a more advanced machine learning (ML) pipeline that leverages additional KFP pipeline composition features. - -The following ML pipeline creates a dataset, normalizes the features of the dataset as a preprocessing step, and trains a simple ML model on the data using different hyperparameters: - -```python -from typing import List - -from kfp import client -from kfp import dsl -from kfp.dsl import Dataset -from kfp.dsl import Input -from kfp.dsl import Model -from kfp.dsl import Output - - -@dsl.component(packages_to_install=['pandas==1.3.5']) -def create_dataset(iris_dataset: Output[Dataset]): - import pandas as pd - - csv_url = 'https://archive.ics.uci.edu/ml/machine-learning-databases/iris/iris.data' - col_names = [ - 'Sepal_Length', 'Sepal_Width', 'Petal_Length', 'Petal_Width', 'Labels' - ] - df = pd.read_csv(csv_url, names=col_names) - - with open(iris_dataset.path, 'w') as f: - df.to_csv(f) - - -@dsl.component(packages_to_install=['pandas==1.3.5', 'scikit-learn==1.0.2']) -def normalize_dataset( - input_iris_dataset: Input[Dataset], - normalized_iris_dataset: Output[Dataset], - standard_scaler: bool, - min_max_scaler: bool, -): - if standard_scaler is min_max_scaler: - raise ValueError( - 'Exactly one of standard_scaler or min_max_scaler must be True.') - - import pandas as pd - from sklearn.preprocessing import MinMaxScaler - from sklearn.preprocessing import StandardScaler - - with open(input_iris_dataset.path) as f: - df = pd.read_csv(f) - labels = df.pop('Labels') - - if standard_scaler: - scaler = StandardScaler() - if min_max_scaler: - scaler = MinMaxScaler() - - df = pd.DataFrame(scaler.fit_transform(df)) - df['Labels'] = labels - with open(normalized_iris_dataset.path, 'w') as f: - df.to_csv(f) - - -@dsl.component(packages_to_install=['pandas==1.3.5', 'scikit-learn==1.0.2']) -def train_model( - normalized_iris_dataset: Input[Dataset], - model: Output[Model], - n_neighbors: int, -): - import pickle - - import pandas as pd - from sklearn.model_selection import train_test_split - from sklearn.neighbors import KNeighborsClassifier - - with open(normalized_iris_dataset.path) as f: - df = pd.read_csv(f) - - y = df.pop('Labels') - X = df - - X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=0) - - clf = KNeighborsClassifier(n_neighbors=n_neighbors) - clf.fit(X_train, y_train) - with open(model.path, 'wb') as f: - pickle.dump(clf, f) - - -@dsl.pipeline(name='iris-training-pipeline') -def my_pipeline( - standard_scaler: bool, - min_max_scaler: bool, - neighbors: List[int], -): - create_dataset_task = create_dataset() - - normalize_dataset_task = normalize_dataset( - input_iris_dataset=create_dataset_task.outputs['iris_dataset'], - standard_scaler=True, - min_max_scaler=False) - - with dsl.ParallelFor(neighbors) as n_neighbors: - train_model( - normalized_iris_dataset=normalize_dataset_task - .outputs['normalized_iris_dataset'], - n_neighbors=n_neighbors) - - -endpoint = '' -kfp_client = client.Client(host=endpoint) -run = kfp_client.create_run_from_pipeline_func( - my_pipeline, - arguments={ - 'min_max_scaler': True, - 'standard_scaler': False, - 'neighbors': [3, 6, 9] - }, -) -url = f'{endpoint}/#/runs/details/{run.run_id}' -print(url) -``` - -This example introduces the following new features in the pipeline: - -* Some Python **packages to install** are added at component runtime, using the `packages_to_install` argument on the `@dsl.component` decorator, as follows: - - `@dsl.component(packages_to_install=['pandas==1.3.5'])` - - To use a library after installing it, you must include its import statements within the scope of the component function, so that the library is imported at component runtime. - -* **Input and output artifacts** of types `Dataset` and `Model` are introduced in the component signature to describe the input and output artifacts of the components. This is done using the type annotation generics `Input[]` and `Output[]` for input and output artifacts respectively. - - Within the scope of a component, artifacts can be read (for inputs) and written (for outputs) via the `.path` attribute. The KFP backend ensures that *input* artifact files are copied *to* the executing pod's local file system from the remote storage at runtime, so that the component function can read input artifacts from the local file system. By comparison, *output* artifact files are copied *from* the local file system of the pod to remote storage, when the component finishes running. This way, the output artifacts persist outside the pod. In both cases, the component author needs to interact with the local file system only to create persistent artifacts. - - The arguments for the parameters annotated with `Output[]` are not passed to components by the pipeline author. The KFP backend passes this artifact during component runtime, so that component authors don't need to be concerned about the path to which the output artifacts are written. After an output artifact is written, the backend executing the component recognizes the KFP artifact types (`Dataset` or `Model`), and organizes them on the Dashboard. - - An output artifact can be passed as an input to a downstream component using the `.outputs` attribute of the source task and the output artifact parameter name, as follows: - - `create_dataset_task.outputs['iris_dataset']` - -* One of the **DSL control flow features**, `dsl.ParallelFor`, is used. It is a context manager that lets pipeline authors create tasks. These tasks execute in parallel in a loop. Using `dsl.ParallelFor` to iterate over the `neighbors` pipeline argument lets you execute the `train_model` component with different arguments and test multiple hyperparameters in one pipeline run. Other control flow features include `dsl.Condition` and `dsl.ExitHandler`. - -
- -Congratulations! You now have a KFP deployment, an end-to-end ML pipeline, and an introduction to the UI. That's just the beginning of KFP pipeline and Dashboard features. - - - -## Next steps - -* See [Installation][installation] for additional ways to deploy KFP -* See [Pipelines][pipelines] to learn more about features available when authoring pipelines - -[pipelines]: /docs/components/pipelines/v2/pipelines/ -[installation]: /docs/components/pipelines/v2/installation/ -[ir-yaml]: /docs/components/pipelines/v2/compile-a-pipeline/#ir-yaml -[lightweight-python-component]: /docs/components/pipelines/v2/components/lightweight-python-components -[releases]: https://github.com/kubeflow/pipelines/releases?q=Version&expanded=true diff --git a/content/en/docs/components/pipelines/v2/pipelines/_index.md b/content/en/docs/components/pipelines/v2/pipelines/_index.md deleted file mode 100644 index f423c28000..0000000000 --- a/content/en/docs/components/pipelines/v2/pipelines/_index.md +++ /dev/null @@ -1,9 +0,0 @@ -+++ -title = "Pipelines" -description = "Author KFP pipelines" -weight = 5 -+++ - -{{% kfp-v2-keywords %}} - -A *pipeline* is a definition of a workflow containing one or more tasks, including how tasks relate to each other to form a computational graph. Pipelines may have inputs which can be passed to tasks within the pipeline and may surface outputs created by tasks within the pipeline. Pipelines can themselves be used as components within other pipelines. \ No newline at end of file From 85598cea5f2ecaa80b2138abd5325fb2af29e6bf Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 21 May 2024 17:04:12 -0300 Subject: [PATCH 02/35] Fixed broken links Signed-off-by: hbelmiro --- content/en/_redirects | 2 ++ .../components/pipelines/how-to/artifacts.md | 10 +++++----- .../how-to/build-advanced-pipeline.md | 2 +- .../components/pipelines/how-to/caching.md | 2 +- .../pipelines/how-to/compile-a-pipeline.md | 2 +- .../compose-components-into-pipelines.md | 6 +++--- .../containerized-python-components.md | 2 +- .../lightweight-python-components.md | 2 +- .../components/pipelines/how-to/data-types.md | 19 +++++++++++++++++++ .../components/pipelines/how-to/migration.md | 8 ++++---- .../components/pipelines/how-to/parameters.md | 2 +- .../how-to/platform-specific-features.md | 8 ++++---- .../pipelines/how-to/server-config.md | 2 +- .../pipelines/legacy-v1/concepts/component.md | 2 +- .../legacy-v1/concepts/experiment.md | 2 +- .../pipelines/legacy-v1/concepts/graph.md | 2 +- .../legacy-v1/concepts/output-artifact.md | 2 +- .../pipelines/legacy-v1/concepts/pipeline.md | 4 ++-- .../legacy-v1/concepts/run-trigger.md | 2 +- .../pipelines/legacy-v1/concepts/run.md | 2 +- .../pipelines/legacy-v1/concepts/step.md | 2 +- .../installation/localcluster-deployment.md | 2 +- .../legacy-v1/installation/overview.md | 2 +- .../installation/standalone-deployment.md | 2 +- .../pipelines/legacy-v1/introduction.md | 14 +++++++------- .../legacy-v1/overview/interfaces.md | 4 ++-- .../legacy-v1/overview/multi-user.md | 2 +- .../legacy-v1/overview/quickstart.md | 4 ++-- .../pipelines/legacy-v1/sdk/best-practices.md | 4 ++-- .../legacy-v1/sdk/build-pipeline.ipynb | 2 +- .../pipelines/legacy-v1/sdk/build-pipeline.md | 2 +- .../pipelines/legacy-v1/sdk/connect-api.md | 2 +- .../legacy-v1/sdk/enviroment_variables.md | 2 +- .../pipelines/legacy-v1/sdk/install-sdk.md | 4 ++-- .../pipelines/legacy-v1/sdk/output-viewer.md | 4 ++-- .../legacy-v1/sdk/pipelines-with-tekton.md | 2 +- .../pipelines/legacy-v1/troubleshooting.md | 2 +- .../legacy-v1/tutorials/benchmark-examples.md | 2 +- .../legacy-v1/tutorials/build-pipeline.md | 4 ++-- .../pipelines/overview/getting-started.md | 2 +- .../pipelines/overview/introduction.md | 6 +++--- .../reference/version-compatibility.md | 4 ++-- .../components/training/user-guides/mpi.md | 2 +- .../feature-store/getting-started.md | 2 +- content/en/docs/started/support.md | 2 +- 45 files changed, 92 insertions(+), 71 deletions(-) create mode 100644 content/en/docs/components/pipelines/how-to/data-types.md diff --git a/content/en/_redirects b/content/en/_redirects index 8b9e380d98..857bea392f 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -38,6 +38,7 @@ /docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ /docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ /docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ +/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ /docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ /docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ /docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ @@ -47,6 +48,7 @@ /docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ /docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ /docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ +/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ # Restructured the pipelines docs. /docs/pipelines/ /docs/components/pipelines diff --git a/content/en/docs/components/pipelines/how-to/artifacts.md b/content/en/docs/components/pipelines/how-to/artifacts.md index 036c5a60a3..3b0ce48f60 100644 --- a/content/en/docs/components/pipelines/how-to/artifacts.md +++ b/content/en/docs/components/pipelines/how-to/artifacts.md @@ -1,6 +1,6 @@ +++ title = "Create, use, pass, and track ML artifacts" -weight = 10 +weight = 11 +++ {{% kfp-v2-keywords %}} @@ -195,7 +195,7 @@ def augment_and_train(dataset: Dataset) -> Model: The [KFP SDK compiler][compiler] will type check artifact usage according to the rules described in [Type Checking][type-checking]. -Please see [Pipeline Basics](pipelines) for comprehensive documentation on how to author a pipeline. +Please see [Pipeline Basics][pipelines] for comprehensive documentation on how to author a pipeline. ### Lists of artifacts @@ -241,13 +241,13 @@ On the [KFP open source][oss-be] UI, `ClassificationMetrics`, `SlicedClassificat [dsl-html]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.HTML [dsl-markdown]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Markdown [type-checking]: /docs/components/pipelines/how-to/compile-a-pipeline#type-checking -[oss-be]: /docs/components/pipelines/v2/installation/ -[pipelines]: /docs/components/pipelines/v2/pipelines/pipelines-basics/ +[oss-be]: /docs/components/pipelines/overview/installation/ +[pipelines]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ [container-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// [python-components]: /docs/components/pipelines/how-to/create-components/container-components [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Collected -[parallel-looping]: https://www.kubeflow.org/docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor +[parallel-looping]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor [traditional-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#traditional-artifact-syntax [multiple-outputs]: /docs/components/pipelines/how-to/parameters/#multiple-output-parameters [pythonic-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md b/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md index 6b151a0802..7cf829008b 100644 --- a/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md +++ b/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md @@ -1,6 +1,6 @@ +++ title = "Build a More Advanced ML Pipeline" -weight = 11 +weight = 12 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/how-to/caching.md b/content/en/docs/components/pipelines/how-to/caching.md index 7803380f4b..2bda0304d4 100644 --- a/content/en/docs/components/pipelines/how-to/caching.md +++ b/content/en/docs/components/pipelines/how-to/caching.md @@ -1,7 +1,7 @@ +++ title = "Use Caching" description = "How to use caching in Kubeflow Pipelines." -weight = 12 +weight = 13 +++ Kubeflow Pipelines support caching to eliminate redundant executions and improve diff --git a/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md b/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md index 77542f31d2..b84fcf40bc 100644 --- a/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md +++ b/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md @@ -113,5 +113,5 @@ While IR YAML is not intended to be easily human readable, you can still inspect [component-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L85-L96 [executor-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L788-L803 [dag-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L98-L105 -[data-types]: /docs/components/pipelines/v2/data-types +[data-types]: /docs/components/pipelines/how-to/data-types [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/compiler.html#kfp.compiler.Compiler.compile diff --git a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md index 7261a71eab..4d25314953 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md +++ b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md @@ -203,11 +203,11 @@ def pythagorean(a: float = 1.2, b: float = 1.2) -> float: [dsl-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline [control-flow]: /docs/components/pipelines/how-to/control-flow -[components]: /docs/components/pipelines/v2/components +[components]: /docs/components/pipelines/how-to/create-components [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction -[oss-be]: /docs/components/pipelines/v2/installation/ -[data-types]: /docs/components/pipelines/v2/data-types +[oss-be]: /docs/components/pipelines/overview/installation/ +[data-types]: /docs/components/pipelines/how-to/data-types [output-artifacts]: /docs/components/pipelines/how-to/artifacts#using-output-artifacts [container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs [parameters-namedtuple]: /docs/components/pipelines/how-to/parameters#multiple-output-parameters diff --git a/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md b/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md index 220ab2810f..bf599a3f53 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md @@ -109,4 +109,4 @@ Since `add`'s `target_image` uses [Google Cloud Artifact Registry][artifact-regi [artifact-registry]: https://cloud.google.com/artifact-registry/docs/docker/authentication [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [iam]: https://cloud.google.com/iam -[packages-to-install]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/lightweight-python-components//#packages_to_install \ No newline at end of file +[packages-to-install]: /docs/components/pipelines/how-to/create-components/lightweight-python-components#packages_to_install \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md index 4a6783cc39..b6a8f16108 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md @@ -129,7 +129,7 @@ Note that setting `install_kfp_package` to `False` is rarely necessary and is di [hello-world-pipeline]: /docs/components/pipelines/overview/getting-started [containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component -[data-types]: /docs/components/pipelines/v2/data-types +[data-types]: /docs/components/pipelines/how-to/data-types [parameters]: /docs/components/pipelines/how-to/parameters [artifacts]: /docs/components/pipelines/how-to/artifacts [requirements-txt]: https://pip.pypa.io/en/stable/reference/requirements-file-format/ diff --git a/content/en/docs/components/pipelines/how-to/data-types.md b/content/en/docs/components/pipelines/how-to/data-types.md new file mode 100644 index 0000000000..e6f52d97aa --- /dev/null +++ b/content/en/docs/components/pipelines/how-to/data-types.md @@ -0,0 +1,19 @@ ++++ +title = "Data Types" +description = "Component and pipeline I/O types" +weight = 9 ++++ + +{{% kfp-v2-keywords %}} + +KFP components and pipelines can accept inputs and create outputs. To do so, they must declare typed interfaces through their function signatures and annotations. + +There are two groups of types in KFP: parameters and artifacts. Parameters are useful for passing small amounts of data between components. Artifacts types are the mechanism by which KFP provides first-class support for ML artifact outputs, such as datasets, models, metrics, etc. + +So far [Hello World pipeline][hello-world] and the examples in [Components][components] have demonstrated how to use input and output parameters. + +KFP automatically tracks the way parameters and artifacts are passed between components and stores the this data passing history in [ML Metadata][ml-metadata]. This enables out-of-the-box ML artifact lineage tracking and easily reproducible pipeline executions. Furthermore, KFP's strongly-typed components provide a data contract between tasks in a pipeline. + +[hello-world]: /docs/components/pipelines/overview/getting-started +[components]: /docs/components/pipelines/how-to/create-components +[ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/migration.md b/content/en/docs/components/pipelines/how-to/migration.md index 9d3b505b27..47ee12de43 100644 --- a/content/en/docs/components/pipelines/how-to/migration.md +++ b/content/en/docs/components/pipelines/how-to/migration.md @@ -1,7 +1,7 @@ +++ title = "Migrate from KFP SDK v1" description = "v1 to v2 migration instructions and breaking changes" -weight = 14 +weight = 15 +++ {{% kfp-v2-keywords %}} @@ -580,7 +580,7 @@ If you believe we missed a breaking change or an important migration step, pleas [compile]: /docs/components/pipelines/how-to/compile-a-pipeline [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler.compile [components-load-component-from-file]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html#kfp.components.load_component_from_file -[container-components]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/containerized-python-components/ +[container-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components/ [containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components/ [create-custom-training-job-from-component]: https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.Collected @@ -593,7 +593,7 @@ If you believe we missed a breaking change or an important migration step, pleas [load]: /docs/components/pipelines/how-to/load-and-share-components/ [new-issue]: https://github.com/kubeflow/pipelines/issues/new [oss-be-v1]: /docs/components/pipelines/legacy-v1/ -[oss-be-v2]: /docs/components/pipelines/v2/installation/ +[oss-be-v2]: /docs/components/pipelines/overview/installation/ [parallelfor-control-flow]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor [parameters]: /docs/components/pipelines/how-to/parameters [pipelines-repo]: https://github.com/kubeflow/pipelines @@ -604,4 +604,4 @@ If you believe we missed a breaking change or an important migration step, pleas [vertex-sdk]: https://cloud.google.com/vertex-ai/docs/pipelines/run-pipeline#vertex-ai-sdk-for-python [argo]: https://argoproj.github.io/argo-workflows/ [dsl-pipelinetask-set-env-variable]: https://kubeflow-pipelines.readthedocs.io/en/2.0.0b13/source/dsl.html#kfp.dsl.PipelineTask.set_env_variable -[task-configuration-methods]: https://www.kubeflow.org/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file +[task-configuration-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/parameters.md b/content/en/docs/components/pipelines/how-to/parameters.md index 9502499f34..d0d37ab1b9 100644 --- a/content/en/docs/components/pipelines/how-to/parameters.md +++ b/content/en/docs/components/pipelines/how-to/parameters.md @@ -1,6 +1,6 @@ +++ title = "Pass small amounts of data between components" -weight = 9 +weight = 10 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/how-to/platform-specific-features.md b/content/en/docs/components/pipelines/how-to/platform-specific-features.md index 4ab934e110..ef5d369c09 100644 --- a/content/en/docs/components/pipelines/how-to/platform-specific-features.md +++ b/content/en/docs/components/pipelines/how-to/platform-specific-features.md @@ -1,6 +1,6 @@ +++ title = "Author Tasks with Platform-Specific Functionality" -weight = 15 +weight = 16 +++ @@ -106,7 +106,7 @@ For the full pipeline and more information, see a [similar example][full-example [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml -[oss-be]: /docs/components/pipelines/v2/installation/ +[oss-be]: /docs/components/pipelines/overview/installation/ [kfp-kubernetes-pypi]: https://pypi.org/project/kfp-kubernetes/ [task-level-config-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations [kfp-kubernetes-docs]: https://kfp-kubernetes.readthedocs.io/ @@ -114,5 +114,5 @@ For the full pipeline and more information, see a [similar example][full-example [storage-class]: https://kubernetes.io/docs/concepts/storage/storage-classes/ [access-mode]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes [full-example]: https://kfp-kubernetes.readthedocs.io/en/kfp-kubernetes-0.0.1/#persistentvolumeclaim-dynamically-create-pvc-mount-then-delete -[authoring-components]: http://localhost:1313/docs/components/pipelines/v2/components/ -[authoring-pipelines]: http://localhost:1313/docs/components/pipelines/v2/pipelines/ +[authoring-components]: http://localhost:1313/docs/components/pipelines/how-to/create-components/ +[authoring-pipelines]: http://localhost:1313/docs/components/pipelines/how-to/ diff --git a/content/en/docs/components/pipelines/how-to/server-config.md b/content/en/docs/components/pipelines/how-to/server-config.md index 3593230fb1..d511c1bf79 100644 --- a/content/en/docs/components/pipelines/how-to/server-config.md +++ b/content/en/docs/components/pipelines/how-to/server-config.md @@ -1,7 +1,7 @@ +++ title = "Server Configuration" description = "Guidance on managing your Kubeflow Pipelines instances" -weight = 13 +weight = 14 +++ diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/component.md b/content/en/docs/components/pipelines/legacy-v1/concepts/component.md index 962628a1bf..baa947c76a 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/component.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/component.md @@ -58,7 +58,7 @@ deserialize the data for use in the downstream component. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. * Build your own diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md b/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md index 2ab68e49c2..d8c1ed0730 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md @@ -13,6 +13,6 @@ groups. Experiments can contain arbitrary runs, including ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md b/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md index b6e3515268..51b3b91899 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md @@ -25,6 +25,6 @@ parent contains a conditional clause.) ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md b/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md index 33ffc9a6d4..b92605bfdc 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md @@ -16,7 +16,7 @@ data to rich interactive visualizations. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. * Read more about the available diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md b/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md index f57f238fb3..f45572b095 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md @@ -6,7 +6,7 @@ weight = 10 +++ A *pipeline* is a description of a machine learning (ML) workflow, including all -of the [components](/docs/components/pipelines/concepts/component/) in the workflow and how the components relate to each other in +of the [components](/docs/components/pipelines/legacy-v1/concepts/component/) in the workflow and how the components relate to each other in the form of a [graph](/docs/components/pipelines/concepts/graph/). The pipeline configuration includes the definition of the inputs (parameters) required to run the pipeline and the inputs and outputs of each component. @@ -19,6 +19,6 @@ After developing your pipeline, you can upload your pipeline using the Kubeflow ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md b/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md index 4ffd208713..47e3e5b2fd 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md @@ -16,6 +16,6 @@ available: ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/run.md b/content/en/docs/components/pipelines/legacy-v1/concepts/run.md index e48042b0c8..fd51d991ef 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/run.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/run.md @@ -26,6 +26,6 @@ triggered to run frequently. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/step.md b/content/en/docs/components/pipelines/legacy-v1/concepts/step.md index 240e116f57..be561a1b0b 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/step.md +++ b/content/en/docs/components/pipelines/legacy-v1/concepts/step.md @@ -14,6 +14,6 @@ an if/else like clause in the pipeline code. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md b/content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md index 219a37e9dc..5e728f65d9 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/localcluster-deployment.md @@ -16,7 +16,7 @@ Such deployment methods can be part of your local environment using the supplied kustomize manifests for test purposes. This guide is an alternative to [Deploying Kubeflow Pipelines -(KFP)](/docs/started/getting-started/#installing-kubeflow). +(KFP)](/docs/started/#installing-kubeflow). ## Before you get started diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/overview.md b/content/en/docs/components/pipelines/legacy-v1/installation/overview.md index e0679eb8d3..86abfb549f 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/overview.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/overview.md @@ -101,7 +101,7 @@ Use this option to deploy Kubeflow Pipelines to your local machine, on-premises, or to a cloud, as part of a full Kubeflow installation. Installation guide -: [Kubeflow installation guide](/docs/started/getting-started/) +: [Kubeflow installation guide](/docs/started/) Interfaces : diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md b/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md index cb1a3ab19f..583bfba219 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md @@ -5,7 +5,7 @@ weight = 30 +++ As an alternative to deploying Kubeflow Pipelines (KFP) as part of the -[Kubeflow deployment](/docs/started/getting-started/#installing-kubeflow), you also have a choice +[Kubeflow deployment](/docs/started/#installing-kubeflow), you also have a choice to deploy only Kubeflow Pipelines. Follow the instructions below to deploy Kubeflow Pipelines standalone using the supplied kustomize manifests. diff --git a/content/en/docs/components/pipelines/legacy-v1/introduction.md b/content/en/docs/components/pipelines/legacy-v1/introduction.md index 7087ab8a0a..0eafe96eb0 100644 --- a/content/en/docs/components/pipelines/legacy-v1/introduction.md +++ b/content/en/docs/components/pipelines/legacy-v1/introduction.md @@ -13,7 +13,7 @@ scalable machine learning (ML) workflows based on Docker containers. ## Quickstart Run your first pipeline by following the -[pipelines quickstart guide](/docs/components/pipelines/overview/quickstart). +[pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart). ## What is Kubeflow Pipelines? @@ -35,8 +35,8 @@ The following are the goals of Kubeflow Pipelines: Kubeflow Pipelines is available as a core component of Kubeflow or as a standalone installation. -* [Learn more about installing Kubeflow](/docs/started/getting-started/). -* [Learn more about installing Kubeflow Pipelines standalone](/docs/components/pipelines/installation/overview/). +* [Learn more about installing Kubeflow](/docs/started/). +* [Learn more about installing Kubeflow Pipelines standalone](/docs/components/pipelines/legacy-v1/overview/). {{% pipelines-compatibility %}} @@ -56,8 +56,8 @@ A _pipeline component_ is a self-contained set of user code, packaged as a performs one step in the pipeline. For example, a component can be responsible for data preprocessing, data transformation, model training, and so on. -See the conceptual guides to [pipelines](/docs/components/pipelines/concepts/pipeline/) -and [components](/docs/components/pipelines/concepts/component/). +See the conceptual guides to [pipelines](/docs/components/pipelines/legacy-v1/concepts/pipeline/) +and [components](/docs/components/pipelines/legacy-v1/concepts/component/). ## Example of a pipeline @@ -275,10 +275,10 @@ At a high level, the execution of a pipeline proceeds as follows: ## Next steps * Follow the - [pipelines quickstart guide](/docs/components/pipelines/overview/quickstart) to + [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. * Build machine-learning pipelines with the [Kubeflow Pipelines - SDK](/docs/components/pipelines/sdk/sdk-overview/). + SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/). * Follow the full guide to experimenting with [the Kubeflow Pipelines samples](/docs/components/pipelines/tutorials/build-pipeline/). diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md b/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md index 741d5400ac..cf30f60351 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md +++ b/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md @@ -33,7 +33,7 @@ From the Kubeflow Pipelines UI you can perform the following tasks: * Compare the results of one or more runs within an experiment. * Schedule runs by creating a recurring run. -See the [quickstart guide](/docs/components/pipelines/overview/quickstart/) for more +See the [quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) for more information about accessing the Kubeflow Pipelines UI and running the samples. When building a pipeline component, you can write out information for display @@ -47,7 +47,7 @@ The Kubeflow Pipelines SDK provides a set of Python packages that you can use to specify and run your ML workflows. See the [introduction to the Kubeflow Pipelines -SDK](/docs/components/pipelines/sdk/sdk-overview/) for an overview of the ways you can +SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/) for an overview of the ways you can use the SDK to build pipeline components and pipelines. ## REST API diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md b/content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md index 144e66c013..36457c6003 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md +++ b/content/en/docs/components/pipelines/legacy-v1/overview/multi-user.md @@ -7,7 +7,7 @@ weight = 30 Multi-user isolation for Kubeflow Pipelines is part of Kubeflow's overall [multi-tenancy](/docs/concepts/multi-tenancy/) feature. {{% alert title="Tip" color="info" %}} -* Kubeflow Pipelines multi-user isolation is only supported in ["full" Kubeflow deployments](/docs/components/pipelines/installation/overview/#full-kubeflow-deployment). +* Kubeflow Pipelines multi-user isolation is only supported in ["full" Kubeflow deployments](/docs/components/pipelines/legacy-v1/overview/#full-kubeflow-deployment). * Refer to docs about [profiles and namespaces](/docs/components/central-dash/profiles/) for the common Kubeflow multi-user operations like [managing profile contributors](/docs/components/central-dash/profiles/#manage-profile-contributors). {{% /alert %}} diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md b/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md index b8948decfd..1c380253e5 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md +++ b/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md @@ -15,7 +15,7 @@ Kubeflow Pipelines UI. ## Deploy Kubeflow and open the Kubeflow Pipelines UI -There are several options to [deploy Kubeflow Pipelines](/docs/components/pipelines/installation/overview/), follow the option that best suits your needs. If you are uncertain and just want to try out kubeflow pipelines it is recommended to start with the [standalone deployment](/docs/components/pipelines/installation/standalone-deployment/). +There are several options to [deploy Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/overview/), follow the option that best suits your needs. If you are uncertain and just want to try out kubeflow pipelines it is recommended to start with the [standalone deployment](/docs/components/pipelines/installation/standalone-deployment/). Once you have deployed Kubeflow Pipelines, make sure you can access the UI. The steps to access the UI vary based on the method you used to deploy Kubeflow Pipelines. @@ -101,4 +101,4 @@ You can find the [source code for the **XGBoost - Iterative model training** dem and run a sample from the code. See the guide to experimenting with [the Kubeflow Pipelines samples](/docs/components/pipelines/tutorials/build-pipeline/). * Build your own machine-learning pipelines with the [Kubeflow Pipelines - SDK](/docs/components/pipelines/sdk/sdk-overview/). + SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/). diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md b/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md index fadba01ad4..5226c88b93 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md @@ -13,8 +13,8 @@ This page describes some recommended practices for designing components. For an application of these best practices, see the [component development guide](/docs/components/pipelines/sdk/component-development). If you're new to pipelines, see the conceptual guides to -[pipelines](/docs/components/pipelines/concepts/pipeline/) -and [components](/docs/components/pipelines/concepts/component/). +[pipelines](/docs/components/pipelines/legacy-v1/concepts/pipeline/) +and [components](/docs/components/pipelines/legacy-v1/concepts/component/). ### General component design rules diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb index 89cbf5ced8..42f376d65c 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.ipynb @@ -516,7 +516,7 @@ "2. Upload and run your `pipeline.yaml` using the Kubeflow Pipelines user interface.\n", "See the guide to [getting started with the UI][quickstart].\n", "\n", - "[quickstart]: https://www.kubeflow.org/docs/components/pipelines/overview/quickstart" + "[quickstart]: https://www.kubeflow.org/docs/components/pipelines/legacy-v1/overview/quickstart" ] }, { diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md index 8fd670e2b6..ebbeb2504f 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/build-pipeline.md @@ -415,7 +415,7 @@ kfp.compiler.Compiler().compile( 2. Upload and run your `pipeline.yaml` using the Kubeflow Pipelines user interface. See the guide to [getting started with the UI][quickstart]. -[quickstart]: https://www.kubeflow.org/docs/components/pipelines/overview/quickstart +[quickstart]: https://www.kubeflow.org/docs/components/pipelines/legacy-v1/overview/quickstart #### Option 2: run the pipeline using Kubeflow Pipelines SDK client diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md b/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md index 9e2d230407..2dcba66c12 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md @@ -14,7 +14,7 @@ How to connect Pipelines SDK to Kubeflow Pipelines will depend on __what kind__ {{% alert title="Tip" color="info" %}} Before you begin, you will need to: -* [Deploy Kubeflow Pipelines](/docs/components/pipelines/installation/overview/) +* [Deploy Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/overview/) * [Install the Kubeflow Pipelines SDK](/docs/components/pipelines/sdk/install-sdk/) {{% /alert %}} diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md b/content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md index 157786ab14..fa5d4a3356 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/enviroment_variables.md @@ -16,7 +16,7 @@ components. Set up your environment: -- [Install Kubeflow](/docs/started/getting-started/) +- [Install Kubeflow](/docs/started/) - [Install the Kubeflow Pipelines SDK](/docs/components/pipelines/sdk/install-sdk/) diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md b/content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md index 4cd98bf720..b82ba0fec5 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/install-sdk.md @@ -115,7 +115,7 @@ The response should be something like this: ## Next steps -* [See how to use the SDK](/docs/components/pipelines/sdk/sdk-overview/). +* [See how to use the SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/). * [Build a component and a pipeline](/docs/components/pipelines/sdk/component-development/). -* [Get started with the UI](/docs/components/pipelines/overview/quickstart). +* [Get started with the UI](/docs/components/pipelines/legacy-v1/overview/quickstart). * [Understand pipeline concepts](/docs/components/pipelines/concepts/). diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md index bd7a0e4adf..ea26d4e5bc 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md @@ -7,7 +7,7 @@ weight = 80 This page shows you how to use the Kubeflow Pipelines UI to visualize output -from a Kubeflow Pipelines [component](/docs/components/pipelines/concepts/component/). +from a Kubeflow Pipelines [component](/docs/components/pipelines/legacy-v1/concepts/component/). ## Introduction @@ -730,7 +730,7 @@ pre-installed when you deploy Kubeflow. You can run the sample by selecting **[Sample] ML - TFX - Taxi Tip Prediction Model Trainer** from the Kubeflow Pipelines UI. For help getting started with the UI, follow the -[Kubeflow Pipelines quickstart](/docs/components/pipelines/overview/quickstart/). +[Kubeflow Pipelines quickstart](/docs/components/pipelines/legacy-v1/overview/quickstart/). The pipeline uses a number of prebuilt, reusable components, including: diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md b/content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md index 7c8e019c31..5fcb9953d8 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton.md @@ -11,7 +11,7 @@ to compile, upload and run your Kubeflow Pipeline DSL Python scripts on a ## SDK packages -The `kfp-tekton` SDK is an extension to the [Kubeflow Pipelines SDK](/docs/components/pipelines/sdk/sdk-overview/) +The `kfp-tekton` SDK is an extension to the [Kubeflow Pipelines SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/) adding the `TektonCompiler` and the `TektonClient`: * `kfp_tekton.compiler` includes classes and methods for compiling pipeline diff --git a/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md b/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md index 93919252c1..fa057025ef 100644 --- a/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md +++ b/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md @@ -11,7 +11,7 @@ may encounter. ## Diagnosing problems in your Kubeflow Pipelines environment For help diagnosing environment issues that affect Kubeflow Pipelines, run -the [`kfp diagnose_me` command-line tool](/docs/components/pipelines/sdk/sdk-overview/#kfp-cli-tool). +the [`kfp diagnose_me` command-line tool](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/#kfp-cli-tool). The `kfp diagnose_me` CLI reports on the configuration of your local development environment, Kubernetes cluster, or Google Cloud environment. diff --git a/content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md index 2803250895..df4c90afa9 100644 --- a/content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md +++ b/content/en/docs/components/pipelines/legacy-v1/tutorials/benchmark-examples.md @@ -51,7 +51,7 @@ To run the provided benchmark scripts, you need the following: run, job, and experiment services from your Jupyter notebook environment. * A Kubeflow Pipelines cluster. If you do not have a Kubeflow Pipelines cluster, learn more about your [options for installing Kubeflow - Pipelines](/docs/components/pipelines/installation/overview/). + Pipelines](/docs/components/pipelines/legacy-v1/overview/). * A pipeline manifest. For example, this guide uses the [taxi_updated_pool.yaml](https://storage.googleapis.com/ml-pipeline/sample-benchmark/taxi_updated_pool.yaml) pipeline manifest file. diff --git a/content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md b/content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md index 73477b3a75..1b13256a5e 100644 --- a/content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md +++ b/content/en/docs/components/pipelines/legacy-v1/tutorials/build-pipeline.md @@ -64,7 +64,7 @@ dsl-compile --py ${DIR}/sequential.py --output ${DIR}/sequential.tar.gz ### Deploy the pipeline Upload the generated `.tar.gz` file through the Kubeflow Pipelines UI. See the -guide to [getting started with the UI](/docs/components/pipelines/overview/quickstart). +guide to [getting started with the UI](/docs/components/pipelines/legacy-v1/overview/quickstart). ## Building a pipeline in a Jupyter notebook @@ -127,7 +127,7 @@ The following notebooks are available: ## Next steps * Learn the various ways to use the [Kubeflow Pipelines - SDK](/docs/components/pipelines/sdk/sdk-overview/). + SDK](/docs/components/pipelines/legacy-v1/sdk/sdk-overview/). * See how to [build your own pipeline components](/docs/components/pipelines/sdk/build-component/). * Read more about diff --git a/content/en/docs/components/pipelines/overview/getting-started.md b/content/en/docs/components/pipelines/overview/getting-started.md index 047b8579b9..1bcae1fcd7 100644 --- a/content/en/docs/components/pipelines/overview/getting-started.md +++ b/content/en/docs/components/pipelines/overview/getting-started.md @@ -57,7 +57,7 @@ The client will print a link to view the pipeline execution graph and logs in th In the next few sections, you'll learn more about the core concepts of authoring pipelines and how to create more expressive, useful pipelines. -[installation]: /docs/components/pipelines/v2/installation/ +[installation]: /docs/components/pipelines/overview/installation/ [client]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html#kfp.client.Client [compiler]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml diff --git a/content/en/docs/components/pipelines/overview/introduction.md b/content/en/docs/components/pipelines/overview/introduction.md index 573040edaf..e8f9e71d14 100644 --- a/content/en/docs/components/pipelines/overview/introduction.md +++ b/content/en/docs/components/pipelines/overview/introduction.md @@ -37,9 +37,9 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more * Learn more about [authoring components][components] * Learn more about [authoring pipelines][pipelines] -[components]: /docs/components/pipelines/v2/components -[pipelines]: /docs/components/pipelines/v2/pipelines -[installation]: /docs/components/pipelines/v2/installation +[components]: /docs/components/pipelines/how-to/create-components +[pipelines]: /docs/components/pipelines/how-to +[installation]: /docs/components/pipelines/overview/installation [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ [hello-world-pipeline]: /docs/components/pipelines/overview/getting-started diff --git a/content/en/docs/components/pipelines/reference/version-compatibility.md b/content/en/docs/components/pipelines/reference/version-compatibility.md index 1c4404ab53..58fbe2a609 100644 --- a/content/en/docs/components/pipelines/reference/version-compatibility.md +++ b/content/en/docs/components/pipelines/reference/version-compatibility.md @@ -33,5 +33,5 @@ For more detailed information on feature support, please refer to the version-sp * [Kubeflow Pipelines v1][kfp-v1-doc] * [Kubeflow Pipelines v2][kfp-v2-doc] -[kfp-v1-doc]: /docs/components/pipelines/v1 -[kfp-v2-doc]: /docs/components/pipelines/v2 +[kfp-v1-doc]: /docs/components/pipelines/legacy-v1 +[kfp-v2-doc]: /docs/components/pipelines/ diff --git a/content/en/docs/components/training/user-guides/mpi.md b/content/en/docs/components/training/user-guides/mpi.md index a5b9d4f496..77e260b842 100644 --- a/content/en/docs/components/training/user-guides/mpi.md +++ b/content/en/docs/components/training/user-guides/mpi.md @@ -28,7 +28,7 @@ cd mpi-operator kubectl apply -f deploy/v2beta1/mpi-operator.yaml ``` -Alternatively, follow the [getting started guide](https://www.kubeflow.org/docs/started/getting-started/) to deploy Kubeflow. +Alternatively, follow the [getting started guide](https://www.kubeflow.org/docs/started/) to deploy Kubeflow. An alpha version of MPI support was introduced with Kubeflow 0.2.0. You must be using a version of Kubeflow newer than 0.2.0. diff --git a/content/en/docs/external-add-ons/feature-store/getting-started.md b/content/en/docs/external-add-ons/feature-store/getting-started.md index 092d161b00..6af064d684 100644 --- a/content/en/docs/external-add-ons/feature-store/getting-started.md +++ b/content/en/docs/external-add-ons/feature-store/getting-started.md @@ -13,7 +13,7 @@ For an overview of Feast, please read [Introduction to Feast](/docs/external-add **Overview** -* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/getting-started/). +* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/). * This guide also assumes that you have a running online feature store that Feast supports (Redis, Datastore, DynamoDB). * The latest version of Feast does not need to be installed into Kubernetes. It is possible to run Feast completely from CI or as a client library (during training or inference) * Feast requires a bucket (S3, GCS, Minio, etc) to maintain a feature registry, requires an online feature store for serving feature values, and it requires a scheduler to keep the online store up to date. diff --git a/content/en/docs/started/support.md b/content/en/docs/started/support.md index 5c5f901157..17940918bc 100644 --- a/content/en/docs/started/support.md +++ b/content/en/docs/started/support.md @@ -112,7 +112,7 @@ You can ask questions and make suggestions in the following places: * **Kubeflow documentation** for overviews and how-to guides. In particular, refer to the following documents when troubleshooting a problem: - * [Kubeflow installation and setup](/docs/started/getting-started/) + * [Kubeflow installation and setup](/docs/started/) * [Kubeflow components](/docs/components/) * [Further setup and troubleshooting](/docs/other-guides/) From 77abd75561d304bf264981d8476e412ee287f304 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Wed, 22 May 2024 13:42:06 -0300 Subject: [PATCH 03/35] Moved new redirects to the end of the file Signed-off-by: hbelmiro --- content/en/_redirects | 58 +++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/content/en/_redirects b/content/en/_redirects index 857bea392f..06c2254c58 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -21,35 +21,6 @@ # Removed redundant UI guide. Quickstart is a better destination. /docs/pipelines/pipelines-ui/ /docs/components/pipelines/pipelines-quickstart/ -# Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) -/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ -/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ -/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ -/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ -/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ -/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ -/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ -/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ -/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ -/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ -/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ -/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ -/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ -/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ -/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ -/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ -/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ -/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ -/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ -/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ -/docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ -/docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ -/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ -/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ - # Restructured the pipelines docs. /docs/pipelines/ /docs/components/pipelines /docs/pipelines/output-viewer/ /docs/components/pipelines/sdk/output-viewer/ @@ -270,3 +241,32 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/katib/early-stopping /docs/components/katib/user-guides/early-stopping /docs/components/katib/resume-experiment /docs/components/katib/user-guides/resume-experiment /docs/components/katib/trial-template /docs/components/katib/user-guides/trial-template + +# Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) +/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ +/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ +/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ +/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ +/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ +/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ +/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ +/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ +/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ +/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ +/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ +/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ +/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ +/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ +/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ +/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ +/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ +/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ +/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ +/docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ +/docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ +/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ +/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ \ No newline at end of file From f092ea6c571a8a71d8a366691d6d5c3bd64788ab Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Wed, 22 May 2024 17:03:06 -0300 Subject: [PATCH 04/35] Renamed How-to/User guides to User guides Signed-off-by: hbelmiro --- content/en/docs/components/pipelines/how-to/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/components/pipelines/how-to/_index.md b/content/en/docs/components/pipelines/how-to/_index.md index e589995726..f1419ccb45 100644 --- a/content/en/docs/components/pipelines/how-to/_index.md +++ b/content/en/docs/components/pipelines/how-to/_index.md @@ -1,5 +1,5 @@ +++ -title = "How-to/User guides" +title = "User guides" description = "Documentation for Kubeflow Pipelines." weight = 2 +++ From 05a98052f730ae8cfe8b65e3783d8575a2b99af8 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Thu, 30 May 2024 12:08:10 -0300 Subject: [PATCH 05/35] Fixed redirects Signed-off-by: hbelmiro --- content/en/_redirects | 113 +++++++++++++++++++++++++++++++----------- 1 file changed, 83 insertions(+), 30 deletions(-) diff --git a/content/en/_redirects b/content/en/_redirects index 06c2254c58..ff04344b25 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -183,8 +183,90 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/overview/concepts/* /docs/components/pipelines/concepts/:splat /docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat +# Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) +/docs/components/pipelines/v1/introduction/ /docs/components/pipelines/legacy-v1/introduction/ +/docs/components/pipelines/v1/overview/ /docs/components/pipelines/legacy-v1/overview/ +/docs/components/pipelines/v1/overview/quickstart/ /docs/components/pipelines/legacy-v1/overview/quickstart/ +/docs/components/pipelines/v1/overview/interfaces/ /docs/components/pipelines/legacy-v1/overview/interfaces/ +/docs/components/pipelines/v1/overview/multi-user/ /docs/components/pipelines/legacy-v1/overview/multi-user/ +/docs/components/pipelines/v1/overview/caching/ /docs/components/pipelines/legacy-v1/overview/caching/ +/docs/components/pipelines/v1/overview/pipeline-root/ /docs/components/pipelines/legacy-v1/overview/pipeline-root/ +/docs/components/pipelines/v1/concepts/ /docs/components/pipelines/legacy-v1/concepts/ +/docs/components/pipelines/v1/concepts/pipeline/ /docs/components/pipelines/legacy-v1/concepts/pipeline/ +/docs/components/pipelines/v1/concepts/component/ /docs/components/pipelines/legacy-v1/concepts/component/ +/docs/components/pipelines/v1/concepts/graph/ /docs/components/pipelines/legacy-v1/concepts/graph/ +/docs/components/pipelines/v1/concepts/experiment/ /docs/components/pipelines/legacy-v1/concepts/experiment/ +/docs/components/pipelines/v1/concepts/run/ /docs/components/pipelines/legacy-v1/concepts/run/ +/docs/components/pipelines/v1/concepts/run-trigger/ /docs/components/pipelines/legacy-v1/concepts/run-trigger/ +/docs/components/pipelines/v1/concepts/step/ /docs/components/pipelines/legacy-v1/concepts/step/ +/docs/components/pipelines/v1/concepts/output-artifact/ /docs/components/pipelines/legacy-v1/concepts/output-artifact/ +/docs/components/pipelines/v1/concepts/metadata/ /docs/components/pipelines/legacy-v1/concepts/metadata/ +/docs/components/pipelines/v1/installation/ /docs/components/pipelines/legacy-v1/installation/ +/docs/components/pipelines/v1/installation/overview/ /docs/components/pipelines/legacy-v1/installation/overview/ +/docs/components/pipelines/v1/installation/localcluster-deployment/ /docs/components/pipelines/legacy-v1/installation/localcluster-deployment/ +/docs/components/pipelines/v1/installation/standalone-deployment/ /docs/components/pipelines/legacy-v1/installation/standalone-deployment/ +/docs/components/pipelines/v1/installation/choose-executor/ /docs/components/pipelines/legacy-v1/installation/choose-executor/ +/docs/components/pipelines/v1/installation/upgrade/ /docs/components/pipelines/legacy-v1/compatibility-matrix/ +/docs/components/pipelines/v1/sdk/ /docs/components/pipelines/legacy-v1/sdk/ +/docs/components/pipelines/v1/sdk/sdk-overview/ /docs/components/pipelines/legacy-v1/sdk/sdk-overview/ +/docs/components/pipelines/v1/sdk/install-sdk/ /docs/components/pipelines/legacy-v1/sdk/install-sdk/ +/docs/components/pipelines/v1/sdk/connect-api/ /docs/components/pipelines/legacy-v1/sdk/connect-api/ +/docs/components/pipelines/v1/sdk/build-pipeline/ /docs/components/pipelines/legacy-v1/sdk/build-pipeline/ +/docs/components/pipelines/v1/sdk/component-development/ /docs/components/pipelines/legacy-v1/sdk/component-development/ +/docs/components/pipelines/v1/sdk/python-function-components/ /docs/components/pipelines/legacy-v1/sdk/python-function-components/ +/docs/components/pipelines/v1/sdk/best-practices/ /docs/components/pipelines/legacy-v1/sdk/best-practices/ +/docs/components/pipelines/v1/sdk/parameters/ /docs/components/pipelines/legacy-v1/sdk/parameters/ +/docs/components/pipelines/v1/sdk/output-viewer/ /docs/components/pipelines/legacy-v1/sdk/output-viewer/ +/docs/components/pipelines/v1/sdk/static-type-checking/ /docs/components/pipelines/legacy-v1/sdk/static-type-checking/ +/docs/components/pipelines/v1/sdk/dsl-recursion/ /docs/components/pipelines/legacy-v1/sdk/dsl-recursion/ +/docs/components/pipelines/v1/sdk/enviroment_variables/ /docs/components/pipelines/legacy-v1/sdk/enviroment_variables/ +/docs/components/pipelines/v1/sdk/gcp/ /docs/components/pipelines/legacy-v1/sdk/gcp/ +/docs/components/pipelines/v1/sdk/pipelines-with-tekton/ /docs/components/pipelines/legacy-v1/sdk/pipelines-with-tekton/ +/docs/components/pipelines/v1/sdk/manipulate-resources/ /docs/components/pipelines/legacy-v1/sdk/manipulate-resources/ +/docs/components/pipelines/v1/sdk/python-based-visualizations/ /docs/components/pipelines/legacy-v1/sdk/python-based-visualizations/ +/docs/components/pipelines/v1/tutorials/ /docs/components/pipelines/legacy-v1/tutorials/ +/docs/components/pipelines/v1/tutorials/benchmark-examples/ /docs/components/pipelines/legacy-v1/tutorials/benchmark-examples/ +/docs/components/pipelines/v1/tutorials/sdk-examples/ /docs/components/pipelines/legacy-v1/tutorials/sdk-examples/ +/docs/components/pipelines/v1/tutorials/api-pipelines/ /docs/components/pipelines/legacy-v1/tutorials/api-pipelines/ +/docs/components/pipelines/v1/tutorials/build-pipeline/ /docs/components/pipelines/legacy-v1/tutorials/build-pipeline/ +/docs/components/pipelines/v1/tutorials/cloud-tutorials/ /docs/components/pipelines/legacy-v1/tutorials/cloud-tutorials/ +/docs/components/pipelines/v1/troubleshooting/ /docs/components/pipelines/legacy-v1/troubleshooting/ +/docs/components/pipelines/v1/reference/ /docs/components/pipelines/legacy-v1/reference/ +/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/legacy-v1/reference/component-spec/ +/docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ +/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/legacy-v1/reference/component-spec/ +/docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ +/docs/components/pipelines/v1/reference/sdk/ /docs/components/pipelines/legacy-v1/reference/sdk/ +/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ +/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ +/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ +/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ +/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ +/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ +/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ +/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ +/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ +/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ +/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ +/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ +/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ +/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ +/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ +/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ +/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ +/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ +/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ +/docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ +/docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ +/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ +/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ + # pipelines v1 -> v2 redirects -/docs/components/pipelines/* /docs/components/pipelines/legacy-v1/:splat +/docs/components/pipelines/* /docs/components/pipelines/v1/:splat # Restructure About section /docs/about/kubeflow /docs/started/introduction @@ -241,32 +323,3 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/katib/early-stopping /docs/components/katib/user-guides/early-stopping /docs/components/katib/resume-experiment /docs/components/katib/user-guides/resume-experiment /docs/components/katib/trial-template /docs/components/katib/user-guides/trial-template - -# Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) -/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ -/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ -/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ -/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ -/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ -/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ -/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ -/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ -/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ -/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ -/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ -/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ -/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ -/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ -/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ -/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ -/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ -/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ -/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ -/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ -/docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ -/docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ -/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ -/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ \ No newline at end of file From 8632993af567bd19d4d61ea03b324d5c27f9bca8 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Thu, 30 May 2024 14:33:47 -0300 Subject: [PATCH 06/35] Removed double slash typo Signed-off-by: hbelmiro --- content/en/_index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/_index.html b/content/en/_index.html index f56ebc6dee..39418aec27 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -41,7 +41,7 @@

Kubeflow Components

- + Kubeflow Components
Pipelines

- Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes. + Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes.

From d430d0ab2793643c7384e5b093571d25af7dc73f Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Thu, 30 May 2024 14:37:40 -0300 Subject: [PATCH 07/35] Fixed "Legacy v1" title Signed-off-by: hbelmiro --- content/en/docs/components/pipelines/legacy-v1/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/components/pipelines/legacy-v1/_index.md b/content/en/docs/components/pipelines/legacy-v1/_index.md index d94954e55b..ea5de38c93 100644 --- a/content/en/docs/components/pipelines/legacy-v1/_index.md +++ b/content/en/docs/components/pipelines/legacy-v1/_index.md @@ -1,5 +1,5 @@ +++ -title = "Legacy-v1" +title = "Legacy v1" description = "Kubeflow Pipelines v1 Documentation" weight = 999 +++ From bbfcccaab1c4797e34feaa20563603a6f43d663e Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Thu, 30 May 2024 14:46:02 -0300 Subject: [PATCH 08/35] Added "Operator Guides" section Signed-off-by: hbelmiro --- content/en/_redirects | 4 ++-- content/en/docs/components/pipelines/how-to/_index.md | 6 +++--- content/en/docs/components/pipelines/how-to/artifacts.md | 2 +- .../create-components/compose-components-into-pipelines.md | 2 +- content/en/docs/components/pipelines/how-to/migration.md | 2 +- .../pipelines/how-to/platform-specific-features.md | 2 +- .../en/docs/components/pipelines/operator-guides/_index.md | 5 +++++ .../{overview => operator-guides}/installation/_index.md | 2 +- .../pipelines/{how-to => operator-guides}/server-config.md | 2 +- .../docs/components/pipelines/overview/getting-started.md | 2 +- .../en/docs/components/pipelines/overview/introduction.md | 2 +- content/en/docs/components/pipelines/reference/_index.md | 2 +- 12 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 content/en/docs/components/pipelines/operator-guides/_index.md rename content/en/docs/components/pipelines/{overview => operator-guides}/installation/_index.md (96%) rename content/en/docs/components/pipelines/{how-to => operator-guides}/server-config.md (99%) diff --git a/content/en/_redirects b/content/en/_redirects index ff04344b25..a78408060c 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -238,7 +238,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/v1/reference/sdk/ /docs/components/pipelines/legacy-v1/reference/sdk/ /docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/installation/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/operator-guides/installation/ /docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ /docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ @@ -257,7 +257,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ /docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ /docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ -/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/how-to/server-config/ +/docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/operator-guides/server-config/ /docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ /docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ /docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ diff --git a/content/en/docs/components/pipelines/how-to/_index.md b/content/en/docs/components/pipelines/how-to/_index.md index f1419ccb45..7736465904 100644 --- a/content/en/docs/components/pipelines/how-to/_index.md +++ b/content/en/docs/components/pipelines/how-to/_index.md @@ -1,5 +1,5 @@ +++ -title = "User guides" -description = "Documentation for Kubeflow Pipelines." -weight = 2 +title = "User Guides" +description = "Documentation for users of Kubeflow Pipelines." +weight = 3 +++ diff --git a/content/en/docs/components/pipelines/how-to/artifacts.md b/content/en/docs/components/pipelines/how-to/artifacts.md index 3b0ce48f60..7d5dead183 100644 --- a/content/en/docs/components/pipelines/how-to/artifacts.md +++ b/content/en/docs/components/pipelines/how-to/artifacts.md @@ -241,7 +241,7 @@ On the [KFP open source][oss-be] UI, `ClassificationMetrics`, `SlicedClassificat [dsl-html]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.HTML [dsl-markdown]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Markdown [type-checking]: /docs/components/pipelines/how-to/compile-a-pipeline#type-checking -[oss-be]: /docs/components/pipelines/overview/installation/ +[oss-be]: /docs/components/pipelines/operator-guides/installation/ [pipelines]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ [container-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// [python-components]: /docs/components/pipelines/how-to/create-components/container-components diff --git a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md index 4d25314953..ddefd140b1 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md +++ b/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md @@ -206,7 +206,7 @@ def pythagorean(a: float = 1.2, b: float = 1.2) -> float: [components]: /docs/components/pipelines/how-to/create-components [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction -[oss-be]: /docs/components/pipelines/overview/installation/ +[oss-be]: /docs/components/pipelines/operator-guides/installation/ [data-types]: /docs/components/pipelines/how-to/data-types [output-artifacts]: /docs/components/pipelines/how-to/artifacts#using-output-artifacts [container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs diff --git a/content/en/docs/components/pipelines/how-to/migration.md b/content/en/docs/components/pipelines/how-to/migration.md index 47ee12de43..dc7edce0e1 100644 --- a/content/en/docs/components/pipelines/how-to/migration.md +++ b/content/en/docs/components/pipelines/how-to/migration.md @@ -593,7 +593,7 @@ If you believe we missed a breaking change or an important migration step, pleas [load]: /docs/components/pipelines/how-to/load-and-share-components/ [new-issue]: https://github.com/kubeflow/pipelines/issues/new [oss-be-v1]: /docs/components/pipelines/legacy-v1/ -[oss-be-v2]: /docs/components/pipelines/overview/installation/ +[oss-be-v2]: /docs/components/pipelines/operator-guides/installation/ [parallelfor-control-flow]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor [parameters]: /docs/components/pipelines/how-to/parameters [pipelines-repo]: https://github.com/kubeflow/pipelines diff --git a/content/en/docs/components/pipelines/how-to/platform-specific-features.md b/content/en/docs/components/pipelines/how-to/platform-specific-features.md index ef5d369c09..4928f6b16b 100644 --- a/content/en/docs/components/pipelines/how-to/platform-specific-features.md +++ b/content/en/docs/components/pipelines/how-to/platform-specific-features.md @@ -106,7 +106,7 @@ For the full pipeline and more information, see a [similar example][full-example [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml -[oss-be]: /docs/components/pipelines/overview/installation/ +[oss-be]: /docs/components/pipelines/operator-guides/installation/ [kfp-kubernetes-pypi]: https://pypi.org/project/kfp-kubernetes/ [task-level-config-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations [kfp-kubernetes-docs]: https://kfp-kubernetes.readthedocs.io/ diff --git a/content/en/docs/components/pipelines/operator-guides/_index.md b/content/en/docs/components/pipelines/operator-guides/_index.md new file mode 100644 index 0000000000..16b860a5b8 --- /dev/null +++ b/content/en/docs/components/pipelines/operator-guides/_index.md @@ -0,0 +1,5 @@ ++++ +title = "Operator Guides" +description = "Documentation for operators of Kubeflow Pipelines." +weight = 2 ++++ diff --git a/content/en/docs/components/pipelines/overview/installation/_index.md b/content/en/docs/components/pipelines/operator-guides/installation/_index.md similarity index 96% rename from content/en/docs/components/pipelines/overview/installation/_index.md rename to content/en/docs/components/pipelines/operator-guides/installation/_index.md index 0614b012e0..ed68cf7c94 100644 --- a/content/en/docs/components/pipelines/overview/installation/_index.md +++ b/content/en/docs/components/pipelines/operator-guides/installation/_index.md @@ -1,7 +1,7 @@ +++ title = "Installation" description = "Options for deploying Kubeflow Pipelines" -weight = 2 +weight = 1 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/how-to/server-config.md b/content/en/docs/components/pipelines/operator-guides/server-config.md similarity index 99% rename from content/en/docs/components/pipelines/how-to/server-config.md rename to content/en/docs/components/pipelines/operator-guides/server-config.md index d511c1bf79..5aa6da86a6 100644 --- a/content/en/docs/components/pipelines/how-to/server-config.md +++ b/content/en/docs/components/pipelines/operator-guides/server-config.md @@ -1,7 +1,7 @@ +++ title = "Server Configuration" description = "Guidance on managing your Kubeflow Pipelines instances" -weight = 14 +weight = 2 +++ diff --git a/content/en/docs/components/pipelines/overview/getting-started.md b/content/en/docs/components/pipelines/overview/getting-started.md index 1bcae1fcd7..7968556a06 100644 --- a/content/en/docs/components/pipelines/overview/getting-started.md +++ b/content/en/docs/components/pipelines/overview/getting-started.md @@ -57,7 +57,7 @@ The client will print a link to view the pipeline execution graph and logs in th In the next few sections, you'll learn more about the core concepts of authoring pipelines and how to create more expressive, useful pipelines. -[installation]: /docs/components/pipelines/overview/installation/ +[installation]: /docs/components/pipelines/operator-guides/installation/ [client]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html#kfp.client.Client [compiler]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml diff --git a/content/en/docs/components/pipelines/overview/introduction.md b/content/en/docs/components/pipelines/overview/introduction.md index e8f9e71d14..21234a547e 100644 --- a/content/en/docs/components/pipelines/overview/introduction.md +++ b/content/en/docs/components/pipelines/overview/introduction.md @@ -39,7 +39,7 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more [components]: /docs/components/pipelines/how-to/create-components [pipelines]: /docs/components/pipelines/how-to -[installation]: /docs/components/pipelines/overview/installation +[installation]: /docs/components/pipelines/operator-guides/installation [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ [hello-world-pipeline]: /docs/components/pipelines/overview/getting-started diff --git a/content/en/docs/components/pipelines/reference/_index.md b/content/en/docs/components/pipelines/reference/_index.md index a2ebea6c9e..7301d15226 100644 --- a/content/en/docs/components/pipelines/reference/_index.md +++ b/content/en/docs/components/pipelines/reference/_index.md @@ -1,5 +1,5 @@ +++ title = "Reference" description = "Reference docs for Kubeflow Pipelines Version 2" -weight = 3 +weight = 4 +++ From 00103fd9eaafb6b3028c775d3ddeb88e0dbb7cbe Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 08:27:15 -0300 Subject: [PATCH 09/35] Added brackets to Legacy page Signed-off-by: hbelmiro --- content/en/docs/components/pipelines/legacy-v1/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/components/pipelines/legacy-v1/_index.md b/content/en/docs/components/pipelines/legacy-v1/_index.md index ea5de38c93..31e350846b 100644 --- a/content/en/docs/components/pipelines/legacy-v1/_index.md +++ b/content/en/docs/components/pipelines/legacy-v1/_index.md @@ -1,5 +1,5 @@ +++ -title = "Legacy v1" +title = "Legacy (v1)" description = "Kubeflow Pipelines v1 Documentation" weight = 999 +++ From 58297c826fa78a83c89f23a21b231eae04fa7a74 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 08:48:18 -0300 Subject: [PATCH 10/35] Moved Introduction and getting-started.md to the root Signed-off-by: hbelmiro --- content/en/_index.html | 4 ++-- content/en/_redirects | 6 +++--- .../components/pipelines/{overview => }/getting-started.md | 2 +- content/en/docs/components/pipelines/how-to/_index.md | 2 +- .../how-to/create-components/container-components.md | 2 +- .../create-components/lightweight-python-components.md | 2 +- content/en/docs/components/pipelines/how-to/data-types.md | 2 +- .../en/docs/components/pipelines/operator-guides/_index.md | 2 +- .../pipelines/{overview/introduction.md => overview.md} | 4 ++-- content/en/docs/components/pipelines/overview/_index.md | 5 ----- content/en/docs/components/pipelines/reference/_index.md | 2 +- 11 files changed, 14 insertions(+), 19 deletions(-) rename content/en/docs/components/pipelines/{overview => }/getting-started.md (99%) rename content/en/docs/components/pipelines/{overview/introduction.md => overview.md} (96%) delete mode 100644 content/en/docs/components/pipelines/overview/_index.md diff --git a/content/en/_index.html b/content/en/_index.html index 39418aec27..9b4c57f928 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -41,7 +41,7 @@

Kubeflow Components

- + Kubeflow Components
Pipelines

- Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes. + Kubeflow Pipelines (KFP) is a platform for building then deploying portable and scalable machine learning workflows using Kubernetes.

diff --git a/content/en/_redirects b/content/en/_redirects index a78408060c..5351d0dc58 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -237,11 +237,11 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/legacy-v1/reference/component-spec/ /docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/v1/reference/sdk/ /docs/components/pipelines/legacy-v1/reference/sdk/ -/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/operator-guides/installation/ -/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/overview/getting-started/ +/docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/getting-started/ /docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ -/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/introduction/ +/docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/ /docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ /docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ /docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ diff --git a/content/en/docs/components/pipelines/overview/getting-started.md b/content/en/docs/components/pipelines/getting-started.md similarity index 99% rename from content/en/docs/components/pipelines/overview/getting-started.md rename to content/en/docs/components/pipelines/getting-started.md index 7968556a06..7122464287 100644 --- a/content/en/docs/components/pipelines/overview/getting-started.md +++ b/content/en/docs/components/pipelines/getting-started.md @@ -1,7 +1,7 @@ +++ title = "Getting started" description = "Create your first pipeline" -weight = 3 +weight = 2 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/how-to/_index.md b/content/en/docs/components/pipelines/how-to/_index.md index 7736465904..1862eedce8 100644 --- a/content/en/docs/components/pipelines/how-to/_index.md +++ b/content/en/docs/components/pipelines/how-to/_index.md @@ -1,5 +1,5 @@ +++ title = "User Guides" description = "Documentation for users of Kubeflow Pipelines." -weight = 3 +weight = 5 +++ diff --git a/content/en/docs/components/pipelines/how-to/create-components/container-components.md b/content/en/docs/components/pipelines/how-to/create-components/container-components.md index 1045097ee0..ea84a494d6 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/container-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/container-components.md @@ -184,7 +184,7 @@ def hello_someone(optional_name: str = None): Arguments to `then` and `else_` may be a list of any combination of static strings, upstream outputs, pipeline parameters, or other instances of `dsl.ConcatPlaceholder` or `dsl.IfPresentPlaceholder` -[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[hello-world-pipeline]: /docs/components/pipelines/getting-started [pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines [alpine]: https://hub.docker.com/_/alpine [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath diff --git a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md index b6a8f16108..e6c2f0e116 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md +++ b/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md @@ -126,7 +126,7 @@ By default, Python Components install `kfp` at runtime. This is required to defi Note that setting `install_kfp_package` to `False` is rarely necessary and is discouraged for the majority of use cases. -[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[hello-world-pipeline]: /docs/components/pipelines/getting-started [containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component [data-types]: /docs/components/pipelines/how-to/data-types diff --git a/content/en/docs/components/pipelines/how-to/data-types.md b/content/en/docs/components/pipelines/how-to/data-types.md index e6f52d97aa..28d2d217d8 100644 --- a/content/en/docs/components/pipelines/how-to/data-types.md +++ b/content/en/docs/components/pipelines/how-to/data-types.md @@ -14,6 +14,6 @@ So far [Hello World pipeline][hello-world] and the examples in [Components][comp KFP automatically tracks the way parameters and artifacts are passed between components and stores the this data passing history in [ML Metadata][ml-metadata]. This enables out-of-the-box ML artifact lineage tracking and easily reproducible pipeline executions. Furthermore, KFP's strongly-typed components provide a data contract between tasks in a pipeline. -[hello-world]: /docs/components/pipelines/overview/getting-started +[hello-world]: /docs/components/pipelines/getting-started [components]: /docs/components/pipelines/how-to/create-components [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/operator-guides/_index.md b/content/en/docs/components/pipelines/operator-guides/_index.md index 16b860a5b8..8c1b4fa1b2 100644 --- a/content/en/docs/components/pipelines/operator-guides/_index.md +++ b/content/en/docs/components/pipelines/operator-guides/_index.md @@ -1,5 +1,5 @@ +++ title = "Operator Guides" description = "Documentation for operators of Kubeflow Pipelines." -weight = 2 +weight = 4 +++ diff --git a/content/en/docs/components/pipelines/overview/introduction.md b/content/en/docs/components/pipelines/overview.md similarity index 96% rename from content/en/docs/components/pipelines/overview/introduction.md rename to content/en/docs/components/pipelines/overview.md index 21234a547e..0876f6dd6d 100644 --- a/content/en/docs/components/pipelines/overview/introduction.md +++ b/content/en/docs/components/pipelines/overview.md @@ -1,5 +1,5 @@ +++ -title = "Introduction" +title = "Overview" description = "What is Kubeflow Pipelines?" weight = 1 +++ @@ -42,5 +42,5 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more [installation]: /docs/components/pipelines/operator-guides/installation [ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ -[hello-world-pipeline]: /docs/components/pipelines/overview/getting-started +[hello-world-pipeline]: /docs/components/pipelines/getting-started [control-flow]: /docs/components/pipelines/how-to/control-flow diff --git a/content/en/docs/components/pipelines/overview/_index.md b/content/en/docs/components/pipelines/overview/_index.md deleted file mode 100644 index 1605a038f1..0000000000 --- a/content/en/docs/components/pipelines/overview/_index.md +++ /dev/null @@ -1,5 +0,0 @@ -+++ -title = "Overview" -description = "Documentation for Kubeflow Pipelines." -weight = 1 -+++ diff --git a/content/en/docs/components/pipelines/reference/_index.md b/content/en/docs/components/pipelines/reference/_index.md index 7301d15226..78b5dcdf86 100644 --- a/content/en/docs/components/pipelines/reference/_index.md +++ b/content/en/docs/components/pipelines/reference/_index.md @@ -1,5 +1,5 @@ +++ title = "Reference" description = "Reference docs for Kubeflow Pipelines Version 2" -weight = 4 +weight = 6 +++ From f4be4d3cdd1105817eaca2be24f4dc0f8a20fbb3 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 08:50:46 -0300 Subject: [PATCH 11/35] Reverted changes to other components Signed-off-by: hbelmiro --- .../en/docs/external-add-ons/feature-store/getting-started.md | 2 +- content/en/docs/started/support.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/external-add-ons/feature-store/getting-started.md b/content/en/docs/external-add-ons/feature-store/getting-started.md index 6af064d684..966041013d 100644 --- a/content/en/docs/external-add-ons/feature-store/getting-started.md +++ b/content/en/docs/external-add-ons/feature-store/getting-started.md @@ -13,7 +13,7 @@ For an overview of Feast, please read [Introduction to Feast](/docs/external-add **Overview** -* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/). +* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/getting-started). * This guide also assumes that you have a running online feature store that Feast supports (Redis, Datastore, DynamoDB). * The latest version of Feast does not need to be installed into Kubernetes. It is possible to run Feast completely from CI or as a client library (during training or inference) * Feast requires a bucket (S3, GCS, Minio, etc) to maintain a feature registry, requires an online feature store for serving feature values, and it requires a scheduler to keep the online store up to date. diff --git a/content/en/docs/started/support.md b/content/en/docs/started/support.md index 17940918bc..5c5f901157 100644 --- a/content/en/docs/started/support.md +++ b/content/en/docs/started/support.md @@ -112,7 +112,7 @@ You can ask questions and make suggestions in the following places: * **Kubeflow documentation** for overviews and how-to guides. In particular, refer to the following documents when troubleshooting a problem: - * [Kubeflow installation and setup](/docs/started/) + * [Kubeflow installation and setup](/docs/started/getting-started/) * [Kubeflow components](/docs/components/) * [Further setup and troubleshooting](/docs/other-guides/) From 566ab755ca63f50647a475ad83af863e0481d510 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 08:54:33 -0300 Subject: [PATCH 12/35] Removed catch-all redirects and moved new redirects to the bottom of the file Signed-off-by: hbelmiro --- content/en/_redirects | 119 ++++++++++++++++++++---------------------- 1 file changed, 57 insertions(+), 62 deletions(-) diff --git a/content/en/_redirects b/content/en/_redirects index 5351d0dc58..9b59eb39db 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -180,8 +180,62 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/pipeline-root /docs/components/pipelines/overview/pipeline-root /docs/components/pipelines/overview/pipelines-overview /docs/components/pipelines/introduction /docs/components/pipelines/pipelines-quickstart /docs/components/pipelines/overview/quickstart -/docs/components/pipelines/overview/concepts/* /docs/components/pipelines/concepts/:splat -/docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat + +# Restructure About section +/docs/about/kubeflow /docs/started/introduction +/docs/started/kubeflow-overview /docs/started/architecture + +# move istio from external-add-ons to multi-tenancy component +/docs/external-add-ons/istio/* /docs/components/multi-tenancy/istio + +# merge multi-tenancy/getting-started with profiles +/docs/components/multi-tenancy/getting-started /docs/components/central-dash/profiles + +# move multi-tenancy to concepts +/docs/components/multi-tenancy/design /docs/concepts/multi-tenancy/design +/docs/components/multi-tenancy/istio /docs/concepts/multi-tenancy/istio +/docs/components/multi-tenancy/overview /docs/concepts/multi-tenancy/overview +/docs/components/multi-tenancy /docs/concepts/multi-tenancy + +# remove registration-flow page +/docs/components/central-dash/registration-flow /docs/components/central-dash/profiles + +# rename customize dashboard page +/docs/components/central-dash/customizing-menu /docs/components/central-dash/customize + +# =============== +# IMPORTANT NOTE: +# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom +# =============== +/docs/guides/* /docs/:splat +/docs/pipelines/concepts/* /docs/components/pipelines/overview/concepts/:splat +/docs/pipelines/* /docs/components/pipelines/:splat +/docs/aws/* /docs/distributions/aws/ +/docs/azure/* /docs/distributions/azure/:splat +/docs/gke/* /docs/distributions/gke/:splat +/docs/ibm/* /docs/distributions/ibm/:splat +/docs/openshift/* /docs/distributions/openshift/:splat +/docs/components/fairing/* /docs/external-add-ons/fairing/:splat +/docs/components/istio/* /docs/external-add-ons/istio/:splat +/docs/components/feature-store/* /docs/external-add-ons/feature-store/:splat +/docs/components/serving/* /docs/external-add-ons/serving/:splat + +# redirect distribution pages to external websites +/docs/distributions/aws/* https://awslabs.github.io/kubeflow-manifests/ +/docs/distributions/azure/* https://azure.github.io/kubeflow-aks/main/ +/docs/distributions/charmed/* https://charmed-kubeflow.io/ +/docs/distributions/ekf/* https://www.arrikto.com/enterprise-kubeflow/ +/docs/distributions/gke/* https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/:splat +/docs/distributions/ibm/* https://ibm.github.io/manifests/ +/docs/distributions/nutanix/* https://nutanix.github.io/kubeflow-manifests/ + +# Refactor Katib docs +/docs/components/hyperparameter /docs/components/katib/overview +/docs/components/katib/hyperparameter /docs/components/katib/getting-started +/docs/components/katib/experiment /docs/components/katib/user-guides/hp-tuning/configure-experiment +/docs/components/katib/early-stopping /docs/components/katib/user-guides/early-stopping +/docs/components/katib/resume-experiment /docs/components/katib/user-guides/resume-experiment +/docs/components/katib/trial-template /docs/components/katib/user-guides/trial-template # Restructured the pipeline docs (https://github.com/kubeflow/website/issues/3716) /docs/components/pipelines/v1/introduction/ /docs/components/pipelines/legacy-v1/introduction/ @@ -263,63 +317,4 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ /docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ /docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ -/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ - -# pipelines v1 -> v2 redirects -/docs/components/pipelines/* /docs/components/pipelines/v1/:splat - -# Restructure About section -/docs/about/kubeflow /docs/started/introduction -/docs/started/kubeflow-overview /docs/started/architecture - -# move istio from external-add-ons to multi-tenancy component -/docs/external-add-ons/istio/* /docs/components/multi-tenancy/istio - -# merge multi-tenancy/getting-started with profiles -/docs/components/multi-tenancy/getting-started /docs/components/central-dash/profiles - -# move multi-tenancy to concepts -/docs/components/multi-tenancy/design /docs/concepts/multi-tenancy/design -/docs/components/multi-tenancy/istio /docs/concepts/multi-tenancy/istio -/docs/components/multi-tenancy/overview /docs/concepts/multi-tenancy/overview -/docs/components/multi-tenancy /docs/concepts/multi-tenancy - -# remove registration-flow page -/docs/components/central-dash/registration-flow /docs/components/central-dash/profiles - -# rename customize dashboard page -/docs/components/central-dash/customizing-menu /docs/components/central-dash/customize - -# =============== -# IMPORTANT NOTE: -# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom -# =============== -/docs/guides/* /docs/:splat -/docs/pipelines/concepts/* /docs/components/pipelines/overview/concepts/:splat -/docs/pipelines/* /docs/components/pipelines/:splat -/docs/aws/* /docs/distributions/aws/ -/docs/azure/* /docs/distributions/azure/:splat -/docs/gke/* /docs/distributions/gke/:splat -/docs/ibm/* /docs/distributions/ibm/:splat -/docs/openshift/* /docs/distributions/openshift/:splat -/docs/components/fairing/* /docs/external-add-ons/fairing/:splat -/docs/components/istio/* /docs/external-add-ons/istio/:splat -/docs/components/feature-store/* /docs/external-add-ons/feature-store/:splat -/docs/components/serving/* /docs/external-add-ons/serving/:splat - -# redirect distribution pages to external websites -/docs/distributions/aws/* https://awslabs.github.io/kubeflow-manifests/ -/docs/distributions/azure/* https://azure.github.io/kubeflow-aks/main/ -/docs/distributions/charmed/* https://charmed-kubeflow.io/ -/docs/distributions/ekf/* https://www.arrikto.com/enterprise-kubeflow/ -/docs/distributions/gke/* https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/:splat -/docs/distributions/ibm/* https://ibm.github.io/manifests/ -/docs/distributions/nutanix/* https://nutanix.github.io/kubeflow-manifests/ - -# Refactor Katib docs -/docs/components/hyperparameter /docs/components/katib/overview -/docs/components/katib/hyperparameter /docs/components/katib/getting-started -/docs/components/katib/experiment /docs/components/katib/user-guides/hp-tuning/configure-experiment -/docs/components/katib/early-stopping /docs/components/katib/user-guides/early-stopping -/docs/components/katib/resume-experiment /docs/components/katib/user-guides/resume-experiment -/docs/components/katib/trial-template /docs/components/katib/user-guides/trial-template +/docs/components/pipelines/overview/quickstart/ /docs/components/pipelines/overview/ \ No newline at end of file From d6f66922c703f73374c8bbf18db45907b08f70aa Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 09:03:42 -0300 Subject: [PATCH 13/35] Renamed the how-to directory to user-guides Signed-off-by: hbelmiro --- content/en/_redirects | 36 +++++++++---------- .../components/pipelines/getting-started.md | 4 +-- .../en/docs/components/pipelines/overview.md | 8 ++--- .../{how-to => user-guides}/_index.md | 0 .../{how-to => user-guides}/artifacts.md | 16 ++++----- .../build-advanced-pipeline.md | 0 .../{how-to => user-guides}/caching.md | 0 .../pipelines/{how-to => user-guides}/cli.md | 4 +-- .../compile-a-pipeline.md | 2 +- .../{how-to => user-guides}/control-flow.md | 4 +-- .../create-components/_index.md | 0 .../additional-functionality.md | 4 +-- .../compose-components-into-pipelines.md | 14 ++++---- .../create-components/container-components.md | 2 +- .../containerized-python-components.md | 4 +-- .../create-components/importer-component.md | 4 +-- .../lightweight-python-components.md | 8 ++--- .../{how-to => user-guides}/data-types.md | 2 +- .../execute-kfp-pipelines-locally.md | 6 ++-- .../load-and-share-components.md | 2 +- .../{how-to => user-guides}/migration.md | 24 ++++++------- .../{how-to => user-guides}/parameters.md | 8 ++--- .../platform-specific-features.md | 8 ++--- .../{how-to => user-guides}/run-a-pipeline.md | 4 +-- 24 files changed, 82 insertions(+), 82 deletions(-) rename content/en/docs/components/pipelines/{how-to => user-guides}/_index.md (100%) rename content/en/docs/components/pipelines/{how-to => user-guides}/artifacts.md (93%) rename content/en/docs/components/pipelines/{how-to => user-guides}/build-advanced-pipeline.md (100%) rename content/en/docs/components/pipelines/{how-to => user-guides}/caching.md (100%) rename content/en/docs/components/pipelines/{how-to => user-guides}/cli.md (95%) rename content/en/docs/components/pipelines/{how-to => user-guides}/compile-a-pipeline.md (99%) rename content/en/docs/components/pipelines/{how-to => user-guides}/control-flow.md (97%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/_index.md (100%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/additional-functionality.md (95%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/compose-components-into-pipelines.md (93%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/container-components.md (98%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/containerized-python-components.md (95%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/importer-component.md (93%) rename content/en/docs/components/pipelines/{how-to => user-guides}/create-components/lightweight-python-components.md (95%) rename content/en/docs/components/pipelines/{how-to => user-guides}/data-types.md (94%) rename content/en/docs/components/pipelines/{how-to => user-guides}/execute-kfp-pipelines-locally.md (94%) rename content/en/docs/components/pipelines/{how-to => user-guides}/load-and-share-components.md (94%) rename content/en/docs/components/pipelines/{how-to => user-guides}/migration.md (93%) rename content/en/docs/components/pipelines/{how-to => user-guides}/parameters.md (92%) rename content/en/docs/components/pipelines/{how-to => user-guides}/platform-specific-features.md (94%) rename content/en/docs/components/pipelines/{how-to => user-guides}/run-a-pipeline.md (95%) diff --git a/content/en/_redirects b/content/en/_redirects index 9b59eb39db..ddcb111460 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -294,26 +294,26 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/operator-guides/installation/ /docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/getting-started/ -/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/how-to/run-a-pipeline/ +/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/user-guides/run-a-pipeline/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/ -/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/how-to/compile-a-pipeline/ -/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/how-to/execute-kfp-pipelines-locally/ -/docs/components/pipelines/v2/cli/ /docs/components/pipelines/how-to/cli/ -/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ -/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/how-to/create-components/containerized-python-components/ -/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/how-to/create-components/container-components/ -/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/how-to/create-components/importer-component/ -/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/how-to/create-components/additional-functionality/ -/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/how-to/load-and-share-components/ -/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/how-to/control-flow/ -/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/how-to/data-types/ -/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/how-to/parameters/ -/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/how-to/artifacts/ -/docs/components/pipelines/v2/caching/ /docs/components/pipelines/how-to/caching/ +/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/user-guides/compile-a-pipeline/ +/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/user-guides/execute-kfp-pipelines-locally/ +/docs/components/pipelines/v2/cli/ /docs/components/pipelines/user-guides/cli/ +/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ +/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/ +/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/user-guides/create-components/containerized-python-components/ +/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/user-guides/create-components/container-components/ +/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/user-guides/create-components/importer-component/ +/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/user-guides/create-components/additional-functionality/ +/docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/user-guides/load-and-share-components/ +/docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/user-guides/control-flow/ +/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/user-guides/data-types/ +/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/user-guides/parameters/ +/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/user-guides/artifacts/ +/docs/components/pipelines/v2/caching/ /docs/components/pipelines/user-guides/caching/ /docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/operator-guides/server-config/ -/docs/components/pipelines/v2/migration/ /docs/components/pipelines/how-to/migration/ -/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/how-to/platform-specific-features/ +/docs/components/pipelines/v2/migration/ /docs/components/pipelines/user-guides/migration/ +/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/user-guides/platform-specific-features/ /docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ /docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ /docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ diff --git a/content/en/docs/components/pipelines/getting-started.md b/content/en/docs/components/pipelines/getting-started.md index 7122464287..eb1757801a 100644 --- a/content/en/docs/components/pipelines/getting-started.md +++ b/content/en/docs/components/pipelines/getting-started.md @@ -60,7 +60,7 @@ In the next few sections, you'll learn more about the core concepts of authoring [installation]: /docs/components/pipelines/operator-guides/installation/ [client]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html#kfp.client.Client [compiler]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler -[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml -[compile-a-pipeline]: /docs/components/pipelines/how-to/compile-a-pipeline/ +[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml +[compile-a-pipeline]: /docs/components/pipelines/user-guides/compile-a-pipeline/ [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component diff --git a/content/en/docs/components/pipelines/overview.md b/content/en/docs/components/pipelines/overview.md index 0876f6dd6d..ba4f216a08 100644 --- a/content/en/docs/components/pipelines/overview.md +++ b/content/en/docs/components/pipelines/overview.md @@ -37,10 +37,10 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more * Learn more about [authoring components][components] * Learn more about [authoring pipelines][pipelines] -[components]: /docs/components/pipelines/how-to/create-components -[pipelines]: /docs/components/pipelines/how-to +[components]: /docs/components/pipelines/user-guides/create-components +[pipelines]: /docs/components/pipelines/user-guides [installation]: /docs/components/pipelines/operator-guides/installation -[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ [hello-world-pipeline]: /docs/components/pipelines/getting-started -[control-flow]: /docs/components/pipelines/how-to/control-flow +[control-flow]: /docs/components/pipelines/user-guides/control-flow diff --git a/content/en/docs/components/pipelines/how-to/_index.md b/content/en/docs/components/pipelines/user-guides/_index.md similarity index 100% rename from content/en/docs/components/pipelines/how-to/_index.md rename to content/en/docs/components/pipelines/user-guides/_index.md diff --git a/content/en/docs/components/pipelines/how-to/artifacts.md b/content/en/docs/components/pipelines/user-guides/artifacts.md similarity index 93% rename from content/en/docs/components/pipelines/how-to/artifacts.md rename to content/en/docs/components/pipelines/user-guides/artifacts.md index 7d5dead183..a068be8324 100644 --- a/content/en/docs/components/pipelines/how-to/artifacts.md +++ b/content/en/docs/components/pipelines/user-guides/artifacts.md @@ -240,14 +240,14 @@ On the [KFP open source][oss-be] UI, `ClassificationMetrics`, `SlicedClassificat [dsl-slicedclassificationmetrics]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.SlicedClassificationMetrics [dsl-html]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.HTML [dsl-markdown]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Markdown -[type-checking]: /docs/components/pipelines/how-to/compile-a-pipeline#type-checking +[type-checking]: /docs/components/pipelines/user-guides/compile-a-pipeline#type-checking [oss-be]: /docs/components/pipelines/operator-guides/installation/ -[pipelines]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/ -[container-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// -[python-components]: /docs/components/pipelines/how-to/create-components/container-components +[pipelines]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/ +[container-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components// +[python-components]: /docs/components/pipelines/user-guides/create-components/container-components [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Collected -[parallel-looping]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor -[traditional-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#traditional-artifact-syntax -[multiple-outputs]: /docs/components/pipelines/how-to/parameters/#multiple-output-parameters -[pythonic-artifact-syntax]: /docs/components/pipelines/how-to/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file +[parallel-looping]: /docs/components/pipelines/user-guides/control-flow/#parallel-looping-dslparallelfor +[traditional-artifact-syntax]: /docs/components/pipelines/user-guides/artifacts/#traditional-artifact-syntax +[multiple-outputs]: /docs/components/pipelines/user-guides/parameters/#multiple-output-parameters +[pythonic-artifact-syntax]: /docs/components/pipelines/user-guides/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md b/content/en/docs/components/pipelines/user-guides/build-advanced-pipeline.md similarity index 100% rename from content/en/docs/components/pipelines/how-to/build-advanced-pipeline.md rename to content/en/docs/components/pipelines/user-guides/build-advanced-pipeline.md diff --git a/content/en/docs/components/pipelines/how-to/caching.md b/content/en/docs/components/pipelines/user-guides/caching.md similarity index 100% rename from content/en/docs/components/pipelines/how-to/caching.md rename to content/en/docs/components/pipelines/user-guides/caching.md diff --git a/content/en/docs/components/pipelines/how-to/cli.md b/content/en/docs/components/pipelines/user-guides/cli.md similarity index 95% rename from content/en/docs/components/pipelines/how-to/cli.md rename to content/en/docs/components/pipelines/user-guides/cli.md index 9ce4186c9f..4befa16055 100644 --- a/content/en/docs/components/pipelines/how-to/cli.md +++ b/content/en/docs/components/pipelines/user-guides/cli.md @@ -157,5 +157,5 @@ For more information about the arguments and flags supported by the `kfp compone [cli-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/stable/index.html -[lightweight-python-component]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components +[lightweight-python-component]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components diff --git a/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md b/content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md similarity index 99% rename from content/en/docs/components/pipelines/how-to/compile-a-pipeline.md rename to content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md index b84fcf40bc..0769323e13 100644 --- a/content/en/docs/components/pipelines/how-to/compile-a-pipeline.md +++ b/content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md @@ -113,5 +113,5 @@ While IR YAML is not intended to be easily human readable, you can still inspect [component-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L85-L96 [executor-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L788-L803 [dag-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L98-L105 -[data-types]: /docs/components/pipelines/how-to/data-types +[data-types]: /docs/components/pipelines/user-guides/data-types [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/compiler.html#kfp.compiler.Compiler.compile diff --git a/content/en/docs/components/pipelines/how-to/control-flow.md b/content/en/docs/components/pipelines/user-guides/control-flow.md similarity index 97% rename from content/en/docs/components/pipelines/how-to/control-flow.md rename to content/en/docs/components/pipelines/user-guides/control-flow.md index 95554aaacc..5c928c94c2 100644 --- a/content/en/docs/components/pipelines/how-to/control-flow.md +++ b/content/en/docs/components/pipelines/user-guides/control-flow.md @@ -208,8 +208,8 @@ def my_pipeline(text: str = 'message'): Note that the component used for the caller task (`print_op` in the example above) requires a default value for all inputs it consumes from an upstream task. The default value is applied if the upstream task fails to produce the outputs that are passed to the caller task. Specifying default values ensures that the caller task always succeeds, regardless of the status of the upstream task. -[data-passing]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines#data-passing-and-task-dependencies -[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines +[data-passing]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines#data-passing-and-task-dependencies +[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines [dsl-condition]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Condition [dsl-exithandler]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ExitHandler [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor diff --git a/content/en/docs/components/pipelines/how-to/create-components/_index.md b/content/en/docs/components/pipelines/user-guides/create-components/_index.md similarity index 100% rename from content/en/docs/components/pipelines/how-to/create-components/_index.md rename to content/en/docs/components/pipelines/user-guides/create-components/_index.md diff --git a/content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md b/content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md similarity index 95% rename from content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md rename to content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md index a52603084c..3cd0d1b312 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/additional-functionality.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md @@ -62,9 +62,9 @@ def dataset_concatenator( Note that if you provide a `description` argument to the [`@dsl.pipeline`][dsl-pipeline] decorator, KFP will use this description instead of the docstring description. -[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml [google-docstring-style]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline -[output-artifacts]: /docs/components/pipelines/how-to/artifacts#declaring-inputoutput-artifacts +[output-artifacts]: /docs/components/pipelines/user-guides/artifacts#declaring-inputoutput-artifacts [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [output-type-marker]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Output \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md b/content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md similarity index 93% rename from content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md rename to content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md index ddefd140b1..13690281ea 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/compose-components-into-pipelines.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md @@ -202,14 +202,14 @@ def pythagorean(a: float = 1.2, b: float = 1.2) -> float: [dsl-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline -[control-flow]: /docs/components/pipelines/how-to/control-flow -[components]: /docs/components/pipelines/how-to/create-components +[control-flow]: /docs/components/pipelines/user-guides/control-flow +[components]: /docs/components/pipelines/user-guides/create-components [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [oss-be]: /docs/components/pipelines/operator-guides/installation/ -[data-types]: /docs/components/pipelines/how-to/data-types -[output-artifacts]: /docs/components/pipelines/how-to/artifacts#using-output-artifacts -[container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs -[parameters-namedtuple]: /docs/components/pipelines/how-to/parameters#multiple-output-parameters +[data-types]: /docs/components/pipelines/user-guides/data-types +[output-artifacts]: /docs/components/pipelines/user-guides/artifacts#using-output-artifacts +[container-component-outputs]: /docs/components/pipelines/user-guides/create-components/container-components#create-component-outputs +[parameters-namedtuple]: /docs/components/pipelines/user-guides/parameters#multiple-output-parameters [dsl-pipeline-job-name-placeholder]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PIPELINE_JOB_NAME_PLACEHOLDER -[component-docstring-format]: /docs/components/pipelines/how-to/create-components/additional-functionality#component-docstring-format +[component-docstring-format]: /docs/components/pipelines/user-guides/create-components/additional-functionality#component-docstring-format diff --git a/content/en/docs/components/pipelines/how-to/create-components/container-components.md b/content/en/docs/components/pipelines/user-guides/create-components/container-components.md similarity index 98% rename from content/en/docs/components/pipelines/how-to/create-components/container-components.md rename to content/en/docs/components/pipelines/user-guides/create-components/container-components.md index ea84a494d6..e2e84391db 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/container-components.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/container-components.md @@ -185,7 +185,7 @@ Arguments to `then` and `else_` may be a list of any combination of static strin [hello-world-pipeline]: /docs/components/pipelines/getting-started -[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines +[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines [alpine]: https://hub.docker.com/_/alpine [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.container_component diff --git a/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md b/content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md similarity index 95% rename from content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md rename to content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md index bf599a3f53..b82de19013 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/containerized-python-components.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md @@ -103,10 +103,10 @@ Since `add`'s `target_image` uses [Google Cloud Artifact Registry][artifact-regi [kfp-component-build]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html#kfp-component-build -[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ +[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ [image-tag]: https://docs.docker.com/engine/reference/commandline/tag/ [docker-from]: https://docs.docker.com/engine/reference/builder/#from [artifact-registry]: https://cloud.google.com/artifact-registry/docs/docker/authentication [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [iam]: https://cloud.google.com/iam -[packages-to-install]: /docs/components/pipelines/how-to/create-components/lightweight-python-components#packages_to_install \ No newline at end of file +[packages-to-install]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components#packages_to_install \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/create-components/importer-component.md b/content/en/docs/components/pipelines/user-guides/create-components/importer-component.md similarity index 93% rename from content/en/docs/components/pipelines/how-to/create-components/importer-component.md rename to content/en/docs/components/pipelines/user-guides/create-components/importer-component.md index 223e27f10e..5328c79696 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/importer-component.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/importer-component.md @@ -34,7 +34,7 @@ The `importer` component permits setting artifact metadata via the `metadata` ar You may also specify a boolean `reimport` argument. If `reimport` is `False`, KFP will check to see if the artifact has already been imported to ML Metadata and, if so, use it. This is useful for avoiding duplicative artifact entries in ML Metadata when multiple pipeline runs import the same artifact. If `reimport` is `True`, KFP will reimport the artifact as a new artifact in ML Metadata regardless of whether it was previously imported. -[pipeline-basics]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines +[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines [dsl-importer]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.importer -[artifacts]: /docs/components/pipelines/how-to/artifacts +[artifacts]: /docs/components/pipelines/user-guides/artifacts [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md b/content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md similarity index 95% rename from content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md rename to content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md index e6c2f0e116..60e5d0be5f 100644 --- a/content/en/docs/components/pipelines/how-to/create-components/lightweight-python-components.md +++ b/content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md @@ -127,11 +127,11 @@ By default, Python Components install `kfp` at runtime. This is required to defi Note that setting `install_kfp_package` to `False` is rarely necessary and is discouraged for the majority of use cases. [hello-world-pipeline]: /docs/components/pipelines/getting-started -[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components +[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component -[data-types]: /docs/components/pipelines/how-to/data-types -[parameters]: /docs/components/pipelines/how-to/parameters -[artifacts]: /docs/components/pipelines/how-to/artifacts +[data-types]: /docs/components/pipelines/user-guides/data-types +[parameters]: /docs/components/pipelines/user-guides/parameters +[artifacts]: /docs/components/pipelines/user-guides/artifacts [requirements-txt]: https://pip.pypa.io/en/stable/reference/requirements-file-format/ [pypi-org]: https://pypi.org/ [pip-install]: https://pip.pypa.io/en/stable/cli/pip_install/ diff --git a/content/en/docs/components/pipelines/how-to/data-types.md b/content/en/docs/components/pipelines/user-guides/data-types.md similarity index 94% rename from content/en/docs/components/pipelines/how-to/data-types.md rename to content/en/docs/components/pipelines/user-guides/data-types.md index 28d2d217d8..427aadb0a9 100644 --- a/content/en/docs/components/pipelines/how-to/data-types.md +++ b/content/en/docs/components/pipelines/user-guides/data-types.md @@ -15,5 +15,5 @@ So far [Hello World pipeline][hello-world] and the examples in [Components][comp KFP automatically tracks the way parameters and artifacts are passed between components and stores the this data passing history in [ML Metadata][ml-metadata]. This enables out-of-the-box ML artifact lineage tracking and easily reproducible pipeline executions. Furthermore, KFP's strongly-typed components provide a data contract between tasks in a pipeline. [hello-world]: /docs/components/pipelines/getting-started -[components]: /docs/components/pipelines/how-to/create-components +[components]: /docs/components/pipelines/user-guides/create-components [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md b/content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md similarity index 94% rename from content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md rename to content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md index ea1a03cd0a..137acf067d 100644 --- a/content/en/docs/components/pipelines/how-to/execute-kfp-pipelines-locally.md +++ b/content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md @@ -132,9 +132,9 @@ Local execution comes with several limitations: While local pipeline execution has full support for sequential and nested pipelines, it does not yet support `dsl.Condition`, `dsl.ParallelFor`, or `dsl.ExitHandler`. -[lightweight-python-component]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components -[container-components]: /docs/components/pipelines/how-to/create-components/container-components +[lightweight-python-component]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components +[container-components]: /docs/components/pipelines/user-guides/create-components/container-components diff --git a/content/en/docs/components/pipelines/how-to/load-and-share-components.md b/content/en/docs/components/pipelines/user-guides/load-and-share-components.md similarity index 94% rename from content/en/docs/components/pipelines/how-to/load-and-share-components.md rename to content/en/docs/components/pipelines/user-guides/load-and-share-components.md index 16da4cd26e..01b1079e97 100644 --- a/content/en/docs/components/pipelines/how-to/load-and-share-components.md +++ b/content/en/docs/components/pipelines/user-guides/load-and-share-components.md @@ -51,7 +51,7 @@ def my_pipeline(): Some libraries, such as [Google Cloud Pipeline Components][gcpc] package and provide reusable components in a pip-installable [Python package][gcpc-pypi]. -[pipeline-as-component]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines#pipelines-as-components +[pipeline-as-component]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines#pipelines-as-components [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction [gcpc-pypi]: https://pypi.org/project/google-cloud-pipeline-components/ [components-module]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/components.html diff --git a/content/en/docs/components/pipelines/how-to/migration.md b/content/en/docs/components/pipelines/user-guides/migration.md similarity index 93% rename from content/en/docs/components/pipelines/how-to/migration.md rename to content/en/docs/components/pipelines/user-guides/migration.md index dc7edce0e1..f91cc16054 100644 --- a/content/en/docs/components/pipelines/how-to/migration.md +++ b/content/en/docs/components/pipelines/user-guides/migration.md @@ -409,7 +409,7 @@ def flip_coin(rand: int, result: dsl.OutputPath(str)): `VolumeOp` and `ResourceOp` expose direct access to Kubernetes resources within a pipeline definition. There is no support for these features on a non-Kubernetes platforms. -KFP v2 enables support for [platform-specific features](/docs/components/pipelines/how-to/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. +KFP v2 enables support for [platform-specific features](/docs/components/pipelines/user-guides/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. #### v1 component YAML support @@ -575,27 +575,27 @@ def training_pipeline(number_of_epochs: int = 1): If you believe we missed a breaking change or an important migration step, please [create an issue][new-issue] describing the change in the [kubeflow/pipelines repository][pipelines-repo]. -[artifacts]: /docs/components/pipelines/how-to/artifacts -[cli]: /docs/components/pipelines/how-to/cli/ -[compile]: /docs/components/pipelines/how-to/compile-a-pipeline +[artifacts]: /docs/components/pipelines/user-guides/artifacts +[cli]: /docs/components/pipelines/user-guides/cli/ +[compile]: /docs/components/pipelines/user-guides/compile-a-pipeline [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler.compile [components-load-component-from-file]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html#kfp.components.load_component_from_file -[container-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components/ -[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components/ +[container-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components/ [create-custom-training-job-from-component]: https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.Collected [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.container_component [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.ParallelFor [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction -[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline/#ir-yaml -[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components// -[load]: /docs/components/pipelines/how-to/load-and-share-components/ +[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline/#ir-yaml +[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components// +[load]: /docs/components/pipelines/user-guides/load-and-share-components/ [new-issue]: https://github.com/kubeflow/pipelines/issues/new [oss-be-v1]: /docs/components/pipelines/legacy-v1/ [oss-be-v2]: /docs/components/pipelines/operator-guides/installation/ -[parallelfor-control-flow]: /docs/components/pipelines/how-to/control-flow/#parallel-looping-dslparallelfor -[parameters]: /docs/components/pipelines/how-to/parameters +[parallelfor-control-flow]: /docs/components/pipelines/user-guides/control-flow/#parallel-looping-dslparallelfor +[parameters]: /docs/components/pipelines/user-guides/parameters [pipelines-repo]: https://github.com/kubeflow/pipelines [semver-minor-version]: https://semver.org/#:~:text=MINOR%20version%20when%20you%20add%20functionality%20in%20a%20backwards%20compatible%20manner [v1-component-yaml-example]: https://github.com/kubeflow/pipelines/blob/01c87f8a032e70a6ca92cdbefa974a7da387f204/sdk/python/test_data/v1_component_yaml/add_component.yaml @@ -604,4 +604,4 @@ If you believe we missed a breaking change or an important migration step, pleas [vertex-sdk]: https://cloud.google.com/vertex-ai/docs/pipelines/run-pipeline#vertex-ai-sdk-for-python [argo]: https://argoproj.github.io/argo-workflows/ [dsl-pipelinetask-set-env-variable]: https://kubeflow-pipelines.readthedocs.io/en/2.0.0b13/source/dsl.html#kfp.dsl.PipelineTask.set_env_variable -[task-configuration-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file +[task-configuration-methods]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file diff --git a/content/en/docs/components/pipelines/how-to/parameters.md b/content/en/docs/components/pipelines/user-guides/parameters.md similarity index 92% rename from content/en/docs/components/pipelines/how-to/parameters.md rename to content/en/docs/components/pipelines/user-guides/parameters.md index d0d37ab1b9..85f098365a 100644 --- a/content/en/docs/components/pipelines/how-to/parameters.md +++ b/content/en/docs/components/pipelines/user-guides/parameters.md @@ -166,10 +166,10 @@ def my_pipeline() -> NamedTuple('pipeline_outputs', c=int, d=str): [ml-metadata]: https://github.com/google/ml-metadata -[lightweight-python-components]: /docs/components/pipelines/how-to/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/how-to/create-components/containerized-python-components -[container-component]: /docs/components/pipelines/how-to/create-components/container-components -[container-component-outputs]: /docs/components/pipelines/how-to/create-components/container-components#create-component-outputs +[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components +[container-component]: /docs/components/pipelines/user-guides/create-components/container-components +[container-component-outputs]: /docs/components/pipelines/user-guides/create-components/container-components#create-component-outputs [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [ml-metadata]: https://github.com/google/ml-metadata diff --git a/content/en/docs/components/pipelines/how-to/platform-specific-features.md b/content/en/docs/components/pipelines/user-guides/platform-specific-features.md similarity index 94% rename from content/en/docs/components/pipelines/how-to/platform-specific-features.md rename to content/en/docs/components/pipelines/user-guides/platform-specific-features.md index 4928f6b16b..56134a5975 100644 --- a/content/en/docs/components/pipelines/how-to/platform-specific-features.md +++ b/content/en/docs/components/pipelines/user-guides/platform-specific-features.md @@ -105,14 +105,14 @@ Finally, we can schedule deletion of the PVC after `task2` finishes to clean up For the full pipeline and more information, see a [similar example][full-example] in the [`kfp-kubernetes` documentation][kfp-kubernetes-docs]. -[ir-yaml]: /docs/components/pipelines/how-to/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml [oss-be]: /docs/components/pipelines/operator-guides/installation/ [kfp-kubernetes-pypi]: https://pypi.org/project/kfp-kubernetes/ -[task-level-config-methods]: /docs/components/pipelines/how-to/create-components/compose-components-into-pipelines/#task-configurations +[task-level-config-methods]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/#task-configurations [kfp-kubernetes-docs]: https://kfp-kubernetes.readthedocs.io/ [persistent-volume]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/ [storage-class]: https://kubernetes.io/docs/concepts/storage/storage-classes/ [access-mode]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes [full-example]: https://kfp-kubernetes.readthedocs.io/en/kfp-kubernetes-0.0.1/#persistentvolumeclaim-dynamically-create-pvc-mount-then-delete -[authoring-components]: http://localhost:1313/docs/components/pipelines/how-to/create-components/ -[authoring-pipelines]: http://localhost:1313/docs/components/pipelines/how-to/ +[authoring-components]: http://localhost:1313/docs/components/pipelines/user-guides/create-components/ +[authoring-pipelines]: http://localhost:1313/docs/components/pipelines/user-guides/ diff --git a/content/en/docs/components/pipelines/how-to/run-a-pipeline.md b/content/en/docs/components/pipelines/user-guides/run-a-pipeline.md similarity index 95% rename from content/en/docs/components/pipelines/how-to/run-a-pipeline.md rename to content/en/docs/components/pipelines/user-guides/run-a-pipeline.md index c3b0e83227..e17bab466b 100644 --- a/content/en/docs/components/pipelines/how-to/run-a-pipeline.md +++ b/content/en/docs/components/pipelines/user-guides/run-a-pipeline.md @@ -77,7 +77,7 @@ kfp run create --experiment-name my-experiment --package-file path/to/pipeline.y For more information about the `kfp run create` command, see [Command Line Interface][kfp-run-create-reference-docs] in the [KFP SDK reference documentation][kfp-sdk-api-ref]. For a summary of the available commands in the KFP CLI, see [Command-line Interface][kfp-cli]. [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/master/index.html -[compile-a-pipeline]: /docs/components/pipelines/how-to/compile-a-pipeline/ +[compile-a-pipeline]: /docs/components/pipelines/user-guides/compile-a-pipeline/ [kfp-sdk-api-ref-client]: https://kubeflow-pipelines.readthedocs.io/en/master/source/client.html -[kfp-cli]: /docs/components/pipelines/how-to/cli/ +[kfp-cli]: /docs/components/pipelines/user-guides/cli/ [kfp-run-create-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/master/source/cli.html#kfp-run-create From 350dde8a63be3e8e2a20001fdbf568152c67afc7 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 09:28:50 -0300 Subject: [PATCH 14/35] Regrouped user guides Signed-off-by: hbelmiro --- content/en/_redirects | 32 +++++++++---------- .../components/pipelines/getting-started.md | 4 +-- .../en/docs/components/pipelines/overview.md | 4 +-- .../_index.md | 2 +- .../additional-functionality.md | 4 +-- .../compose-components-into-pipelines.md | 12 +++---- .../container-components.md | 2 +- .../containerized-python-components.md | 4 +-- .../importer-component.md | 4 +-- .../lightweight-python-components.md | 8 ++--- .../load-and-share-components.md | 4 +-- .../user-guides/core-functions/_index.md | 5 +++ .../build-advanced-pipeline.md | 2 +- .../{ => core-functions}/caching.md | 2 +- .../user-guides/{ => core-functions}/cli.md | 4 +-- .../compile-a-pipeline.md | 2 +- .../core-functions}/connect-api.md | 2 +- .../{ => core-functions}/control-flow.md | 6 ++-- .../execute-kfp-pipelines-locally.md | 6 ++-- .../platform-specific-features.md | 8 ++--- .../{ => core-functions}/run-a-pipeline.md | 4 +-- .../user-guides/data-handling/_index.md | 4 +++ .../{ => data-handling}/artifacts.md | 16 +++++----- .../{ => data-handling}/data-types.md | 4 +-- .../{ => data-handling}/parameters.md | 10 +++--- .../pipelines/user-guides/migration.md | 22 ++++++------- 26 files changed, 93 insertions(+), 84 deletions(-) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/_index.md (99%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/additional-functionality.md (94%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/compose-components-into-pipelines.md (95%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/container-components.md (98%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/containerized-python-components.md (96%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/importer-component.md (93%) rename content/en/docs/components/pipelines/user-guides/{create-components => components}/lightweight-python-components.md (96%) rename content/en/docs/components/pipelines/user-guides/{ => components}/load-and-share-components.md (96%) create mode 100644 content/en/docs/components/pipelines/user-guides/core-functions/_index.md rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/build-advanced-pipeline.md (99%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/caching.md (99%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/cli.md (98%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/compile-a-pipeline.md (99%) rename content/en/docs/components/pipelines/{legacy-v1/sdk => user-guides/core-functions}/connect-api.md (99%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/control-flow.md (97%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/execute-kfp-pipelines-locally.md (97%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/platform-specific-features.md (96%) rename content/en/docs/components/pipelines/user-guides/{ => core-functions}/run-a-pipeline.md (95%) create mode 100644 content/en/docs/components/pipelines/user-guides/data-handling/_index.md rename content/en/docs/components/pipelines/user-guides/{ => data-handling}/artifacts.md (95%) rename content/en/docs/components/pipelines/user-guides/{ => data-handling}/data-types.md (93%) rename content/en/docs/components/pipelines/user-guides/{ => data-handling}/parameters.md (95%) diff --git a/content/en/_redirects b/content/en/_redirects index ddcb111460..46cbd58f61 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -264,7 +264,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/sdk/ /docs/components/pipelines/legacy-v1/sdk/ /docs/components/pipelines/v1/sdk/sdk-overview/ /docs/components/pipelines/legacy-v1/sdk/sdk-overview/ /docs/components/pipelines/v1/sdk/install-sdk/ /docs/components/pipelines/legacy-v1/sdk/install-sdk/ -/docs/components/pipelines/v1/sdk/connect-api/ /docs/components/pipelines/legacy-v1/sdk/connect-api/ +/docs/components/pipelines/v1/sdk/connect-api/ /docs/components/pipelines/user-guides/core-functions/connect-api/ /docs/components/pipelines/v1/sdk/build-pipeline/ /docs/components/pipelines/legacy-v1/sdk/build-pipeline/ /docs/components/pipelines/v1/sdk/component-development/ /docs/components/pipelines/legacy-v1/sdk/component-development/ /docs/components/pipelines/v1/sdk/python-function-components/ /docs/components/pipelines/legacy-v1/sdk/python-function-components/ @@ -294,26 +294,26 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/operator-guides/installation/ /docs/components/pipelines/v2/hello-world/ /docs/components/pipelines/getting-started/ -/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/user-guides/run-a-pipeline/ +/docs/components/pipelines/v2/run-a-pipeline/ /docs/components/pipelines/user-guides/core-functions/run-a-pipeline/ /docs/components/pipelines/v2/installation/quickstart/ /docs/components/pipelines/overview/ -/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/user-guides/compile-a-pipeline/ -/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/user-guides/execute-kfp-pipelines-locally/ -/docs/components/pipelines/v2/cli/ /docs/components/pipelines/user-guides/cli/ -/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ -/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/ -/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/user-guides/create-components/containerized-python-components/ -/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/user-guides/create-components/container-components/ -/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/user-guides/create-components/importer-component/ -/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/user-guides/create-components/additional-functionality/ +/docs/components/pipelines/v2/compile-a-pipeline/ /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline/ +/docs/components/pipelines/v2/local-execution/ /docs/components/pipelines/user-guides/core-functions/execute-kfp-pipelines-locally/ +/docs/components/pipelines/v2/cli/ /docs/components/pipelines/user-guides/core-functions/cli/ +/docs/components/pipelines/v2/components/lightweight-python-components/ /docs/components/pipelines/user-guides/components/lightweight-python-components/ +/docs/components/pipelines/v2/pipelines/pipeline-basics/ /docs/components/pipelines/user-guides/components/compose-components-into-pipelines/ +/docs/components/pipelines/v2/components/containerized-python-components/ /docs/components/pipelines/user-guides/components/containerized-python-components/ +/docs/components/pipelines/v2/components/container-components/ /docs/components/pipelines/user-guides/components/container-components/ +/docs/components/pipelines/v2/components/importer-component/ /docs/components/pipelines/user-guides/components/importer-component/ +/docs/components/pipelines/v2/components/additional-functionality/ /docs/components/pipelines/user-guides/components/additional-functionality/ /docs/components/pipelines/v2/load-and-share-components/ /docs/components/pipelines/user-guides/load-and-share-components/ /docs/components/pipelines/v2/pipelines/control-flow/ /docs/components/pipelines/user-guides/control-flow/ -/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/user-guides/data-types/ -/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/user-guides/parameters/ -/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/user-guides/artifacts/ -/docs/components/pipelines/v2/caching/ /docs/components/pipelines/user-guides/caching/ +/docs/components/pipelines/v2/data-types/ /docs/components/pipelines/user-guides/data-handling/data-types/ +/docs/components/pipelines/v2/data-types/parameters/ /docs/components/pipelines/user-guides/data-handling/parameters/ +/docs/components/pipelines/v2/data-types/artifacts/ /docs/components/pipelines/user-guides/data-handling/artifacts/ +/docs/components/pipelines/v2/caching/ /docs/components/pipelines/user-guides/core-functions/caching/ /docs/components/pipelines/v2/administration/server-config/ /docs/components/pipelines/operator-guides/server-config/ /docs/components/pipelines/v2/migration/ /docs/components/pipelines/user-guides/migration/ -/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/user-guides/platform-specific-features/ +/docs/components/pipelines/v2/platform-specific-features/ /docs/components/pipelines/user-guides/core-functions/platform-specific-features/ /docs/components/pipelines/v2/community-and-support/ /docs/components/pipelines/reference/community-and-support/ /docs/components/pipelines/v2/version-compatibility/ /docs/components/pipelines/reference/version-compatibility/ /docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/reference/api/kubeflow-pipeline-api-spec/ diff --git a/content/en/docs/components/pipelines/getting-started.md b/content/en/docs/components/pipelines/getting-started.md index eb1757801a..8a0b1bc7d6 100644 --- a/content/en/docs/components/pipelines/getting-started.md +++ b/content/en/docs/components/pipelines/getting-started.md @@ -60,7 +60,7 @@ In the next few sections, you'll learn more about the core concepts of authoring [installation]: /docs/components/pipelines/operator-guides/installation/ [client]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html#kfp.client.Client [compiler]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler -[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml -[compile-a-pipeline]: /docs/components/pipelines/user-guides/compile-a-pipeline/ +[ir-yaml]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline#ir-yaml +[compile-a-pipeline]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline/ [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component diff --git a/content/en/docs/components/pipelines/overview.md b/content/en/docs/components/pipelines/overview.md index ba4f216a08..8a8cd98c61 100644 --- a/content/en/docs/components/pipelines/overview.md +++ b/content/en/docs/components/pipelines/overview.md @@ -37,10 +37,10 @@ A [pipeline][pipelines] is a definition of a workflow that composes one or more * Learn more about [authoring components][components] * Learn more about [authoring pipelines][pipelines] -[components]: /docs/components/pipelines/user-guides/create-components +[components]: /docs/components/pipelines/user-guides/components [pipelines]: /docs/components/pipelines/user-guides [installation]: /docs/components/pipelines/operator-guides/installation -[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline#ir-yaml [pypi]: https://pypi.org/project/kfp/ [hello-world-pipeline]: /docs/components/pipelines/getting-started [control-flow]: /docs/components/pipelines/user-guides/control-flow diff --git a/content/en/docs/components/pipelines/user-guides/create-components/_index.md b/content/en/docs/components/pipelines/user-guides/components/_index.md similarity index 99% rename from content/en/docs/components/pipelines/user-guides/create-components/_index.md rename to content/en/docs/components/pipelines/user-guides/components/_index.md index 2aa77d2bf6..13e805a51e 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/_index.md +++ b/content/en/docs/components/pipelines/user-guides/components/_index.md @@ -1,6 +1,6 @@ +++ title = "Create components" -weight = 6 +weight = 3 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md b/content/en/docs/components/pipelines/user-guides/components/additional-functionality.md similarity index 94% rename from content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md rename to content/en/docs/components/pipelines/user-guides/components/additional-functionality.md index 3cd0d1b312..78a9f64dfe 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/additional-functionality.md +++ b/content/en/docs/components/pipelines/user-guides/components/additional-functionality.md @@ -62,9 +62,9 @@ def dataset_concatenator( Note that if you provide a `description` argument to the [`@dsl.pipeline`][dsl-pipeline] decorator, KFP will use this description instead of the docstring description. -[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline#ir-yaml [google-docstring-style]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline -[output-artifacts]: /docs/components/pipelines/user-guides/artifacts#declaring-inputoutput-artifacts +[output-artifacts]: /docs/components/pipelines/user-guides/data-handling/artifacts#declaring-inputoutput-artifacts [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [output-type-marker]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Output \ No newline at end of file diff --git a/content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md b/content/en/docs/components/pipelines/user-guides/components/compose-components-into-pipelines.md similarity index 95% rename from content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md rename to content/en/docs/components/pipelines/user-guides/components/compose-components-into-pipelines.md index 13690281ea..01718b7d1d 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines.md +++ b/content/en/docs/components/pipelines/user-guides/components/compose-components-into-pipelines.md @@ -203,13 +203,13 @@ def pythagorean(a: float = 1.2, b: float = 1.2) -> float: [dsl-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html [dsl-pipeline]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.pipeline [control-flow]: /docs/components/pipelines/user-guides/control-flow -[components]: /docs/components/pipelines/user-guides/create-components +[components]: /docs/components/pipelines/user-guides/components [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [oss-be]: /docs/components/pipelines/operator-guides/installation/ -[data-types]: /docs/components/pipelines/user-guides/data-types -[output-artifacts]: /docs/components/pipelines/user-guides/artifacts#using-output-artifacts -[container-component-outputs]: /docs/components/pipelines/user-guides/create-components/container-components#create-component-outputs -[parameters-namedtuple]: /docs/components/pipelines/user-guides/parameters#multiple-output-parameters +[data-types]: /docs/components/pipelines/user-guides/data-handling/data-types +[output-artifacts]: /docs/components/pipelines/user-guides/data-handling/artifacts#using-output-artifacts +[container-component-outputs]: /docs/components/pipelines/user-guides/components/container-components#create-component-outputs +[parameters-namedtuple]: /docs/components/pipelines/user-guides/data-handling/parameters#multiple-output-parameters [dsl-pipeline-job-name-placeholder]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PIPELINE_JOB_NAME_PLACEHOLDER -[component-docstring-format]: /docs/components/pipelines/user-guides/create-components/additional-functionality#component-docstring-format +[component-docstring-format]: /docs/components/pipelines/user-guides/components/additional-functionality#component-docstring-format diff --git a/content/en/docs/components/pipelines/user-guides/create-components/container-components.md b/content/en/docs/components/pipelines/user-guides/components/container-components.md similarity index 98% rename from content/en/docs/components/pipelines/user-guides/create-components/container-components.md rename to content/en/docs/components/pipelines/user-guides/components/container-components.md index e2e84391db..757cf91a0f 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/container-components.md +++ b/content/en/docs/components/pipelines/user-guides/components/container-components.md @@ -185,7 +185,7 @@ Arguments to `then` and `else_` may be a list of any combination of static strin [hello-world-pipeline]: /docs/components/pipelines/getting-started -[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines +[pipeline-basics]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines [alpine]: https://hub.docker.com/_/alpine [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.container_component diff --git a/content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md b/content/en/docs/components/pipelines/user-guides/components/containerized-python-components.md similarity index 96% rename from content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md rename to content/en/docs/components/pipelines/user-guides/components/containerized-python-components.md index b82de19013..fb175b6c9f 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/containerized-python-components.md +++ b/content/en/docs/components/pipelines/user-guides/components/containerized-python-components.md @@ -103,10 +103,10 @@ Since `add`'s `target_image` uses [Google Cloud Artifact Registry][artifact-regi [kfp-component-build]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html#kfp-component-build -[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ +[lightweight-python-components]: /docs/components/pipelines/user-guides/components/lightweight-python-components/ [image-tag]: https://docs.docker.com/engine/reference/commandline/tag/ [docker-from]: https://docs.docker.com/engine/reference/builder/#from [artifact-registry]: https://cloud.google.com/artifact-registry/docs/docker/authentication [vertex-pipelines]: https://cloud.google.com/vertex-ai/docs/pipelines/introduction [iam]: https://cloud.google.com/iam -[packages-to-install]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components#packages_to_install \ No newline at end of file +[packages-to-install]: /docs/components/pipelines/user-guides/components/lightweight-python-components#packages_to_install \ No newline at end of file diff --git a/content/en/docs/components/pipelines/user-guides/create-components/importer-component.md b/content/en/docs/components/pipelines/user-guides/components/importer-component.md similarity index 93% rename from content/en/docs/components/pipelines/user-guides/create-components/importer-component.md rename to content/en/docs/components/pipelines/user-guides/components/importer-component.md index 5328c79696..cde20a5676 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/importer-component.md +++ b/content/en/docs/components/pipelines/user-guides/components/importer-component.md @@ -34,7 +34,7 @@ The `importer` component permits setting artifact metadata via the `metadata` ar You may also specify a boolean `reimport` argument. If `reimport` is `False`, KFP will check to see if the artifact has already been imported to ML Metadata and, if so, use it. This is useful for avoiding duplicative artifact entries in ML Metadata when multiple pipeline runs import the same artifact. If `reimport` is `True`, KFP will reimport the artifact as a new artifact in ML Metadata regardless of whether it was previously imported. -[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines +[pipeline-basics]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines [dsl-importer]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.importer -[artifacts]: /docs/components/pipelines/user-guides/artifacts +[artifacts]: /docs/components/pipelines/user-guides/data-handling/artifacts [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md b/content/en/docs/components/pipelines/user-guides/components/lightweight-python-components.md similarity index 96% rename from content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md rename to content/en/docs/components/pipelines/user-guides/components/lightweight-python-components.md index 60e5d0be5f..c1acd53d15 100644 --- a/content/en/docs/components/pipelines/user-guides/create-components/lightweight-python-components.md +++ b/content/en/docs/components/pipelines/user-guides/components/lightweight-python-components.md @@ -127,11 +127,11 @@ By default, Python Components install `kfp` at runtime. This is required to defi Note that setting `install_kfp_package` to `False` is rarely necessary and is discouraged for the majority of use cases. [hello-world-pipeline]: /docs/components/pipelines/getting-started -[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components +[containerized-python-components]: /docs/components/pipelines/user-guides/components/containerized-python-components [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component -[data-types]: /docs/components/pipelines/user-guides/data-types -[parameters]: /docs/components/pipelines/user-guides/parameters -[artifacts]: /docs/components/pipelines/user-guides/artifacts +[data-types]: /docs/components/pipelines/user-guides/data-handling/data-types +[parameters]: /docs/components/pipelines/user-guides/data-handling/parameters +[artifacts]: /docs/components/pipelines/user-guides/data-handling/artifacts [requirements-txt]: https://pip.pypa.io/en/stable/reference/requirements-file-format/ [pypi-org]: https://pypi.org/ [pip-install]: https://pip.pypa.io/en/stable/cli/pip_install/ diff --git a/content/en/docs/components/pipelines/user-guides/load-and-share-components.md b/content/en/docs/components/pipelines/user-guides/components/load-and-share-components.md similarity index 96% rename from content/en/docs/components/pipelines/user-guides/load-and-share-components.md rename to content/en/docs/components/pipelines/user-guides/components/load-and-share-components.md index 01b1079e97..ae2fe86bf5 100644 --- a/content/en/docs/components/pipelines/user-guides/load-and-share-components.md +++ b/content/en/docs/components/pipelines/user-guides/components/load-and-share-components.md @@ -1,7 +1,7 @@ +++ title = "Load and Share Components" description = "Load and use an ecosystem of components" -weight = 7 +weight = 8 +++ {{% kfp-v2-keywords %}} @@ -51,7 +51,7 @@ def my_pipeline(): Some libraries, such as [Google Cloud Pipeline Components][gcpc] package and provide reusable components in a pip-installable [Python package][gcpc-pypi]. -[pipeline-as-component]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines#pipelines-as-components +[pipeline-as-component]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines#pipelines-as-components [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction [gcpc-pypi]: https://pypi.org/project/google-cloud-pipeline-components/ [components-module]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/components.html diff --git a/content/en/docs/components/pipelines/user-guides/core-functions/_index.md b/content/en/docs/components/pipelines/user-guides/core-functions/_index.md new file mode 100644 index 0000000000..b5dc8ab738 --- /dev/null +++ b/content/en/docs/components/pipelines/user-guides/core-functions/_index.md @@ -0,0 +1,5 @@ ++++ +title = "Core Functions" +description = "Documentation for users of Kubeflow Pipelines." +weight = 2 ++++ diff --git a/content/en/docs/components/pipelines/user-guides/build-advanced-pipeline.md b/content/en/docs/components/pipelines/user-guides/core-functions/build-advanced-pipeline.md similarity index 99% rename from content/en/docs/components/pipelines/user-guides/build-advanced-pipeline.md rename to content/en/docs/components/pipelines/user-guides/core-functions/build-advanced-pipeline.md index 7cf829008b..5f3c43af18 100644 --- a/content/en/docs/components/pipelines/user-guides/build-advanced-pipeline.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/build-advanced-pipeline.md @@ -1,6 +1,6 @@ +++ title = "Build a More Advanced ML Pipeline" -weight = 12 +weight = 6 +++ {{% kfp-v2-keywords %}} diff --git a/content/en/docs/components/pipelines/user-guides/caching.md b/content/en/docs/components/pipelines/user-guides/core-functions/caching.md similarity index 99% rename from content/en/docs/components/pipelines/user-guides/caching.md rename to content/en/docs/components/pipelines/user-guides/core-functions/caching.md index 2bda0304d4..297f569fcf 100644 --- a/content/en/docs/components/pipelines/user-guides/caching.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/caching.md @@ -1,7 +1,7 @@ +++ title = "Use Caching" description = "How to use caching in Kubeflow Pipelines." -weight = 13 +weight = 5 +++ Kubeflow Pipelines support caching to eliminate redundant executions and improve diff --git a/content/en/docs/components/pipelines/user-guides/cli.md b/content/en/docs/components/pipelines/user-guides/core-functions/cli.md similarity index 98% rename from content/en/docs/components/pipelines/user-guides/cli.md rename to content/en/docs/components/pipelines/user-guides/core-functions/cli.md index 4befa16055..b781ca3c7a 100644 --- a/content/en/docs/components/pipelines/user-guides/cli.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/cli.md @@ -157,5 +157,5 @@ For more information about the arguments and flags supported by the `kfp compone [cli-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/cli.html [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/stable/index.html -[lightweight-python-component]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components +[lightweight-python-component]: /docs/components/pipelines/user-guides/components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/components/containerized-python-components diff --git a/content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md b/content/en/docs/components/pipelines/user-guides/core-functions/compile-a-pipeline.md similarity index 99% rename from content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md rename to content/en/docs/components/pipelines/user-guides/core-functions/compile-a-pipeline.md index 0769323e13..ba9774ea2c 100644 --- a/content/en/docs/components/pipelines/user-guides/compile-a-pipeline.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/compile-a-pipeline.md @@ -113,5 +113,5 @@ While IR YAML is not intended to be easily human readable, you can still inspect [component-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L85-L96 [executor-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L788-L803 [dag-spec]: https://github.com/kubeflow/pipelines/blob/41b69fd90da812005965f2209b64fd1278f1cdc9/api/v2alpha1/pipeline_spec.proto#L98-L105 -[data-types]: /docs/components/pipelines/user-guides/data-types +[data-types]: /docs/components/pipelines/user-guides/data-handling/data-types [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/compiler.html#kfp.compiler.Compiler.compile diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md b/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md similarity index 99% rename from content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md rename to content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md index 2dcba66c12..f88273df23 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/connect-api.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md @@ -1,7 +1,7 @@ +++ title = "Connect the Pipelines SDK to Kubeflow Pipelines" description = "How to connect the Pipelines SDK to Kubeflow Pipelines in various ways" -weight = 25 +weight = 7 +++ How to connect Pipelines SDK to Kubeflow Pipelines will depend on __what kind__ of Kubeflow deployment you have, and __from where you are running your code__. diff --git a/content/en/docs/components/pipelines/user-guides/control-flow.md b/content/en/docs/components/pipelines/user-guides/core-functions/control-flow.md similarity index 97% rename from content/en/docs/components/pipelines/user-guides/control-flow.md rename to content/en/docs/components/pipelines/user-guides/core-functions/control-flow.md index 5c928c94c2..fd9b435366 100644 --- a/content/en/docs/components/pipelines/user-guides/control-flow.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/control-flow.md @@ -1,6 +1,6 @@ +++ title = "Create pipelines with control flow" -weight = 8 +weight = 9 +++ {{% kfp-v2-keywords %}} @@ -208,8 +208,8 @@ def my_pipeline(text: str = 'message'): Note that the component used for the caller task (`print_op` in the example above) requires a default value for all inputs it consumes from an upstream task. The default value is applied if the upstream task fails to produce the outputs that are passed to the caller task. Specifying default values ensures that the caller task always succeeds, regardless of the status of the upstream task. -[data-passing]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines#data-passing-and-task-dependencies -[pipeline-basics]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines +[data-passing]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines#data-passing-and-task-dependencies +[pipeline-basics]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines [dsl-condition]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Condition [dsl-exithandler]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ExitHandler [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor diff --git a/content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md b/content/en/docs/components/pipelines/user-guides/core-functions/execute-kfp-pipelines-locally.md similarity index 97% rename from content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md rename to content/en/docs/components/pipelines/user-guides/core-functions/execute-kfp-pipelines-locally.md index 137acf067d..08b9e16796 100644 --- a/content/en/docs/components/pipelines/user-guides/execute-kfp-pipelines-locally.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/execute-kfp-pipelines-locally.md @@ -132,9 +132,9 @@ Local execution comes with several limitations: While local pipeline execution has full support for sequential and nested pipelines, it does not yet support `dsl.Condition`, `dsl.ParallelFor`, or `dsl.ExitHandler`. -[lightweight-python-component]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components -[container-components]: /docs/components/pipelines/user-guides/create-components/container-components +[lightweight-python-component]: /docs/components/pipelines/user-guides/components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/components/containerized-python-components +[container-components]: /docs/components/pipelines/user-guides/components/container-components diff --git a/content/en/docs/components/pipelines/user-guides/platform-specific-features.md b/content/en/docs/components/pipelines/user-guides/core-functions/platform-specific-features.md similarity index 96% rename from content/en/docs/components/pipelines/user-guides/platform-specific-features.md rename to content/en/docs/components/pipelines/user-guides/core-functions/platform-specific-features.md index 56134a5975..9bba7f158a 100644 --- a/content/en/docs/components/pipelines/user-guides/platform-specific-features.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/platform-specific-features.md @@ -1,6 +1,6 @@ +++ title = "Author Tasks with Platform-Specific Functionality" -weight = 16 +weight = 10 +++ @@ -105,14 +105,14 @@ Finally, we can schedule deletion of the PVC after `task2` finishes to clean up For the full pipeline and more information, see a [similar example][full-example] in the [`kfp-kubernetes` documentation][kfp-kubernetes-docs]. -[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline#ir-yaml +[ir-yaml]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline#ir-yaml [oss-be]: /docs/components/pipelines/operator-guides/installation/ [kfp-kubernetes-pypi]: https://pypi.org/project/kfp-kubernetes/ -[task-level-config-methods]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/#task-configurations +[task-level-config-methods]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines/#task-configurations [kfp-kubernetes-docs]: https://kfp-kubernetes.readthedocs.io/ [persistent-volume]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/ [storage-class]: https://kubernetes.io/docs/concepts/storage/storage-classes/ [access-mode]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes [full-example]: https://kfp-kubernetes.readthedocs.io/en/kfp-kubernetes-0.0.1/#persistentvolumeclaim-dynamically-create-pvc-mount-then-delete -[authoring-components]: http://localhost:1313/docs/components/pipelines/user-guides/create-components/ +[authoring-components]: http://localhost:1313/docs/components/pipelines/user-guides/components/ [authoring-pipelines]: http://localhost:1313/docs/components/pipelines/user-guides/ diff --git a/content/en/docs/components/pipelines/user-guides/run-a-pipeline.md b/content/en/docs/components/pipelines/user-guides/core-functions/run-a-pipeline.md similarity index 95% rename from content/en/docs/components/pipelines/user-guides/run-a-pipeline.md rename to content/en/docs/components/pipelines/user-guides/core-functions/run-a-pipeline.md index e17bab466b..11718438c9 100644 --- a/content/en/docs/components/pipelines/user-guides/run-a-pipeline.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/run-a-pipeline.md @@ -77,7 +77,7 @@ kfp run create --experiment-name my-experiment --package-file path/to/pipeline.y For more information about the `kfp run create` command, see [Command Line Interface][kfp-run-create-reference-docs] in the [KFP SDK reference documentation][kfp-sdk-api-ref]. For a summary of the available commands in the KFP CLI, see [Command-line Interface][kfp-cli]. [kfp-sdk-api-ref]: https://kubeflow-pipelines.readthedocs.io/en/master/index.html -[compile-a-pipeline]: /docs/components/pipelines/user-guides/compile-a-pipeline/ +[compile-a-pipeline]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline/ [kfp-sdk-api-ref-client]: https://kubeflow-pipelines.readthedocs.io/en/master/source/client.html -[kfp-cli]: /docs/components/pipelines/user-guides/cli/ +[kfp-cli]: /docs/components/pipelines/user-guides/core-functions/cli/ [kfp-run-create-reference-docs]: https://kubeflow-pipelines.readthedocs.io/en/master/source/cli.html#kfp-run-create diff --git a/content/en/docs/components/pipelines/user-guides/data-handling/_index.md b/content/en/docs/components/pipelines/user-guides/data-handling/_index.md new file mode 100644 index 0000000000..0384499c99 --- /dev/null +++ b/content/en/docs/components/pipelines/user-guides/data-handling/_index.md @@ -0,0 +1,4 @@ ++++ +title = "Data Handling" +weight = 4 ++++ diff --git a/content/en/docs/components/pipelines/user-guides/artifacts.md b/content/en/docs/components/pipelines/user-guides/data-handling/artifacts.md similarity index 95% rename from content/en/docs/components/pipelines/user-guides/artifacts.md rename to content/en/docs/components/pipelines/user-guides/data-handling/artifacts.md index a068be8324..24662e9f44 100644 --- a/content/en/docs/components/pipelines/user-guides/artifacts.md +++ b/content/en/docs/components/pipelines/user-guides/data-handling/artifacts.md @@ -1,6 +1,6 @@ +++ title = "Create, use, pass, and track ML artifacts" -weight = 11 +weight = 3 +++ {{% kfp-v2-keywords %}} @@ -240,14 +240,14 @@ On the [KFP open source][oss-be] UI, `ClassificationMetrics`, `SlicedClassificat [dsl-slicedclassificationmetrics]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.SlicedClassificationMetrics [dsl-html]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.HTML [dsl-markdown]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Markdown -[type-checking]: /docs/components/pipelines/user-guides/compile-a-pipeline#type-checking +[type-checking]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline#type-checking [oss-be]: /docs/components/pipelines/operator-guides/installation/ -[pipelines]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/ -[container-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components// -[python-components]: /docs/components/pipelines/user-guides/create-components/container-components +[pipelines]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines/ +[container-components]: /docs/components/pipelines/user-guides/components/lightweight-python-components// +[python-components]: /docs/components/pipelines/user-guides/components/container-components [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.ParallelFor [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Collected [parallel-looping]: /docs/components/pipelines/user-guides/control-flow/#parallel-looping-dslparallelfor -[traditional-artifact-syntax]: /docs/components/pipelines/user-guides/artifacts/#traditional-artifact-syntax -[multiple-outputs]: /docs/components/pipelines/user-guides/parameters/#multiple-output-parameters -[pythonic-artifact-syntax]: /docs/components/pipelines/user-guides/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file +[traditional-artifact-syntax]: /docs/components/pipelines/user-guides/data-handling/artifacts/#traditional-artifact-syntax +[multiple-outputs]: /docs/components/pipelines/user-guides/data-handling/parameters/#multiple-output-parameters +[pythonic-artifact-syntax]: /docs/components/pipelines/user-guides/data-handling/artifacts/#new-pythonic-artifact-syntax \ No newline at end of file diff --git a/content/en/docs/components/pipelines/user-guides/data-types.md b/content/en/docs/components/pipelines/user-guides/data-handling/data-types.md similarity index 93% rename from content/en/docs/components/pipelines/user-guides/data-types.md rename to content/en/docs/components/pipelines/user-guides/data-handling/data-types.md index 427aadb0a9..c6a30b39ce 100644 --- a/content/en/docs/components/pipelines/user-guides/data-types.md +++ b/content/en/docs/components/pipelines/user-guides/data-handling/data-types.md @@ -1,7 +1,7 @@ +++ title = "Data Types" description = "Component and pipeline I/O types" -weight = 9 +weight = 1 +++ {{% kfp-v2-keywords %}} @@ -15,5 +15,5 @@ So far [Hello World pipeline][hello-world] and the examples in [Components][comp KFP automatically tracks the way parameters and artifacts are passed between components and stores the this data passing history in [ML Metadata][ml-metadata]. This enables out-of-the-box ML artifact lineage tracking and easily reproducible pipeline executions. Furthermore, KFP's strongly-typed components provide a data contract between tasks in a pipeline. [hello-world]: /docs/components/pipelines/getting-started -[components]: /docs/components/pipelines/user-guides/create-components +[components]: /docs/components/pipelines/user-guides/components [ml-metadata]: https://github.com/google/ml-metadata \ No newline at end of file diff --git a/content/en/docs/components/pipelines/user-guides/parameters.md b/content/en/docs/components/pipelines/user-guides/data-handling/parameters.md similarity index 95% rename from content/en/docs/components/pipelines/user-guides/parameters.md rename to content/en/docs/components/pipelines/user-guides/data-handling/parameters.md index 85f098365a..5db2b571b9 100644 --- a/content/en/docs/components/pipelines/user-guides/parameters.md +++ b/content/en/docs/components/pipelines/user-guides/data-handling/parameters.md @@ -1,6 +1,6 @@ +++ title = "Pass small amounts of data between components" -weight = 10 +weight = 2 +++ {{% kfp-v2-keywords %}} @@ -166,10 +166,10 @@ def my_pipeline() -> NamedTuple('pipeline_outputs', c=int, d=str): [ml-metadata]: https://github.com/google/ml-metadata -[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components/ -[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components -[container-component]: /docs/components/pipelines/user-guides/create-components/container-components -[container-component-outputs]: /docs/components/pipelines/user-guides/create-components/container-components#create-component-outputs +[lightweight-python-components]: /docs/components/pipelines/user-guides/components/lightweight-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/components/containerized-python-components +[container-component]: /docs/components/pipelines/user-guides/components/container-components +[container-component-outputs]: /docs/components/pipelines/user-guides/components/container-components#create-component-outputs [pipelinetask]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.PipelineTask [dsl-outputpath]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.OutputPath [ml-metadata]: https://github.com/google/ml-metadata diff --git a/content/en/docs/components/pipelines/user-guides/migration.md b/content/en/docs/components/pipelines/user-guides/migration.md index f91cc16054..a03cdc3264 100644 --- a/content/en/docs/components/pipelines/user-guides/migration.md +++ b/content/en/docs/components/pipelines/user-guides/migration.md @@ -1,7 +1,7 @@ +++ title = "Migrate from KFP SDK v1" description = "v1 to v2 migration instructions and breaking changes" -weight = 15 +weight = 1 +++ {{% kfp-v2-keywords %}} @@ -409,7 +409,7 @@ def flip_coin(rand: int, result: dsl.OutputPath(str)): `VolumeOp` and `ResourceOp` expose direct access to Kubernetes resources within a pipeline definition. There is no support for these features on a non-Kubernetes platforms. -KFP v2 enables support for [platform-specific features](/docs/components/pipelines/user-guides/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. +KFP v2 enables support for [platform-specific features](/docs/components/pipelines/user-guides/core-functions/platform-specific-features/) via KFP SDK extension libraries. Kubernetes-specific features are supported in KFP v2 via the [`kfp-kubernetes`](https://kfp-kubernetes.readthedocs.io/) extension library. #### v1 component YAML support @@ -575,27 +575,27 @@ def training_pipeline(number_of_epochs: int = 1): If you believe we missed a breaking change or an important migration step, please [create an issue][new-issue] describing the change in the [kubeflow/pipelines repository][pipelines-repo]. -[artifacts]: /docs/components/pipelines/user-guides/artifacts -[cli]: /docs/components/pipelines/user-guides/cli/ -[compile]: /docs/components/pipelines/user-guides/compile-a-pipeline +[artifacts]: /docs/components/pipelines/user-guides/data-handling/artifacts +[cli]: /docs/components/pipelines/user-guides/core-functions/cli/ +[compile]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline [compiler-compile]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html#kfp.compiler.Compiler.compile [components-load-component-from-file]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html#kfp.components.load_component_from_file -[container-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components/ -[containerized-python-components]: /docs/components/pipelines/user-guides/create-components/containerized-python-components/ +[container-components]: /docs/components/pipelines/user-guides/components/containerized-python-components/ +[containerized-python-components]: /docs/components/pipelines/user-guides/components/containerized-python-components/ [create-custom-training-job-from-component]: https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component [dsl-collected]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.Collected [dsl-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.component [dsl-container-component]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.container_component [dsl-parallelfor]: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html#kfp.dsl.ParallelFor [gcpc]: https://cloud.google.com/vertex-ai/docs/pipelines/components-introduction -[ir-yaml]: /docs/components/pipelines/user-guides/compile-a-pipeline/#ir-yaml -[lightweight-python-components]: /docs/components/pipelines/user-guides/create-components/lightweight-python-components// +[ir-yaml]: /docs/components/pipelines/user-guides/core-functions/compile-a-pipeline/#ir-yaml +[lightweight-python-components]: /docs/components/pipelines/user-guides/components/lightweight-python-components// [load]: /docs/components/pipelines/user-guides/load-and-share-components/ [new-issue]: https://github.com/kubeflow/pipelines/issues/new [oss-be-v1]: /docs/components/pipelines/legacy-v1/ [oss-be-v2]: /docs/components/pipelines/operator-guides/installation/ [parallelfor-control-flow]: /docs/components/pipelines/user-guides/control-flow/#parallel-looping-dslparallelfor -[parameters]: /docs/components/pipelines/user-guides/parameters +[parameters]: /docs/components/pipelines/user-guides/data-handling/parameters [pipelines-repo]: https://github.com/kubeflow/pipelines [semver-minor-version]: https://semver.org/#:~:text=MINOR%20version%20when%20you%20add%20functionality%20in%20a%20backwards%20compatible%20manner [v1-component-yaml-example]: https://github.com/kubeflow/pipelines/blob/01c87f8a032e70a6ca92cdbefa974a7da387f204/sdk/python/test_data/v1_component_yaml/add_component.yaml @@ -604,4 +604,4 @@ If you believe we missed a breaking change or an important migration step, pleas [vertex-sdk]: https://cloud.google.com/vertex-ai/docs/pipelines/run-pipeline#vertex-ai-sdk-for-python [argo]: https://argoproj.github.io/argo-workflows/ [dsl-pipelinetask-set-env-variable]: https://kubeflow-pipelines.readthedocs.io/en/2.0.0b13/source/dsl.html#kfp.dsl.PipelineTask.set_env_variable -[task-configuration-methods]: /docs/components/pipelines/user-guides/create-components/compose-components-into-pipelines/#task-configurations \ No newline at end of file +[task-configuration-methods]: /docs/components/pipelines/user-guides/components/compose-components-into-pipelines/#task-configurations \ No newline at end of file From 9ea2e5377e6da56102ded8ab57f221f1961a8a41 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Fri, 31 May 2024 16:09:29 -0300 Subject: [PATCH 15/35] Moved "Concepts" to Pipelines Signed-off-by: hbelmiro --- content/en/_redirects | 20 +++++++++---------- .../{legacy-v1 => }/concepts/_index.md | 2 +- .../{legacy-v1 => }/concepts/component.md | 2 +- .../{legacy-v1 => }/concepts/experiment.md | 2 +- .../{legacy-v1 => }/concepts/graph.md | 2 +- .../{legacy-v1 => }/concepts/metadata.md | 0 .../concepts/output-artifact.md | 2 +- .../{legacy-v1 => }/concepts/pipeline.md | 4 ++-- .../{legacy-v1 => }/concepts/run-trigger.md | 2 +- .../pipelines/{legacy-v1 => }/concepts/run.md | 2 +- .../{legacy-v1 => }/concepts/step.md | 2 +- .../pipelines/legacy-v1/introduction.md | 4 ++-- .../pipelines/legacy-v1/sdk/best-practices.md | 4 ++-- .../pipelines/legacy-v1/sdk/output-viewer.md | 2 +- .../pipelines/operator-guides/_index.md | 2 +- .../components/pipelines/reference/_index.md | 2 +- .../pipelines/user-guides/_index.md | 2 +- 17 files changed, 28 insertions(+), 28 deletions(-) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/_index.md (86%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/component.md (98%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/experiment.md (94%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/graph.md (96%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/metadata.md (100%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/output-artifact.md (96%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/pipeline.md (85%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/run-trigger.md (94%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/run.md (97%) rename content/en/docs/components/pipelines/{legacy-v1 => }/concepts/step.md (95%) diff --git a/content/en/_redirects b/content/en/_redirects index 46cbd58f61..096a032a4d 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -245,16 +245,16 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/overview/multi-user/ /docs/components/pipelines/legacy-v1/overview/multi-user/ /docs/components/pipelines/v1/overview/caching/ /docs/components/pipelines/legacy-v1/overview/caching/ /docs/components/pipelines/v1/overview/pipeline-root/ /docs/components/pipelines/legacy-v1/overview/pipeline-root/ -/docs/components/pipelines/v1/concepts/ /docs/components/pipelines/legacy-v1/concepts/ -/docs/components/pipelines/v1/concepts/pipeline/ /docs/components/pipelines/legacy-v1/concepts/pipeline/ -/docs/components/pipelines/v1/concepts/component/ /docs/components/pipelines/legacy-v1/concepts/component/ -/docs/components/pipelines/v1/concepts/graph/ /docs/components/pipelines/legacy-v1/concepts/graph/ -/docs/components/pipelines/v1/concepts/experiment/ /docs/components/pipelines/legacy-v1/concepts/experiment/ -/docs/components/pipelines/v1/concepts/run/ /docs/components/pipelines/legacy-v1/concepts/run/ -/docs/components/pipelines/v1/concepts/run-trigger/ /docs/components/pipelines/legacy-v1/concepts/run-trigger/ -/docs/components/pipelines/v1/concepts/step/ /docs/components/pipelines/legacy-v1/concepts/step/ -/docs/components/pipelines/v1/concepts/output-artifact/ /docs/components/pipelines/legacy-v1/concepts/output-artifact/ -/docs/components/pipelines/v1/concepts/metadata/ /docs/components/pipelines/legacy-v1/concepts/metadata/ +/docs/components/pipelines/v1/concepts/ /docs/components/pipelines/concepts/ +/docs/components/pipelines/v1/concepts/pipeline/ /docs/components/pipelines/concepts/pipeline/ +/docs/components/pipelines/v1/concepts/component/ /docs/components/pipelines/concepts/component/ +/docs/components/pipelines/v1/concepts/graph/ /docs/components/pipelines/concepts/graph/ +/docs/components/pipelines/v1/concepts/experiment/ /docs/components/pipelines/concepts/experiment/ +/docs/components/pipelines/v1/concepts/run/ /docs/components/pipelines/concepts/run/ +/docs/components/pipelines/v1/concepts/run-trigger/ /docs/components/pipelines/concepts/run-trigger/ +/docs/components/pipelines/v1/concepts/step/ /docs/components/pipelines/concepts/step/ +/docs/components/pipelines/v1/concepts/output-artifact/ /docs/components/pipelines/concepts/output-artifact/ +/docs/components/pipelines/v1/concepts/metadata/ /docs/components/pipelines/concepts/metadata/ /docs/components/pipelines/v1/installation/ /docs/components/pipelines/legacy-v1/installation/ /docs/components/pipelines/v1/installation/overview/ /docs/components/pipelines/legacy-v1/installation/overview/ /docs/components/pipelines/v1/installation/localcluster-deployment/ /docs/components/pipelines/legacy-v1/installation/localcluster-deployment/ diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/_index.md b/content/en/docs/components/pipelines/concepts/_index.md similarity index 86% rename from content/en/docs/components/pipelines/legacy-v1/concepts/_index.md rename to content/en/docs/components/pipelines/concepts/_index.md index 8e76ce8dd5..ea25995a14 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/_index.md +++ b/content/en/docs/components/pipelines/concepts/_index.md @@ -1,5 +1,5 @@ +++ title = "Concepts" description = "Concepts used in Kubeflow Pipelines" -weight = 30 +weight = 3 +++ \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/component.md b/content/en/docs/components/pipelines/concepts/component.md similarity index 98% rename from content/en/docs/components/pipelines/legacy-v1/concepts/component.md rename to content/en/docs/components/pipelines/concepts/component.md index baa947c76a..e857412106 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/component.md +++ b/content/en/docs/components/pipelines/concepts/component.md @@ -58,7 +58,7 @@ deserialize the data for use in the downstream component. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. * Build your own diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md b/content/en/docs/components/pipelines/concepts/experiment.md similarity index 94% rename from content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md rename to content/en/docs/components/pipelines/concepts/experiment.md index d8c1ed0730..dac867751e 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/experiment.md +++ b/content/en/docs/components/pipelines/concepts/experiment.md @@ -13,6 +13,6 @@ groups. Experiments can contain arbitrary runs, including ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md b/content/en/docs/components/pipelines/concepts/graph.md similarity index 96% rename from content/en/docs/components/pipelines/legacy-v1/concepts/graph.md rename to content/en/docs/components/pipelines/concepts/graph.md index 51b3b91899..466ad13de0 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/graph.md +++ b/content/en/docs/components/pipelines/concepts/graph.md @@ -25,6 +25,6 @@ parent contains a conditional clause.) ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/metadata.md b/content/en/docs/components/pipelines/concepts/metadata.md similarity index 100% rename from content/en/docs/components/pipelines/legacy-v1/concepts/metadata.md rename to content/en/docs/components/pipelines/concepts/metadata.md diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md b/content/en/docs/components/pipelines/concepts/output-artifact.md similarity index 96% rename from content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md rename to content/en/docs/components/pipelines/concepts/output-artifact.md index b92605bfdc..16dcb5f2e8 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/output-artifact.md +++ b/content/en/docs/components/pipelines/concepts/output-artifact.md @@ -16,7 +16,7 @@ data to rich interactive visualizations. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. * Read more about the available diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md b/content/en/docs/components/pipelines/concepts/pipeline.md similarity index 85% rename from content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md rename to content/en/docs/components/pipelines/concepts/pipeline.md index f45572b095..c95e7e5e11 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/pipeline.md +++ b/content/en/docs/components/pipelines/concepts/pipeline.md @@ -6,7 +6,7 @@ weight = 10 +++ A *pipeline* is a description of a machine learning (ML) workflow, including all -of the [components](/docs/components/pipelines/legacy-v1/concepts/component/) in the workflow and how the components relate to each other in +of the [components](/docs/components/pipelines/concepts/component/) in the workflow and how the components relate to each other in the form of a [graph](/docs/components/pipelines/concepts/graph/). The pipeline configuration includes the definition of the inputs (parameters) required to run the pipeline and the inputs and outputs of each component. @@ -19,6 +19,6 @@ After developing your pipeline, you can upload your pipeline using the Kubeflow ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md b/content/en/docs/components/pipelines/concepts/run-trigger.md similarity index 94% rename from content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md rename to content/en/docs/components/pipelines/concepts/run-trigger.md index 47e3e5b2fd..8d9156c105 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/run-trigger.md +++ b/content/en/docs/components/pipelines/concepts/run-trigger.md @@ -16,6 +16,6 @@ available: ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/run.md b/content/en/docs/components/pipelines/concepts/run.md similarity index 97% rename from content/en/docs/components/pipelines/legacy-v1/concepts/run.md rename to content/en/docs/components/pipelines/concepts/run.md index fd51d991ef..425ac0bdd7 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/run.md +++ b/content/en/docs/components/pipelines/concepts/run.md @@ -26,6 +26,6 @@ triggered to run frequently. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. diff --git a/content/en/docs/components/pipelines/legacy-v1/concepts/step.md b/content/en/docs/components/pipelines/concepts/step.md similarity index 95% rename from content/en/docs/components/pipelines/legacy-v1/concepts/step.md rename to content/en/docs/components/pipelines/concepts/step.md index be561a1b0b..cf8e9ebecf 100644 --- a/content/en/docs/components/pipelines/legacy-v1/concepts/step.md +++ b/content/en/docs/components/pipelines/concepts/step.md @@ -14,6 +14,6 @@ an if/else like clause in the pipeline code. ## Next steps * Read an [overview of Kubeflow Pipelines](/docs/components/pipelines/introduction/). -* Follow the [pipelines quickstart guide](/docs/components/pipelines/legacy-v1/overview/quickstart/) +* Follow the [pipelines quickstart guide](/docs/components/pipelines/getting-started/) to deploy Kubeflow and run a sample pipeline directly from the Kubeflow Pipelines UI. \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/introduction.md b/content/en/docs/components/pipelines/legacy-v1/introduction.md index 0eafe96eb0..29ae618a0e 100644 --- a/content/en/docs/components/pipelines/legacy-v1/introduction.md +++ b/content/en/docs/components/pipelines/legacy-v1/introduction.md @@ -56,8 +56,8 @@ A _pipeline component_ is a self-contained set of user code, packaged as a performs one step in the pipeline. For example, a component can be responsible for data preprocessing, data transformation, model training, and so on. -See the conceptual guides to [pipelines](/docs/components/pipelines/legacy-v1/concepts/pipeline/) -and [components](/docs/components/pipelines/legacy-v1/concepts/component/). +See the conceptual guides to [pipelines](/docs/components/pipelines/concepts/pipeline/) +and [components](/docs/components/pipelines/concepts/component/). ## Example of a pipeline diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md b/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md index 5226c88b93..fadba01ad4 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/best-practices.md @@ -13,8 +13,8 @@ This page describes some recommended practices for designing components. For an application of these best practices, see the [component development guide](/docs/components/pipelines/sdk/component-development). If you're new to pipelines, see the conceptual guides to -[pipelines](/docs/components/pipelines/legacy-v1/concepts/pipeline/) -and [components](/docs/components/pipelines/legacy-v1/concepts/component/). +[pipelines](/docs/components/pipelines/concepts/pipeline/) +and [components](/docs/components/pipelines/concepts/component/). ### General component design rules diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md index ea26d4e5bc..735181669c 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md @@ -7,7 +7,7 @@ weight = 80 This page shows you how to use the Kubeflow Pipelines UI to visualize output -from a Kubeflow Pipelines [component](/docs/components/pipelines/legacy-v1/concepts/component/). +from a Kubeflow Pipelines [component](/docs/components/pipelines/concepts/component/). ## Introduction diff --git a/content/en/docs/components/pipelines/operator-guides/_index.md b/content/en/docs/components/pipelines/operator-guides/_index.md index 8c1b4fa1b2..2c2a3c6a79 100644 --- a/content/en/docs/components/pipelines/operator-guides/_index.md +++ b/content/en/docs/components/pipelines/operator-guides/_index.md @@ -1,5 +1,5 @@ +++ title = "Operator Guides" description = "Documentation for operators of Kubeflow Pipelines." -weight = 4 +weight = 5 +++ diff --git a/content/en/docs/components/pipelines/reference/_index.md b/content/en/docs/components/pipelines/reference/_index.md index 78b5dcdf86..28b7970d9c 100644 --- a/content/en/docs/components/pipelines/reference/_index.md +++ b/content/en/docs/components/pipelines/reference/_index.md @@ -1,5 +1,5 @@ +++ title = "Reference" description = "Reference docs for Kubeflow Pipelines Version 2" -weight = 6 +weight = 7 +++ diff --git a/content/en/docs/components/pipelines/user-guides/_index.md b/content/en/docs/components/pipelines/user-guides/_index.md index 1862eedce8..0181bf3012 100644 --- a/content/en/docs/components/pipelines/user-guides/_index.md +++ b/content/en/docs/components/pipelines/user-guides/_index.md @@ -1,5 +1,5 @@ +++ title = "User Guides" description = "Documentation for users of Kubeflow Pipelines." -weight = 5 +weight = 6 +++ From 4745c0e075be3e89863d80233b6790bee6a32e55 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 4 Jun 2024 10:29:42 -0300 Subject: [PATCH 16/35] Moved component-spec.md Signed-off-by: hbelmiro --- content/en/_redirects | 4 ++-- .../pipelines/{legacy-v1 => }/reference/component-spec.md | 2 +- content/en/docs/components/pipelines/reference/sdk.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) rename content/en/docs/components/pipelines/{legacy-v1 => }/reference/component-spec.md (99%) diff --git a/content/en/_redirects b/content/en/_redirects index 096a032a4d..6f978f656c 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -286,9 +286,9 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/tutorials/cloud-tutorials/ /docs/components/pipelines/legacy-v1/tutorials/cloud-tutorials/ /docs/components/pipelines/v1/troubleshooting/ /docs/components/pipelines/legacy-v1/troubleshooting/ /docs/components/pipelines/v1/reference/ /docs/components/pipelines/legacy-v1/reference/ -/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/legacy-v1/reference/component-spec/ +/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/reference/component-spec/ /docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ -/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/legacy-v1/reference/component-spec/ +/docs/components/pipelines/v1/reference/component-spec/ /docs/components/pipelines/reference/component-spec/ /docs/components/pipelines/v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/legacy-v1/reference/api/kubeflow-pipeline-api-spec/ /docs/components/pipelines/v1/reference/sdk/ /docs/components/pipelines/legacy-v1/reference/sdk/ /docs/components/pipelines/v2/introduction/ /docs/components/pipelines/overview/ diff --git a/content/en/docs/components/pipelines/legacy-v1/reference/component-spec.md b/content/en/docs/components/pipelines/reference/component-spec.md similarity index 99% rename from content/en/docs/components/pipelines/legacy-v1/reference/component-spec.md rename to content/en/docs/components/pipelines/reference/component-spec.md index ea6633b5fc..840ba37aa3 100644 --- a/content/en/docs/components/pipelines/legacy-v1/reference/component-spec.md +++ b/content/en/docs/components/pipelines/reference/component-spec.md @@ -1,7 +1,7 @@ +++ title = "Component Specification" description = "Definition of a Kubeflow Pipelines component" -weight = 10 +weight = 4 +++ {{% alert title="Out of date" color="warning" %}} diff --git a/content/en/docs/components/pipelines/reference/sdk.md b/content/en/docs/components/pipelines/reference/sdk.md index f333a2d5ac..53658fab56 100644 --- a/content/en/docs/components/pipelines/reference/sdk.md +++ b/content/en/docs/components/pipelines/reference/sdk.md @@ -1,7 +1,7 @@ +++ title = " Pipelines SDK Reference" description = "Reference documentation for the Kubeflow Pipelines SDK Version 2" -weight = 4 +weight = 5 +++ From 40c788e23a3cb2e8f0aaf4a44ca1d18727680de2 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 4 Jun 2024 10:33:31 -0300 Subject: [PATCH 17/35] Moved interfaces.md Signed-off-by: hbelmiro --- content/en/_redirects | 2 +- content/en/docs/components/pipelines/concepts/_index.md | 2 +- .../pipelines/{legacy-v1/overview => }/interfaces.md | 4 ++-- .../en/docs/components/pipelines/operator-guides/_index.md | 2 +- content/en/docs/components/pipelines/reference/_index.md | 2 +- content/en/docs/components/pipelines/user-guides/_index.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) rename content/en/docs/components/pipelines/{legacy-v1/overview => }/interfaces.md (98%) diff --git a/content/en/_redirects b/content/en/_redirects index 6f978f656c..284646211d 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -241,7 +241,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/introduction/ /docs/components/pipelines/legacy-v1/introduction/ /docs/components/pipelines/v1/overview/ /docs/components/pipelines/legacy-v1/overview/ /docs/components/pipelines/v1/overview/quickstart/ /docs/components/pipelines/legacy-v1/overview/quickstart/ -/docs/components/pipelines/v1/overview/interfaces/ /docs/components/pipelines/legacy-v1/overview/interfaces/ +/docs/components/pipelines/v1/overview/interfaces/ /docs/components/pipelines/interfaces/ /docs/components/pipelines/v1/overview/multi-user/ /docs/components/pipelines/legacy-v1/overview/multi-user/ /docs/components/pipelines/v1/overview/caching/ /docs/components/pipelines/legacy-v1/overview/caching/ /docs/components/pipelines/v1/overview/pipeline-root/ /docs/components/pipelines/legacy-v1/overview/pipeline-root/ diff --git a/content/en/docs/components/pipelines/concepts/_index.md b/content/en/docs/components/pipelines/concepts/_index.md index ea25995a14..c179a4cc24 100644 --- a/content/en/docs/components/pipelines/concepts/_index.md +++ b/content/en/docs/components/pipelines/concepts/_index.md @@ -1,5 +1,5 @@ +++ title = "Concepts" description = "Concepts used in Kubeflow Pipelines" -weight = 3 +weight = 4 +++ \ No newline at end of file diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md b/content/en/docs/components/pipelines/interfaces.md similarity index 98% rename from content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md rename to content/en/docs/components/pipelines/interfaces.md index cf30f60351..13cfdf818b 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/interfaces.md +++ b/content/en/docs/components/pipelines/interfaces.md @@ -1,7 +1,7 @@ +++ -title = "Pipelines Interfaces" +title = "Interfaces" description = "The ways you can interact with the Kubeflow Pipelines system" -weight = 20 +weight = 3 +++ diff --git a/content/en/docs/components/pipelines/operator-guides/_index.md b/content/en/docs/components/pipelines/operator-guides/_index.md index 2c2a3c6a79..c4811c89f9 100644 --- a/content/en/docs/components/pipelines/operator-guides/_index.md +++ b/content/en/docs/components/pipelines/operator-guides/_index.md @@ -1,5 +1,5 @@ +++ title = "Operator Guides" description = "Documentation for operators of Kubeflow Pipelines." -weight = 5 +weight = 6 +++ diff --git a/content/en/docs/components/pipelines/reference/_index.md b/content/en/docs/components/pipelines/reference/_index.md index 28b7970d9c..bd6bb11adf 100644 --- a/content/en/docs/components/pipelines/reference/_index.md +++ b/content/en/docs/components/pipelines/reference/_index.md @@ -1,5 +1,5 @@ +++ title = "Reference" description = "Reference docs for Kubeflow Pipelines Version 2" -weight = 7 +weight = 8 +++ diff --git a/content/en/docs/components/pipelines/user-guides/_index.md b/content/en/docs/components/pipelines/user-guides/_index.md index 0181bf3012..aaac034e86 100644 --- a/content/en/docs/components/pipelines/user-guides/_index.md +++ b/content/en/docs/components/pipelines/user-guides/_index.md @@ -1,5 +1,5 @@ +++ title = "User Guides" description = "Documentation for users of Kubeflow Pipelines." -weight = 6 +weight = 7 +++ From c9b762d70e5e05a623b4a1016cdf0db27a281109 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 4 Jun 2024 10:39:30 -0300 Subject: [PATCH 18/35] Moved pipeline-root.md Signed-off-by: hbelmiro --- content/en/_redirects | 2 +- .../pipelines/{legacy-v1/overview => concepts}/pipeline-root.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename content/en/docs/components/pipelines/{legacy-v1/overview => concepts}/pipeline-root.md (99%) diff --git a/content/en/_redirects b/content/en/_redirects index 284646211d..e116262c85 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -244,7 +244,7 @@ docs/started/requirements/ /docs/started/getting-started/ /docs/components/pipelines/v1/overview/interfaces/ /docs/components/pipelines/interfaces/ /docs/components/pipelines/v1/overview/multi-user/ /docs/components/pipelines/legacy-v1/overview/multi-user/ /docs/components/pipelines/v1/overview/caching/ /docs/components/pipelines/legacy-v1/overview/caching/ -/docs/components/pipelines/v1/overview/pipeline-root/ /docs/components/pipelines/legacy-v1/overview/pipeline-root/ +/docs/components/pipelines/v1/overview/pipeline-root/ /docs/components/pipelines/concepts/pipeline-root/ /docs/components/pipelines/v1/concepts/ /docs/components/pipelines/concepts/ /docs/components/pipelines/v1/concepts/pipeline/ /docs/components/pipelines/concepts/pipeline/ /docs/components/pipelines/v1/concepts/component/ /docs/components/pipelines/concepts/component/ diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/pipeline-root.md b/content/en/docs/components/pipelines/concepts/pipeline-root.md similarity index 99% rename from content/en/docs/components/pipelines/legacy-v1/overview/pipeline-root.md rename to content/en/docs/components/pipelines/concepts/pipeline-root.md index 3cef3a333c..2bc7af89b7 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/pipeline-root.md +++ b/content/en/docs/components/pipelines/concepts/pipeline-root.md @@ -1,7 +1,7 @@ +++ title = "Pipeline Root" description = "Getting started with Kubeflow Pipelines pipeline root" -weight = 50 +weight = 15 +++ {{% beta-status From 775bf70b087f170c55709bbf565118424a3d2731 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 4 Jun 2024 10:41:16 -0300 Subject: [PATCH 19/35] Reverted changes outside of pipelines Signed-off-by: hbelmiro --- content/en/docs/components/training/user-guides/mpi.md | 2 +- .../en/docs/external-add-ons/feature-store/getting-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/components/training/user-guides/mpi.md b/content/en/docs/components/training/user-guides/mpi.md index 77e260b842..a5b9d4f496 100644 --- a/content/en/docs/components/training/user-guides/mpi.md +++ b/content/en/docs/components/training/user-guides/mpi.md @@ -28,7 +28,7 @@ cd mpi-operator kubectl apply -f deploy/v2beta1/mpi-operator.yaml ``` -Alternatively, follow the [getting started guide](https://www.kubeflow.org/docs/started/) to deploy Kubeflow. +Alternatively, follow the [getting started guide](https://www.kubeflow.org/docs/started/getting-started/) to deploy Kubeflow. An alpha version of MPI support was introduced with Kubeflow 0.2.0. You must be using a version of Kubeflow newer than 0.2.0. diff --git a/content/en/docs/external-add-ons/feature-store/getting-started.md b/content/en/docs/external-add-ons/feature-store/getting-started.md index 966041013d..092d161b00 100644 --- a/content/en/docs/external-add-ons/feature-store/getting-started.md +++ b/content/en/docs/external-add-ons/feature-store/getting-started.md @@ -13,7 +13,7 @@ For an overview of Feast, please read [Introduction to Feast](/docs/external-add **Overview** -* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/getting-started). +* This guide assumes that you have a running Kubeflow cluster already. If you don't have Kubeflow installed, then head on over to the [Kubeflow installation guide](/docs/started/getting-started/). * This guide also assumes that you have a running online feature store that Feast supports (Redis, Datastore, DynamoDB). * The latest version of Feast does not need to be installed into Kubernetes. It is possible to run Feast completely from CI or as a client library (during training or inference) * Feast requires a bucket (S3, GCS, Minio, etc) to maintain a feature registry, requires an online feature store for serving feature values, and it requires a scheduler to keep the online store up to date. From 84a164a1160a22f4ab5add781c09f09db194e6b8 Mon Sep 17 00:00:00 2001 From: Helber Belmiro Date: Tue, 4 Jun 2024 16:23:51 -0400 Subject: [PATCH 20/35] Update content/en/docs/components/pipelines/reference/sdk.md Signed-off-by: hbelmiro Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --- content/en/docs/components/pipelines/reference/sdk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/components/pipelines/reference/sdk.md b/content/en/docs/components/pipelines/reference/sdk.md index 53658fab56..fb379e4423 100644 --- a/content/en/docs/components/pipelines/reference/sdk.md +++ b/content/en/docs/components/pipelines/reference/sdk.md @@ -1,5 +1,5 @@ +++ -title = " Pipelines SDK Reference" +title = "Pipelines SDK Reference" description = "Reference documentation for the Kubeflow Pipelines SDK Version 2" weight = 5 From 82bc5b149a6c23d06f79dd9ca8137e45d99ea318 Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 4 Jun 2024 17:29:59 -0300 Subject: [PATCH 21/35] Removed warning Signed-off-by: hbelmiro --- .../en/docs/components/pipelines/reference/component-spec.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/en/docs/components/pipelines/reference/component-spec.md b/content/en/docs/components/pipelines/reference/component-spec.md index 840ba37aa3..daf95399ff 100644 --- a/content/en/docs/components/pipelines/reference/component-spec.md +++ b/content/en/docs/components/pipelines/reference/component-spec.md @@ -4,10 +4,6 @@ description = "Definition of a Kubeflow Pipelines component" weight = 4 +++ -{{% alert title="Out of date" color="warning" %}} -This guide contains outdated information pertaining to Kubeflow 1.0. This guide -needs to be updated for Kubeflow 1.1. -{{% /alert %}} This specification describes the container component data model for Kubeflow Pipelines. The data model is serialized to a file in YAML format for sharing. From b2aba66573b8e74313e04898d3e24773cb9452eb Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Mon, 10 Jun 2024 13:50:38 -0300 Subject: [PATCH 22/35] Fixed /docs/components/pipelines/installation/ broken links Signed-off-by: hbelmiro --- content/en/_redirects | 4 ++-- .../docs/components/pipelines/concepts/pipeline-root.md | 4 ++-- .../pipelines/legacy-v1/installation/choose-executor.md | 2 +- .../pipelines/legacy-v1/installation/overview.md | 8 ++++---- .../legacy-v1/installation/standalone-deployment.md | 2 +- .../pipelines/legacy-v1/installation/upgrade.md | 4 ++-- .../components/pipelines/legacy-v1/overview/caching.md | 2 +- .../components/pipelines/legacy-v1/overview/quickstart.md | 2 +- .../components/pipelines/legacy-v1/sdk/output-viewer.md | 2 +- .../components/pipelines/legacy-v1/troubleshooting.md | 2 +- .../pipelines/user-guides/core-functions/connect-api.md | 4 ++-- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/en/_redirects b/content/en/_redirects index e116262c85..1aa97e714d 100644 --- a/content/en/_redirects +++ b/content/en/_redirects @@ -49,7 +49,7 @@ /docs/pipelines/sdk/reusable-components/ /docs/examples/shared-resources/ /docs/pipelines/sdk/build-component/ /docs/components/pipelines/sdk/build-pipeline/ /docs/components/pipelines/sdk/build-component/ /docs/components/pipelines/sdk/build-pipeline/ -/docs/components/pipelines/upgrade/ /docs/components/pipelines/installation/upgrade/ +/docs/components/pipelines/upgrade/ /docs/components/pipelines/operator-guides/installation/upgrade/ # Moved the guide to monitoring GKE deployments. /docs/other-guides/monitoring/ /docs/distributions/gke/monitoring/ @@ -61,7 +61,7 @@ /docs/pipelines/sdk/dsl-overview/ /docs/components/pipelines/sdk/sdk-overview/ # Created a new section for pipelines installation. -/docs/pipelines/standalone-deployment-gcp/ /docs/components/pipelines/installation/standalone-deployment/ +/docs/pipelines/standalone-deployment-gcp/ /docs/components/pipelines/operator-guides/installation/standalone-deployment/ # Removed the downloads page from Reference to Getting Started with Kubeflow /docs/reference/downloads/ /docs/started/getting-started/ diff --git a/content/en/docs/components/pipelines/concepts/pipeline-root.md b/content/en/docs/components/pipelines/concepts/pipeline-root.md index 2bc7af89b7..df45ae9acd 100644 --- a/content/en/docs/components/pipelines/concepts/pipeline-root.md +++ b/content/en/docs/components/pipelines/concepts/pipeline-root.md @@ -7,12 +7,12 @@ weight = 15 {{% beta-status feedbacklink="https://github.com/kubeflow/pipelines/issues" %}} -Starting from [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) and Kubeflow Pipelines 1.7.0, Kubeflow Pipelines supports a new intermediate artifact repository feature: pipeline root 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). +Starting from [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) and Kubeflow Pipelines 1.7.0, Kubeflow Pipelines supports a new intermediate artifact repository feature: pipeline root in both [standalone deployment](https://www.kubeflow.org/docs/components/pipelines/legacy-v1/installation/standalone-deployment/) and [AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs). ## Before you start This guide tells you the basic concepts of Kubeflow Pipelines pipeline root and how to use it. This guide assumes that you already have Kubeflow Pipelines installed, or want to use standalone or AI Platform Pipelines options in the [Kubeflow Pipelines deployment -guide](/docs/components/pipelines/installation/) to deploy Kubeflow Pipelines. +guide](/docs/components/pipelines/operator-guides/installation/) to deploy Kubeflow Pipelines. ## What is pipeline root? diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md b/content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md index f0b7c3d979..d1aff2196d 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/choose-executor.md @@ -92,7 +92,7 @@ To upgrade, refer to [upgrading Kubeflow Pipelines](/docs/components/pipelines/u For [AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs), check the "Use emissary executor" checkbox during installation. -For [Kubeflow Pipelines Standalone](https://www.kubeflow.org/docs/components/pipelines/installation/standalone-deployment/), install `env/platform-agnostic-emissary`: +For [Kubeflow Pipelines Standalone](https://www.kubeflow.org/docs/components/pipelines/legacy-v1/installation/standalone-deployment/), install `env/platform-agnostic-emissary`: ```bash kubectl apply -k "github.com/kubeflow/pipelines/manifests/kustomize/env/platform-agnostic-emissary?ref=$PIPELINE_VERSION" diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/overview.md b/content/en/docs/components/pipelines/legacy-v1/installation/overview.md index 86abfb549f..e2e09a13cc 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/overview.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/overview.md @@ -14,7 +14,7 @@ portable installation that only includes Kubeflow Pipelines. * Kubeflow Pipelines as [part of a full Kubeflow deployment](#full-kubeflow-deployment) provides all Kubeflow components and more integration with each platform. * **Beta**: [Google Cloud AI Platform Pipelines](#google-cloud-ai-platform-pipelines) makes it easier to install and use Kubeflow Pipelines on Google Cloud by providing a management UI on [Google Cloud Console](https://console.cloud.google.com/ai-platform/pipelines/clusters). -* A [local](/docs/components/pipelines/installation/localcluster-deployment) Kubeflow Pipelines deployment for testing purposes. +* A [local](/docs/components/pipelines/legacy-v1/installation/localcluster-deployment) Kubeflow Pipelines deployment for testing purposes. ## Choosing an installation option @@ -23,7 +23,7 @@ all Kubeflow components and more integration with each platform. If yes, choose the [full Kubeflow deployment](#full-kubeflow-deployment). 1. Can you use a cloud/on-prem Kubernetes cluster? - If you can't, you should try using Kubeflow Pipelines on a local Kubernetes cluster for learning and testing purposes by following the steps in [Deploying Kubeflow Pipelines on a local cluster](/docs/components/pipelines/installation/localcluster-deployment). + If you can't, you should try using Kubeflow Pipelines on a local Kubernetes cluster for learning and testing purposes by following the steps in [Deploying Kubeflow Pipelines on a local cluster](/docs/components/pipelines/legacy-v1/installation/localcluster-deployment). 1. Do you want to use Kubeflow Pipelines with [multi-user support](https://github.com/kubeflow/pipelines/issues/1223)? If yes, choose the [full Kubeflow deployment](#full-kubeflow-deployment) with version >= v1.1. @@ -56,7 +56,7 @@ Kubeflow Pipelines into an existing Kubernetes cluster. Installation guide : [Kubeflow Pipelines Standalone deployment - guide](/docs/components/pipelines/installation/standalone-deployment/) + guide](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/) Interfaces : @@ -74,7 +74,7 @@ Release Schedule You will have access to the latest features. Upgrade Support (**Beta**) -: [Upgrading Kubeflow Pipelines Standalone](/docs/components/pipelines/installation/standalone-deployment/#upgrading-kubeflow-pipelines) introduces how to upgrade +: [Upgrading Kubeflow Pipelines Standalone](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/#upgrading-kubeflow-pipelines) introduces how to upgrade in place. Google Cloud Integrations diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md b/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md index 583bfba219..e18aa8225e 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/standalone-deployment.md @@ -104,7 +104,7 @@ Kubeflow Pipelines will change default executor from Docker to Emissary starting deprecated on Kubernetes 1.20+. For Kubeflow Pipelines before v1.8, configure to use Emissary executor by -referring to [Argo Workflow Executors](/docs/components/pipelines/installation/choose-executor). +referring to [Argo Workflow Executors](/docs/components/pipelines/legacy-v1/installation/choose-executor). {{% /alert %}} 1. Get the public URL for the Kubeflow Pipelines UI and use it to access the Kubeflow Pipelines UI: diff --git a/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md b/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md index 5c83d73b14..a630b5f22f 100644 --- a/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md +++ b/content/en/docs/components/pipelines/legacy-v1/installation/upgrade.md @@ -18,7 +18,7 @@ For upgrade instructions, refer to distribution specific documentations: [v1.7]: https://github.com/kubeflow/pipelines/releases/tag/1.7.0 -* **Breaking Change**: Metadata UI and visualizations are not compatible with TensorFlow Extended (TFX) <= v1.0.0. Upgrade to v1.2.0 or above, refer to [Kubeflow Pipelines Backend and TensorFlow Extended (TFX) compatibility matrix](/docs/components/pipelines/installation/compatibility-matrix/). +* **Breaking Change**: Metadata UI and visualizations are not compatible with TensorFlow Extended (TFX) <= v1.0.0. Upgrade to v1.2.0 or above, refer to [Kubeflow Pipelines Backend and TensorFlow Extended (TFX) compatibility matrix](/docs/components/pipelines/legacy-v1/installation/compatibility-matrix/). * **Notice**: Emissary executor (Alpha), a new argo workflow executor is available as an option. Due to [Kubernetes deprecating Docker as a container runtime after v1.20](https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/), emissary may become the default workflow executor for Kubeflow Pipelines in the near future. @@ -26,6 +26,6 @@ For upgrade instructions, refer to distribution specific documentations: Alternatively, using emissary executor (Alpha) removes the restriction on container runtime, but note some of your pipelines may require manual migrations. The Kubeflow Pipelines team welcomes your feedback in [the Emissary Executor feedback github issue](https://github.com/kubeflow/pipelines/issues/6249). - For detailed configuration and migration instructions for both options, refer to [Argo Workflow Executors](https://www.kubeflow.org/docs/components/pipelines/installation/choose-executor/). + For detailed configuration and migration instructions for both options, refer to [Argo Workflow Executors](https://www.kubeflow.org/docs/components/pipelines/legacy-v1/installation/choose-executor/). * **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. diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/caching.md b/content/en/docs/components/pipelines/legacy-v1/overview/caching.md index 74e5d61924..63c1b2b196 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/caching.md +++ b/content/en/docs/components/pipelines/legacy-v1/overview/caching.md @@ -12,7 +12,7 @@ Starting from Kubeflow Pipelines 0.4, Kubeflow Pipelines supports step caching c ## Before you start This guide tells you the basic concepts of Kubeflow Pipelines step caching and how to use it. -This guide assumes that you already have Kubeflow Pipelines installed or want to use options in the [Kubeflow Pipelines deployment guide](/docs/components/pipelines/installation/) to deploy Kubeflow Pipelines. +This guide assumes that you already have Kubeflow Pipelines installed or want to use options in the [Kubeflow Pipelines deployment guide](/docs/components/pipelines/operator-guides/installation/) to deploy Kubeflow Pipelines. ## What is step caching? diff --git a/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md b/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md index 1c380253e5..dd1df360be 100644 --- a/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md +++ b/content/en/docs/components/pipelines/legacy-v1/overview/quickstart.md @@ -15,7 +15,7 @@ Kubeflow Pipelines UI. ## Deploy Kubeflow and open the Kubeflow Pipelines UI -There are several options to [deploy Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/overview/), follow the option that best suits your needs. If you are uncertain and just want to try out kubeflow pipelines it is recommended to start with the [standalone deployment](/docs/components/pipelines/installation/standalone-deployment/). +There are several options to [deploy Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/overview/), follow the option that best suits your needs. If you are uncertain and just want to try out kubeflow pipelines it is recommended to start with the [standalone deployment](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/). Once you have deployed Kubeflow Pipelines, make sure you can access the UI. The steps to access the UI vary based on the method you used to deploy Kubeflow Pipelines. diff --git a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md index 735181669c..d83af4d3f2 100644 --- a/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md +++ b/content/en/docs/components/pipelines/legacy-v1/sdk/output-viewer.md @@ -59,7 +59,7 @@ of all metrics visualizations can be found in [metrics_visualization_v2.py](http ### Requirements -* Use Kubeflow Pipelines v1.7.0 or above: [upgrade Kubeflow Pipelines](/docs/components/pipelines/installation/standalone-deployment/#upgrading-kubeflow-pipelines). +* Use Kubeflow Pipelines v1.7.0 or above: [upgrade Kubeflow Pipelines](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/#upgrading-kubeflow-pipelines). * Use `kfp.dsl.PipelineExecutionMode.V2_COMPATIBLE` mode when you [compile and run your pipelines](/docs/components/pipelines/sdk-v2/build-pipeline/#compile-and-run-your-pipeline). * Make sure to use the latest environment kustomize manifest [pipelines/manifests/kustomize/env/dev/kustomization.yaml](https://github.com/kubeflow/pipelines/blob/sdk/release-1.8/manifests/kustomize/env/dev/kustomization.yaml). diff --git a/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md b/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md index fa057025ef..d5ea2f019c 100644 --- a/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md +++ b/content/en/docs/components/pipelines/legacy-v1/troubleshooting.md @@ -88,4 +88,4 @@ You can resolve this issue by using one of the following options: ## TFX visualizations do not show up or throw an error -Confirm your Kubeflow Pipelines backend version is compatible with your TFX version, refer to [Kubeflow Pipelines Compatibility Matrix](/docs/components/pipelines/installation/compatibility-matrix/). +Confirm your Kubeflow Pipelines backend version is compatible with your TFX version, refer to [Kubeflow Pipelines Compatibility Matrix](/docs/components/pipelines/legacy-v1/installation/compatibility-matrix/). diff --git a/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md b/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md index f88273df23..a27ae69f63 100644 --- a/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md +++ b/content/en/docs/components/pipelines/user-guides/core-functions/connect-api.md @@ -309,7 +309,7 @@ This information only applies to _Standalone Kubeflow Pipelines_. When running inside the Kubernetes cluster, you may connect Pipelines SDK directly to the `ml-pipeline-ui` service via [cluster-internal service DNS resolution](https://kubernetes.io/docs/concepts/services-networking/service/#discovering-services). {{% alert title="Tip" color="info" %}} -In [standalone deployments](/docs/components/pipelines/installation/standalone-deployment/) of Kubeflow Pipelines, there is no authentication enforced on the `ml-pipeline-ui` service. +In [standalone deployments](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/) of Kubeflow Pipelines, there is no authentication enforced on the `ml-pipeline-ui` service. {{% /alert %}} For example, when running in the __same namespace__ as Kubeflow: @@ -350,7 +350,7 @@ This information only applies to _Standalone Kubeflow Pipelines_. When running outside the Kubernetes cluster, you may connect Pipelines SDK to the `ml-pipeline-ui` service by using [kubectl port-forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/). {{% alert title="Tip" color="info" %}} -In [standalone deployments](/docs/components/pipelines/installation/standalone-deployment/) of Kubeflow Pipelines, there is no authentication enforced on the `ml-pipeline-ui` service. +In [standalone deployments](/docs/components/pipelines/legacy-v1/installation/standalone-deployment/) of Kubeflow Pipelines, there is no authentication enforced on the `ml-pipeline-ui` service. {{% /alert %}} __Step 1:__ run the following command on your external system to initiate port-forwarding: From 266dea889a97a89a3a8f2f6d166a6355b23c255b Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Mon, 10 Jun 2024 13:58:17 -0300 Subject: [PATCH 23/35] Removed beta status flag from pipeline-root.md Signed-off-by: hbelmiro --- content/en/docs/components/pipelines/concepts/pipeline-root.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/docs/components/pipelines/concepts/pipeline-root.md b/content/en/docs/components/pipelines/concepts/pipeline-root.md index df45ae9acd..d5a7e25877 100644 --- a/content/en/docs/components/pipelines/concepts/pipeline-root.md +++ b/content/en/docs/components/pipelines/concepts/pipeline-root.md @@ -4,8 +4,6 @@ description = "Getting started with Kubeflow Pipelines pipeline root" weight = 15 +++ -{{% beta-status -feedbacklink="https://github.com/kubeflow/pipelines/issues" %}} Starting from [Kubeflow Pipelines SDK v2](https://www.kubeflow.org/docs/components/pipelines/sdk-v2/) and Kubeflow Pipelines 1.7.0, Kubeflow Pipelines supports a new intermediate artifact repository feature: pipeline root in both [standalone deployment](https://www.kubeflow.org/docs/components/pipelines/legacy-v1/installation/standalone-deployment/) and [AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs). From 9665cfe84cbfb6a9ceb7dec24f5fe8794c9fed1f Mon Sep 17 00:00:00 2001 From: hbelmiro Date: Tue, 11 Jun 2024 15:17:32 -0300 Subject: [PATCH 24/35] Fixed broken links Signed-off-by: hbelmiro --- assets/icons/pipelines.svg | 2 +- content/en/_redirects | 60 +++++++++---------- .../notebooks/jupyter-tensorflow-examples.md | 2 +- .../pipelines/concepts/component.md | 6 +- .../pipelines/concepts/experiment.md | 2 +- .../components/pipelines/concepts/graph.md | 2 +- .../pipelines/concepts/output-artifact.md | 4 +- .../pipelines/concepts/pipeline-root.md | 4 +- .../components/pipelines/concepts/pipeline.md | 2 +- .../pipelines/concepts/run-trigger.md | 2 +- .../docs/components/pipelines/concepts/run.md | 2 +- .../components/pipelines/concepts/step.md | 2 +- .../docs/components/pipelines/interfaces.md | 6 +- .../legacy-v1/installation/choose-executor.md | 8 +-- .../installation/standalone-deployment.md | 2 +- .../legacy-v1/installation/upgrade.md | 4 +- .../pipelines/legacy-v1/introduction.md | 2 +- .../legacy-v1/overview/multi-user.md | 8 +-- .../legacy-v1/overview/quickstart.md | 4 +- .../pipelines/legacy-v1/sdk/best-practices.md | 2 +- .../legacy-v1/sdk/build-pipeline.ipynb | 14 ++--- .../pipelines/legacy-v1/sdk/build-pipeline.md | 16 ++--- .../legacy-v1/sdk/component-development.md | 10 ++-- .../pipelines/legacy-v1/sdk/dsl-recursion.md | 2 +- .../legacy-v1/sdk/enviroment_variables.md | 4 +- .../pipelines/legacy-v1/sdk/install-sdk.md | 4 +- .../legacy-v1/sdk/manipulate-resources.md | 4 +- .../pipelines/legacy-v1/sdk/output-viewer.md | 7 +-- .../pipelines/legacy-v1/sdk/parameters.md | 2 +- .../sdk/python-function-components.ipynb | 10 ++-- .../sdk/python-function-components.md | 12 ++-- .../pipelines/legacy-v1/sdk/sdk-overview.md | 22 +++---- .../legacy-v1/sdk/static-type-checking.md | 2 +- .../pipelines/legacy-v1/troubleshooting.md | 4 +- .../legacy-v1/tutorials/api-pipelines.md | 6 +- .../legacy-v1/tutorials/build-pipeline.md | 6 +- .../legacy-v1/tutorials/sdk-examples.md | 2 +- .../en/docs/components/pipelines/overview.md | 2 +- .../compose-components-into-pipelines.md | 2 +- .../user-guides/core-functions/connect-api.md | 6 +- .../platform-specific-features.md | 4 +- .../user-guides/data-handling/artifacts.md | 2 +- .../pipelines/user-guides/migration.md | 4 +- .../feature-store/getting-started.md | 4 +- content/en/docs/started/kubeflow-examples.md | 2 +- content/en/pipelines.svg | 2 +- 46 files changed, 138 insertions(+), 143 deletions(-) diff --git a/assets/icons/pipelines.svg b/assets/icons/pipelines.svg index e4587b376c..13c52e5edf 100644 --- a/assets/icons/pipelines.svg +++ b/assets/icons/pipelines.svg @@ -54,7 +54,7 @@ inkscape:pagecheckerboard="false" />