Skip to content

Commit 6995a78

Browse files
authored
Merge pull request #264905 from lgayhardt/amlcomponentpipelineui0124
Freshness update to how to create component pipelines UI
2 parents 1adec22 + 3eef54a commit 6995a78

File tree

8 files changed

+22
-28
lines changed

8 files changed

+22
-28
lines changed

articles/machine-learning/how-to-create-component-pipelines-ui.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.subservice: core
88
ms.author: keli19
99
author: likebupt
1010
ms.reviewer: lagayhar
11-
ms.date: 03/27/2022
11+
ms.date: 01/31/2024
1212
ms.topic: how-to
1313
ms.custom: devplatv2, designer, event-tier1-build-2022, ignite-2022
1414
---
@@ -17,58 +17,59 @@ ms.custom: devplatv2, designer, event-tier1-build-2022, ignite-2022
1717

1818
[!INCLUDE [cli v2](includes/machine-learning-cli-v2.md)]
1919

20-
In this article, you'll learn how to create and run [machine learning pipelines](concept-ml-pipelines.md) by using the Azure Machine Learning studio and [Components](concept-component.md). You can create pipelines without using components, but components offer better amount of flexibility and reuse. Azure Machine Learning Pipelines may be defined in YAML and [run from the CLI](how-to-create-component-pipelines-cli.md), [authored in Python](how-to-create-component-pipeline-python.md), or composed in Azure Machine Learning studio Designer with a drag-and-drop UI. This document focuses on the Azure Machine Learning studio designer UI.
20+
In this article, you'll learn how to create and run [machine learning pipelines](concept-ml-pipelines.md) by using the Azure Machine Learning studio and [Components](concept-component.md). You can create pipelines without using components, but components offer better amount of flexibility and reuse. Azure Machine Learning Pipelines can be defined in YAML and [run from the CLI](how-to-create-component-pipelines-cli.md), [authored in Python](how-to-create-component-pipeline-python.md), or composed in Azure Machine Learning studio Designer with a drag-and-drop UI. This document focuses on the Azure Machine Learning studio designer UI.
2121

2222
## Prerequisites
2323

24-
* If you don't have an Azure subscription, create a free account before you begin. Try the [free or paid version of Azure Machine Learning](https://azure.microsoft.com/free/).
24+
- If you don't have an Azure subscription, create a free account before you begin. Try the [free or paid version of Azure Machine Learning](https://azure.microsoft.com/free/).
2525

26-
* An Azure Machine Learning workspace[Create workspace resources](quickstart-create-resources.md).
26+
- An Azure Machine Learning workspace [Create workspace resources](quickstart-create-resources.md).
2727

28-
* [Install and set up the Azure CLI extension for Machine Learning](how-to-configure-cli.md).
28+
- [Install and set up the Azure CLI extension for Machine Learning](how-to-configure-cli.md).
2929

30-
* Clone the examples repository:
30+
- Clone the examples repository:
3131

