KFP: Add UI tutorial section in v2 Quickstart documentation. (#3538)

* Reorganize the structure for Quickstart under v2.
Update screenshot for v2 tutorial.

* Reframe the instruction (merge UI and SDK into one section).
Change from creating experiment and then creating run to creating run
directly.
Change the UI example link.
Remove unused screenshot.

* Update element id
This commit is contained in:
Joe Li 2023-07-10 16:28:06 -07:00 committed by GitHub
parent 7ed996bd88
commit aa6c9be7ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 51 additions and 21 deletions

View File

@ -16,7 +16,7 @@ summary {
</style>
<!-- TODO: add UI screenshots for final pipeline -->
This tutorial helps you get started with a KFP deployment and a pipeline created with the KFP SDK.
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:
@ -24,22 +24,17 @@ Before you begin, you need the following prerequisites:
* **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.
* Run the following script to install the KFP SDK:
```shell
pip install kfp
```
After you complete the prerequisites, click each step to view the instructions:
After you complete the prerequisites, click each section to view the instructions:
<details>
<summary><a name="kfp_qs_step1"></a><h2 style="display:inline;">Step 1: Deploy a KFP standalone instance into your cluster</h2></summary>
<summary><a name="kfp_qs_deployment"></a><h2 style="display:inline;">Deploy a KFP standalone instance into your cluster</h2></summary>
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="2.0.0-alpha.4"
export PIPELINE_VERSION="2.0.0"
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
@ -51,9 +46,49 @@ After you deploy Kubernetes, obtain your KFP endpoint by following [these instru
</details>
<details>
<summary><a name="kfp_qs_step2"></a><h2 style="display:inline;">Step 2: Create and run a simple pipeline using the KFP SDK</h2></summary>
<summary><a name="kfp_qs_basic_pipeline"></a><h2 style="display:inline;">Run a basic pipeline
using KFP Dashboard and SDK</h2></summary>
This step shows how to use the KFP SDK to compose a pipeline and submit it for execution by KFP.
### **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:
<img src="/docs/images/v2/click-pipeline-example.png"
alt="Pipelines UI"
class="mt-3 mb-3 border border-info rounded">
2. Click **Create run**:
<img src="/docs/images/v2/pipelines-start-run.png"
alt="Creating a run on the pipelines UI"
class="mt-3 mb-3 border border-info rounded">
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_:
<img src="/docs/images/v2/pipelines-start-run-details.png"
alt="Details page of creating a run on the pipelines UI"
class="mt-3 mb-3 border border-info rounded">
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:
<img src="/docs/images/v2/pipelines-basic-run.png"
alt="Run results on the pipelines UI"
class="mt-3 mb-3 border border-info rounded">
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.
@ -121,7 +156,7 @@ The above code consists of the following parts:
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 [step 1](#kfp_qs_step1) and submit the pipeline to the KFP backend with the required pipeline 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_ENDPOINT>'
@ -137,7 +172,7 @@ The above code consists of the following parts:
print(url)
```
In this example, replace `endpoint` with the KFP endpoint URL you obtained in [step 1](#kfp_qs_step1).
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:
@ -146,13 +181,7 @@ The above code consists of the following parts:
compiler.Compiler().compile(pipeline_func=my_pipeline, package_path='pipeline.yaml')
```
</details>
<details>
<summary><a name="kfp_qs_step3"></a><h2 style="display:inline;">Step 3: View the pipeline in the KFP Dashboard</h2></summary>
This step demonstrates how to view the pipeline run on the KFP Dashboard. To do this, go to the URL printed from [step 2](#kfp_qs_step_2).
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.
<!-- TODO: add logs to this list when available in v2 -->
@ -161,10 +190,11 @@ To view the details of each task, including input and output, click the appropri
alt="Pipelines Dashboard"
class="mt-3 mb-3 border border-info rounded">
</details>
<details>
<summary><a name="kfp_qs_step4"></a><h2 style="display:inline;">Step 4: Build a more advanced ML pipeline</h2></summary>
<summary><a name="kfp_qs_advanced_ml"></a><h2 style="display:inline;">Build a more advanced ML pipeline</h2></summary>
This step demonstrates how to build a more advanced machine learning (ML) pipeline that leverages additional KFP pipeline composition features.

Binary file not shown.

After

Width:  |  Height:  |  Size: 245 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 340 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 327 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB