You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This article describes how to use pipeline inputs to build flexible pipelines in the Azure Machine Learning designer. Pipeline inputs enable you to dynamically set values at runtime so you can encapsulate pipeline logic and reuse assets.
22
+
This article describes how to use pipeline parameters to build flexible pipelines in the Azure Machine Learning designer. Pipeline parameters enable you to dynamically set values at runtime so you can encapsulate pipeline logic and reuse assets.
23
23
24
-
Pipeline inputs are especially useful when you resubmit a pipeline job, [retrain models](how-to-retrain-designer.md), or [perform batch predictions](how-to-run-batch-predictions-designer.md).
24
+
Pipeline parameters are especially useful when you resubmit a pipeline job, [retrain models](how-to-retrain-designer.md), or [perform batch predictions](how-to-run-batch-predictions-designer.md).
25
25
26
26
In this article, you learn how to do the following:
27
27
28
28
> [!div class="checklist"]
29
-
> * Create pipeline inputs.
30
-
> * Delete and manage pipeline inputs.
31
-
> * Supply pipeline inputs when you trigger pipeline jobs.
29
+
> * Create pipeline parameters.
30
+
> * Delete and manage pipeline parameters.
31
+
> * Supply pipeline parameters when you trigger pipeline jobs.
32
32
33
33
## Prerequisites
34
34
@@ -41,149 +41,149 @@ In this article, you learn how to do the following:
41
41
> [!IMPORTANT]
42
42
> If you don't see the UI elements mentioned in this article, such as buttons in studio or designer, you might not have the right level of permissions for the workspace. Contact your Azure subscription administrator to verify that you're granted the correct level of access. For more information, see [Manage users and roles](../how-to-assign-roles.md).
43
43
44
-
## Create a pipeline input
44
+
## Create a pipeline parameter
45
45
46
-
There are three ways to create a pipeline input in the designer:
47
-
- Create a pipeline input in the settings panel and bind it to a component.
48
-
- Promote a component input to a pipeline input.
49
-
- Promote a dataset to a pipeline input.
46
+
There are three ways to create a pipeline parameter in the designer:
47
+
- Create a pipeline parameter in the settings panel and bind it to a component.
48
+
- Promote a component parameter to a pipeline parameter.
49
+
- Promote a dataset to a pipeline parameter.
50
50
51
51
> [!NOTE]
52
-
> Pipeline inputs support only basic data types, like `int`, `float`, and `string`.
52
+
> Pipeline parameters support only basic data types, like `int`, `float`, and `string`.
53
53
54
-
### Option 1: Create a pipeline input in the settings panel
54
+
### Option 1: Create a pipeline parameter in the settings panel
55
55
56
-
In this section, you create a pipeline input in the settings panel.
56
+
In this section, you create a pipeline parameter in the settings panel.
57
57
58
58
1. In your pipeline draft, select **Pipeline interface**.
59
59
60
-
1. In the **Pipeline interface** section, select the **+** button and then select an input type, for example, `Double`.
60
+
1. In the **Pipeline interface** section, select the **+** button and then select an parameter type, for example, `Double`.
61
61
62
-
1. Enter a name for the input and a default value.
62
+
1. Enter a name for the parameter and a default value.
63
63
64
-
For example, enter `minimum-missing-value-ratio-2` as input name and `0.1` as the default value.
64
+
For example, enter `minimum-missing-value-ratio-2` as parameter name and `0.1` as the default value.
65
65
66
-
:::image type="content" source="media/how-to-use-pipeline-parameter/create-pipeline-parameter.png" alt-text="Screenshot that shows how to create a pipeline input." lightbox ="media/how-to-use-pipeline-parameter/create-pipeline-parameter.png":::
66
+
:::image type="content" source="media/how-to-use-pipeline-parameter/create-pipeline-parameter.png" alt-text="Screenshot that shows how to create a pipeline parameter." lightbox ="media/how-to-use-pipeline-parameter/create-pipeline-parameter.png":::
67
67
68
68
1. Select **Save**.
69
69
70
-
After you create a pipeline input, you must [attach it to the component input](#attach-a-component-input-to-a-pipeline-input) that you want to dynamically set.
70
+
After you create a pipeline parameter, you must [attach it to the component parameter](#attach-a-component-input-to-a-pipeline-input) that you want to dynamically set.
71
71
72
-
### Option 2: Promote a component input
72
+
### Option 2: Promote a component parameter
73
73
74
-
The easiest way to create a pipeline input for a component value is to promote a component input. Use the following steps to promote a component input to a pipeline input:
74
+
The easiest way to create a pipeline parameter for a component value is to promote a component parameter. Use the following steps to promote a component parameter to a pipeline parameter:
75
75
76
-
1. Double-click the component you want to attach a pipeline input to.
77
-
1. Select the ellipsis button (**...**) next to the input that you want to specify.
76
+
1. Double-click the component you want to attach a pipeline parameter to.
77
+
1. Select the ellipsis button (**...**) next to the parameter that you want to specify.
78
78
1. Select **Add to pipeline input**.
79
79
80
-
:::image type="content" source="media/how-to-use-pipeline-parameter/promote-module-para-to-pipeline-para.png" alt-text="Screenshot that shows how to promote a component input to a pipeline input." lightbox ="media/how-to-use-pipeline-parameter/promote-module-para-to-pipeline-para.png":::
80
+
:::image type="content" source="media/how-to-use-pipeline-parameter/promote-module-para-to-pipeline-para.png" alt-text="Screenshot that shows how to promote a component parameter to a pipeline parameter." lightbox ="media/how-to-use-pipeline-parameter/promote-module-para-to-pipeline-para.png":::
81
81
82
-
1. Enter an input name and a default value.
82
+
1. Enter an parameter name and a default value.
83
83
1. Select **Save**.
84
84
85
-
You can now specify new values for this input anytime you submit the pipeline.
85
+
You can now specify new values for this parameter anytime you submit the pipeline.
86
86
87
-
### Option 3: Promote a dataset to a pipeline input
87
+
### Option 3: Promote a dataset to a pipeline parameter
88
88
89
-
If you want to submit your pipeline with variable datasets, you need to promote your dataset to a pipeline input:
89
+
If you want to submit your pipeline with variable datasets, you need to promote your dataset to a pipeline parameter:
90
90
91
-
1. Select the dataset you want to turn into a pipeline input.
91
+
1. Select the dataset you want to turn into a pipeline parameter.
92
92
93
93
1. In the details pane of the dataset, select **Set as pipeline input**.
94
94
95
-
:::image type="content" source="media/how-to-use-pipeline-parameter/set-dataset-as-pipeline-parameter.png" alt-text="Screenshot that shows how to set dataset as pipeline input." lightbox ="media/how-to-use-pipeline-parameter/set-dataset-as-pipeline-parameter.png":::
95
+
:::image type="content" source="media/how-to-use-pipeline-parameter/set-dataset-as-pipeline-parameter.png" alt-text="Screenshot that shows how to set dataset as pipeline parameter." lightbox ="media/how-to-use-pipeline-parameter/set-dataset-as-pipeline-parameter.png":::
96
96
97
97
1. Select **Save**.
98
98
99
-
You can now specify a different dataset by using the pipeline input the next time you run the pipeline.
99
+
You can now specify a different dataset by using the pipeline parameter the next time you run the pipeline.
100
100
101
-
## Attach a component input to or detach a component input from a pipeline input
101
+
## Attach a component parameter to or detach a component parameter from a pipeline parameter
102
102
103
-
In this section, you learn how to attach a component input to a pipeline input and how to detach a component input from a pipeline input.
103
+
In this section, you learn how to attach a component parameter to a pipeline parameter and how to detach a component parameter from a pipeline parameter.
104
104
105
-
### Attach a component input to a pipeline input
105
+
### Attach a component parameter to a pipeline parameter
106
106
107
-
You can attach the component inputs of duplicated components to the same pipeline input if you want to alter the value one time when you trigger the pipeline job.
107
+
You can attach the component parameters of duplicated components to the same pipeline parameter if you want to alter the value one time when you trigger the pipeline job.
108
108
109
-
In the following example, the **Clean Missing Data** component is duplicated. For each **Clean Missing Data** component, attach a **Minimum missing value ratio** to the pipeline input**minimum-missing-value-ratio-2**:
109
+
In the following example, the **Clean Missing Data** component is duplicated. For each **Clean Missing Data** component, attach a **Minimum missing value ratio** to the pipeline parameter**minimum-missing-value-ratio-2**:
110
110
111
111
1. Double-click the **Clean Missing Data** component.
112
112
113
113
1. Select the ellipsis button (**...**) above the **Minimum missing value ratio** box.
114
114
115
-
1. Select the pipeline input`minimum-missing-value-ratio-2`.
115
+
1. Select the pipeline parameter`minimum-missing-value-ratio-2`.
116
116
117
-
:::image type="content" source="media/how-to-use-pipeline-parameter/attach-replace-value-to-pipeline-parameter.png" alt-text="Screenshot that shows how to attach a pipeline input." lightbox ="media/how-to-use-pipeline-parameter/attach-replace-value-to-pipeline-parameter.png":::
117
+
:::image type="content" source="media/how-to-use-pipeline-parameter/attach-replace-value-to-pipeline-parameter.png" alt-text="Screenshot that shows how to attach a pipeline parameter." lightbox ="media/how-to-use-pipeline-parameter/attach-replace-value-to-pipeline-parameter.png":::
118
118
119
119
1. Select **Save**.
120
120
121
-
You have successfully attached the **Minimum missing value ratio** field to your pipeline input.
121
+
You have successfully attached the **Minimum missing value ratio** field to your pipeline parameter.
122
122
123
-
### Detach a component input from a pipeline input
123
+
### Detach a component parameter from a pipeline parameter
124
124
125
-
When you detach a component input from a pipeline input, it's not actionable.
125
+
When you detach a component parameter from a pipeline parameter, it's not actionable.
126
126
127
-
You can detach a component input from a pipeline input by selecting the ellipsis button (**...**) next to the component input and then selecting **Detach from pipeline input**.
127
+
You can detach a component parameter from a pipeline parameter by selecting the ellipsis button (**...**) next to the component parameter and then selecting **Detach from pipeline input**.
128
128
129
-
:::image type="content" source="media/how-to-use-pipeline-parameter/non-actionable-module-parameter.png" alt-text="Screenshot that shows how to detach a component input." lightbox ="media/how-to-use-pipeline-parameter/non-actionable-module-parameter.png":::
129
+
:::image type="content" source="media/how-to-use-pipeline-parameter/non-actionable-module-parameter.png" alt-text="Screenshot that shows how to detach a component parameter." lightbox ="media/how-to-use-pipeline-parameter/non-actionable-module-parameter.png":::
130
130
131
-
## Update and delete pipeline inputs
131
+
## Update and delete pipeline parameters
132
132
133
-
In this section, you learn how to update and delete pipeline inputs.
133
+
In this section, you learn how to update and delete pipeline parameters.
134
134
135
-
### Update pipeline inputs
135
+
### Update pipeline parameters
136
136
137
-
Complete the following steps to update a component pipeline input:
137
+
Complete the following steps to update a component pipeline parameter:
138
138
139
139
1. To the right of the canvas, select **Pipeline interface**.
140
-
1. You can view and update the names and default values for all of your pipeline inputs.
140
+
1. You can view and update the names and default values for all of your pipeline parameters.
141
141
142
-
### Delete a dataset pipeline input
142
+
### Delete a dataset pipeline parameter
143
143
144
-
Complete the following steps to delete a dataset pipeline input:
144
+
Complete the following steps to delete a dataset pipeline parameter:
145
145
146
146
1. Double-click the dataset component.
147
147
1. Clear the **Set as pipeline input** checkbox.
148
148
1. Select **Save**.
149
149
150
-
### Delete component pipeline inputs
150
+
### Delete component pipeline parameters
151
151
152
-
Complete the following steps to delete a component pipeline input:
152
+
Complete the following steps to delete a component pipeline parameter:
153
153
154
154
1. To the right of the canvas, select **Pipeline interface**.
155
155
156
-
1. Select the recycle bin icon next to the pipeline input.
156
+
1. Select the recycle bin icon next to the pipeline parameter.
157
157
158
-
:::image type="content" source="media/how-to-use-pipeline-parameter/delete-pipeline-parameter2.png" alt-text="Screenshot that shows the current pipeline input applied to a component." lightbox ="media/how-to-use-pipeline-parameter/delete-pipeline-parameter2.png":::
158
+
:::image type="content" source="media/how-to-use-pipeline-parameter/delete-pipeline-parameter2.png" alt-text="Screenshot that shows the current pipeline parameter applied to a component." lightbox ="media/how-to-use-pipeline-parameter/delete-pipeline-parameter2.png":::
159
159
160
160
1. Confirm the deletion in the resulting pop-up window.
161
161
162
162
> [!NOTE]
163
-
> Deleting a pipeline input causes all attached component inputs to be detached. The values of detached component inputs will keep current pipeline input values.
163
+
> Deleting a pipeline parameter causes all attached component parameters to be detached. The values of detached component parameters will keep current pipeline parameter values.
164
164
165
-
## Supply pipeline inputs when you trigger a pipeline job
165
+
## Supply pipeline parameters when you trigger a pipeline job
166
166
167
-
In this section, you learn how to supply pipeline inputs when you submit a pipeline job.
167
+
In this section, you learn how to supply pipeline parameters when you submit a pipeline job.
168
168
169
169
### Resubmit a pipeline job
170
170
171
-
After you submit a pipeline with pipeline inputs, you can resubmit the job with different inputs:
171
+
After you submit a pipeline with pipeline parameters, you can resubmit the job with different parameters:
172
172
173
-
1. Go to pipeline detail page. In the **Pipeline run overview** pane, you can check current pipeline inputs and values.
173
+
1. Go to pipeline detail page. In the **Pipeline run overview** pane, you can check current pipeline parameters and values.
174
174
1. Select **Resubmit**.
175
-
1. In the **Set up pipeline job** window, specify your new pipeline inputs.
175
+
1. In the **Set up pipeline job** window, specify your new pipeline parameters.
176
176
177
-
:::image type="content" source="media/how-to-use-pipeline-parameter/resubmit-pipeline-run.png" alt-text="Screenshot that shows how to resubmit a pipeline with pipeline inputs." lightbox ="media/how-to-use-pipeline-parameter/resubmit-pipeline-run.png":::
177
+
:::image type="content" source="media/how-to-use-pipeline-parameter/resubmit-pipeline-run.png" alt-text="Screenshot that shows how to resubmit a pipeline with pipeline parameters." lightbox ="media/how-to-use-pipeline-parameter/resubmit-pipeline-run.png":::
178
178
179
179
### Use published pipelines
180
180
181
-
You can also publish a pipeline to use its pipeline inputs. A *published pipeline* is a pipeline that has been deployed to a compute resource. Client applications can invoke the pipeline via a REST endpoint.
181
+
You can also publish a pipeline to use its pipeline parameters. A *published pipeline* is a pipeline that has been deployed to a compute resource. Client applications can invoke the pipeline via a REST endpoint.
182
182
183
183
Published endpoints are especially useful for retraining and batch prediction scenarios. For more information, see [How to retrain models in the designer](how-to-retrain-designer.md) or [Run batch predictions in the designer](how-to-run-batch-predictions-designer.md).
184
184
185
185
## Next steps
186
186
187
-
In this article, you learned how to create pipeline inputs in the designer. Next, see how you can use pipeline inputs to [retrain models](how-to-retrain-designer.md) or perform [batch predictions](how-to-run-batch-predictions-designer.md).
187
+
In this article, you learned how to create pipeline parameters in the designer. Next, see how you can use pipeline parameters to [retrain models](how-to-retrain-designer.md) or perform [batch predictions](how-to-run-batch-predictions-designer.md).
188
188
189
189
You can also learn how to [use pipelines programmatically with the SDK v1](how-to-deploy-pipelines.md?view=azureml-api-1&preserve-view=true).
0 commit comments