3232
```azurecli-interactive
3333
git clone https://github.com/Azure/azureml-examples --depth 1
3434
cd azureml-examples/cli/jobs/pipelines-with-components/
3535
```
3636
3737
>[!Note]
38-
> Designer supports two types of components, classic prebuilt components(v1) and custom components(v2). These two types of components are NOT compatible.
38+
> Designer supports two types of components, classic prebuilt components(v1) and custom components(v2). These two types of components are NOT compatible.
3939
>
4040
>Classic prebuilt components provide prebuilt components majorly for data processing and traditional machine learning tasks like regression and classification. This type of component continues to be supported but will not have any new components added.
4141
>
42-
>Custom components allow you to wrap your own code as a component. It supports sharing components across workspaces and seamless authoring across Studio, CLI v2, and SDK v2 interfaces.
42+
>Custom components allow you to wrap your own code as a component. It supports sharing components across workspaces and seamless authoring across studio, CLI v2, and SDK v2 interfaces.
4343
>
44-
>For new projects, we highly suggest you use custom component, which is compatible with AzureML V2 and will keep receiving new updates.
44+
>For new projects, we highly suggest you use custom component, which is compatible with AzureML V2 and will keep receiving new updates.
4545
>
4646
>This article applies to custom components.
4747
4848
## Register component in your workspace
4949
5050
To build pipeline using components in UI, you need to register components to your workspace first. You can use UI, CLI or SDK to register components to your workspace, so that you can share and reuse the component within the workspace. Registered components support automatic versioning so you can update the component but assure that pipelines that require an older version continues to work.
5151
52-
The example below uses UI to register components, and the [component source files](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components) are in the `cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components` directory of the [`azureml-examples` repository](https://github.com/Azure/azureml-examples). You need to clone the repo to local first.
52+
The following example uses UI to register components, and the [component source files](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components) are in the `cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components` directory of the [`azureml-examples` repository](https://github.com/Azure/azureml-examples). You need to clone the repo to local first.
5353
54-
1. In your Azure Machine Learning workspace, navigate to **Components** page and select **New Component**.
54+
1. In your Azure Machine Learning workspace, navigate to **Components** page and select **New Component** (one of the two style pages will appear).
5555
56-
:::image type="content" source="./media/how-to-create-component-pipelines-ui/register-component-entry-button.png" alt-text="Screenshot showing register entry button in component page." lightbox ="./media/how-to-create-component-pipelines-ui/register-component-entry-button.png":::
56+
:::image type="content" source="./media/how-to-create-component-pipelines-ui/register-component-entry-button-2.png" alt-text="Screenshot showing register entry button in component page." lightbox ="./media/how-to-create-component-pipelines-ui/register-component-entry-button-2.png":::
57+
58+
:::image type="content" source="./media/how-to-create-component-pipelines-ui/register-component-entry-button.png" alt-text="Screenshot showing register entry button in component page with can include archive." lightbox ="./media/how-to-create-component-pipelines-ui/register-component-entry-button.png":::
5759
5860
This example uses `train.yml` [in the directory](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components). The YAML file defines the name, type, interface including inputs and outputs, code, environment and command of this component. The code of this component `train.py` is under `./train_src` folder, which describes the execution logic of this component. To learn more about the component schema, see the [command component YAML schema reference](reference-yaml-component-command.md).
5961
6062
>[!Note]
6163
> When register components in UI, `code` defined in the component YAML file can only point to the current folder where YAML file locates or the subfolders, which means you cannot specify `../` for `code` as UI cannot recognize the parent directory.
6264
> `additional_includes` can only point to the current or sub folder.
6365
64-
65-
2. Select Upload from **Folder**, and select the `1b_e2e_registered_components` folder to upload. Select `train.yml` from the drop down list below.
66+
2. Select Upload from **Folder**, and select the `1b_e2e_registered_components` folder to upload. Select `train.yml` from the drop-down list.
6667
6768
:::image type="content" source="./media/how-to-create-component-pipelines-ui/upload-from-local-folder.png" alt-text="Screenshot showing upload from local folder." lightbox ="./media/how-to-create-component-pipelines-ui/upload-from-local-folder.png":::
6869
6970
3. Select **Next** in the bottom, and you can confirm the details of this component. Once you've confirmed, select **Create** to finish the registration process.
7071
71-
4. Repeat the steps above to register Score and Eval component using `score.yml` and `eval.yml` as well.
72+
4. Repeat the previous steps to register Score and Eval component using `score.yml` and `eval.yml` as well.
7273
7374
5. After registering the three components successfully, you can see your components in the studio UI.
7475
@@ -80,7 +81,7 @@ This example uses `train.yml` [in the directory](https://github.com/Azure/azurem
8081
8182
:::image type="content" source="./media/how-to-create-component-pipelines-ui/new-pipeline.png" alt-text="Screenshot showing creating new pipeline in designer homepage." lightbox ="./media/how-to-create-component-pipelines-ui/new-pipeline.png":::
8283
83-
2. Give the pipeline a meaningful name by selecting the pencil icon besides the autogenerated name.
84+
2. Give the pipeline a meaningful name by selecting the pencil icon besides the autogenerated name.
8485
8586
:::image type="content" source="./media/how-to-create-component-pipelines-ui/rename-pipeline.png" alt-text="Screenshot showing rename the pipeline." lightbox ="./media/how-to-create-component-pipelines-ui/rename-pipeline.png":::
8687
@@ -89,19 +90,17 @@ This example uses `train.yml` [in the directory](https://github.com/Azure/azurem
8990
:::image type="content" source="./media/how-to-create-component-pipelines-ui/asset-library.png" alt-text="Screenshot showing registered component in asset library." lightbox ="./media/how-to-create-component-pipelines-ui/asset-library.png":::
9091
9192
Find the *train*, *score* and *eval* components registered in previous section then drag-and-drop them on the canvas. By default it uses the default version of the component, and you can change to a specific version in the right pane of component. The component right pane is invoked by double click on the component.
92-
93+
9394
:::image type="content" source="./media/how-to-create-component-pipelines-ui/change-component-version.png" alt-text="Screenshot showing changing version of component." lightbox ="./media/how-to-create-component-pipelines-ui/change-component-version.png":::
94-
95-
In this example, we'll use the sample data under [this path](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components/data). Register the data into your workspace by clicking the add icon in designer asset library -> data tab, set Type = Folder(uri_folder) then follow the wizard to register the data. The data type need to be uri_folder to align with the [train component definition](https://github.com/Azure/azureml-examples/blob/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components/train.yml).
95+
96+
In this example, we'll use the sample data under [this path](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components/data). Register the data into your workspace by selecting the add icon in designer asset library -> data tab, set Type = Folder(uri_folder) then follow the wizard to register the data. The data type need to be uri_folder to align with the [train component definition](https://github.com/Azure/azureml-examples/blob/main/cli/jobs/pipelines-with-components/basics/1b_e2e_registered_components/train.yml).
9697
9798
:::image type="content" source="./media/how-to-create-component-pipelines-ui/add-data.png" alt-text="Screenshot showing add data." lightbox ="./media/how-to-create-component-pipelines-ui/add-data.png":::
9899
99100
Then drag and drop the data into the canvas. Your pipeline look should look like the following screenshot now.
100-
101-
:::image type="content" source="./media/how-to-create-component-pipelines-ui/pipeline-with-all-boxes.png" alt-text="Screenshot showing the pipeline draft." lightbox ="./media/how-to-create-component-pipelines-ui/pipeline-with-all-boxes.png":::
102101
102+
:::image type="content" source="./media/how-to-create-component-pipelines-ui/pipeline-with-all-boxes.png" alt-text="Screenshot showing the pipeline draft." lightbox ="./media/how-to-create-component-pipelines-ui/pipeline-with-all-boxes.png":::
103103
104-
105104
4. Connect the data and components by dragging connections in the canvas.
106105
107106
:::image type="content" source="./media/how-to-create-component-pipelines-ui/connect.gif" alt-text="Gif showing connecting the pipeline." lightbox ="./media/how-to-create-component-pipelines-ui/connect.gif":::
@@ -119,8 +118,6 @@ This example uses `train.yml` [in the directory](https://github.com/Azure/azurem
119118
120119
:::image type="content" source="./media/how-to-create-component-pipelines-ui/promote-pipeline-input.png" alt-text="Screenshot showing how to promote component input to pipeline input." lightbox ="./media/how-to-create-component-pipelines-ui/promote-pipeline-input.png":::
121120
122-
123-
124121
> [!NOTE]
125122
> Custom components and the designer classic prebuilt components cannot be used together.
126123
@@ -130,7 +127,6 @@ This example uses `train.yml` [in the directory](https://github.com/Azure/azurem
130127
131128
:::image type="content" source="./media/how-to-create-component-pipelines-ui/configure-submit.png" alt-text="Screenshot showing configure and submit button." border="false":::
132129
133-
134130
1. Then you'll see a step-by-step wizard, follow the wizard to submit the pipeline job.
135131
136132
:::image type="content" source="./media/how-to-create-component-pipelines-ui/submission-wizard.png" alt-text="Screenshot showing submission wizard." lightbox ="./media/how-to-create-component-pipelines-ui/submission-wizard.png":::
@@ -143,12 +139,10 @@ In **Runtime settings**, you can configure the default datastore and default com
143139
144140
The **Review + Submit** step is the last step to review all configurations before submit. The wizard remembers your last time's configuration if you ever submit the pipeline.
145141
146-
After submitting the pipeline job, there will be a message on the top with a link to the job detail. You can click this link to review the job details.
142+
After submitting the pipeline job, there will be a message on the top with a link to the job detail. You can select this link to review the job details.
147143
148144
:::image type="content" source="./media/how-to-create-component-pipelines-ui/submit-message.png" alt-text="Screenshot showing submission message." lightbox ="./media/how-to-create-component-pipelines-ui/submit-message.png":::
149145
150-
151-
152146
## Next steps
153147
154148
- Use [these Jupyter notebooks on GitHub](https://github.com/Azure/azureml-examples/tree/main/cli/jobs/pipelines-with-components) to explore machine learning pipelines further
102 KB
Loading
299 KB
Loading
95.8 KB
Loading
52.2 KB
Loading

0 commit comments

Comments
 (0)