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 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.
22
+
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.
23
23
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).
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).
25
25
26
26
In this article, you learn how to do the following:
27
27
28
28
> [!div class="checklist"]
29
-
> * Create pipeline parameters.
30
-
> * Delete and manage pipeline parameters.
31
-
> * Supply pipeline paramenters when you trigger pipeline jobs.
29
+
> * Create pipeline inputs.
30
+
> * Delete and manage pipeline inputs.
31
+
> * Supply pipeline inputs when you trigger pipeline jobs.
32
32
33
33
## Prerequisites
34
34
@@ -43,149 +43,149 @@ In this article, you learn how to do the following:
43
43
44
44
## Create a pipeline parameter
45
45
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.
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.
50
50
51
51
> [!NOTE]
52
-
> Pipeline parameters support only basic data types, like `int`, `float`, and `string`.
52
+
> Pipeline inputs support only basic data types, like `int`, `float`, and `string`.
53
53
54
-
### Option 1: Create a pipeline parameter in the settings panel
54
+
### Option 1: Create a pipeline input in the settings panel
55
55
56
-
In this section, you create a pipeline parameter in the settings panel.
56
+
In this section, you create a pipeline input in the settings panel.
57
57
58
-
In this example, you create a pipeline parameter that defines how a pipeline fills in missing data with the **Clean missing data** component.
58
+
In this example, you create a pipeline input that defines how a pipeline fills in missing data with the **Clean missing data** component.
59
59
60
60
1. In your pipeline draft, select **Piepleline interface**.
61
61
62
62
1. In the **Pipeline interface** section, select the **+** button and then select an input type, for example, `Double`.
63
63
64
-
1. Enter a name for the parameter and a default value.
64
+
1. Enter a name for the input and a default value.
65
65
66
-
For example, enter `minimum-missing-value-ratio-2` as parameter name and `0.1` as the default value.
66
+
For example, enter `minimum-missing-value-ratio-2` as input name and `0.1` as the default value.
67
67
68
-
:::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":::
68
+
:::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":::
69
69
70
70
1. Select **Save**.
71
71
72
-
After you create a pipeline parameter, you must [attach it to the component parameter](#attach-a-component-parameter-to-a-pipeline-parameter) that you want to dynamically set.
72
+
After you create a pipeline input, you must [attach it to the component input](#attach-a-component-parameter-to-a-pipeline-parameter) that you want to dynamically set.
73
73
74
-
### Option 2: Promote a component parameter
74
+
### Option 2: Promote a component input
75
75
76
-
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:
76
+
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:
77
77
78
-
1. Double-click the component you want to attach a pipeline parameter to.
79
-
1. Select the ellipsis button (**...**) next to the parameter that you want to specify.
78
+
1. Double-click the component you want to attach a pipeline input to.
79
+
1. Select the ellipsis button (**...**) next to the input that you want to specify.
80
80
1. Select **Add to pipeline input**.
81
81
82
-
:::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":::
82
+
:::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":::
83
83
84
-
1. Enter a parameter name and a default value.
84
+
1. Enter a input name and a default value.
85
85
1. Select **Save**.
86
86
87
-
You can now specify new values for this parameter anytime you submit the pipeline.
87
+
You can now specify new values for this input anytime you submit the pipeline.
88
88
89
-
### Option 3: Promote a dataset to a pipeline parameter
89
+
### Option 3: Promote a dataset to a pipeline input
90
90
91
-
If you want to submit your pipeline with variable datasets, you need to promote your dataset to a pipeline parameter:
91
+
If you want to submit your pipeline with variable datasets, you need to promote your dataset to a pipeline input:
92
92
93
-
1. Select the dataset you want to turn into a pipeline parameter.
93
+
1. Select the dataset you want to turn into a pipeline input.
94
94
95
95
1. In the details pane of the dataset, select **Set as pipeline input**.
96
96
97
-
:::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":::
97
+
:::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":::
98
98
99
99
1. Select **Save**.
100
100
101
-
You can now specify a different dataset by using the pipeline parameter the next time you run the pipeline.
101
+
You can now specify a different dataset by using the pipeline input the next time you run the pipeline.
102
102
103
-
## Attach a component parameter to or detach a component pipeline from a pipeline parameter
103
+
## Attach a component input to or detach a component pipeline from a pipeline input
104
104
105
-
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.
105
+
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.
106
106
107
-
### Attach a component parameter to a pipeline parameter
107
+
### Attach a component input to a pipeline input
108
108
109
-
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.
109
+
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.
110
110
111
-
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**:
111
+
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**:
112
112
113
113
1. Double-click the **Clean Missing Data** component.
114
114
115
115
1. Select the ellipsis button (**...**) above the **Minimum missing value reatio** box.
116
116
117
-
1. Select the pipeline parameter`minimum-missing-value-ratio-2`.
117
+
1. Select the pipeline input`minimum-missing-value-ratio-2`.
118
118
119
-
:::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":::
119
+
:::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":::
120
120
121
121
1. Select **Save**.
122
122
123
-
You have successfully attached the **Minimum missing value ratio** field to your pipeline parameter.
123
+
You have successfully attached the **Minimum missing value ratio** field to your pipeline input.
124
124
125
-
### Detach a component parameter from a pipeline parameter
125
+
### Detach a component input from a pipeline input
126
126
127
-
When you detach a component parameter from a pipeline parameter, it's not actionable.
127
+
When you detach a component input from a pipeline input, it's not actionable.
128
128
129
-
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**.
129
+
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**.
130
130
131
-
:::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":::
131
+
:::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":::
132
132
133
-
## Update and delete pipeline parameters
133
+
## Update and delete pipeline inputs
134
134
135
-
In this section, you learn how to update and delete pipeline parameters.
135
+
In this section, you learn how to update and delete pipeline inputs.
136
136
137
-
### Update pipeline parameters
137
+
### Update pipeline inputs
138
138
139
-
Complete the following steps to update a component pipeline parameter:
139
+
Complete the following steps to update a component pipeline input:
140
140
141
141
1. To the right of the canvas, select **Pipeline interface**.
142
-
1. You can view and update the names and default values for all of your pipeline parameters.
142
+
1. You can view and update the names and default values for all of your pipeline inputs.
143
143
144
-
### Delete a dataset pipeline parameter
144
+
### Delete a dataset pipeline input
145
145
146
-
Complete the following steps to delete a dataset pipeline parameter:
146
+
Complete the following steps to delete a dataset pipeline input:
147
147
148
148
1. Double-click the dataset component.
149
149
1. Clear the **Set as pipeline input** checkbox.
150
150
1. Select **Save**.
151
151
152
-
### Delete component pipeline parameters
152
+
### Delete component pipeline inputs
153
153
154
-
Complete the following steps to delete a component pipeline parameter:
154
+
Complete the following steps to delete a component pipeline input:
155
155
156
156
1. To the right of the canvas, select **Pipeline interface**.
157
157
158
-
1. Select the recycle bin icon next to the pipeline parameter.
158
+
1. Select the recycle bin icon next to the pipeline input.
159
159
160
-
:::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":::
160
+
:::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":::
161
161
162
162
1. Confirm the deletion in the resulting pop-up window.
163
163
164
164
> [!NOTE]
165
-
> Deleting a pipeline parameter causes all attached component parameters to be detached. The values of detached component parameters will keep current pipeline parameter values.
165
+
> Deleting a pipeline input causes all attached component inputs to be detached. The values of detached component inputs will keep current pipeline input values.
166
166
167
-
## Supply pipeline parameters when you trigger a pipeline job
167
+
## Supply pipeline inputs when you trigger a pipeline job
168
168
169
169
In this section, you learn how to supply pipeline paramaters when you submit a pipeline job.
170
170
171
171
### Resubmit a pipeline job
172
172
173
-
After you submit a pipeline with pipeline parameters, you can resubmit the job with different parameters:
173
+
After you submit a pipeline with pipeline inputs, you can resubmit the job with different inputs:
174
174
175
-
1. Go to pipeline detail page. In the **Pipeline run overview** pane, you can check current pipeline parameters and values.
175
+
1. Go to pipeline detail page. In the **Pipeline run overview** pane, you can check current pipeline inputs and values.
176
176
1. Select **Resubmit**.
177
-
1. In the **Set up pipleine job** window, specify your new pipeline parameters.
177
+
1. In the **Set up pipleine job** window, specify your new pipeline inputs.
178
178
179
-
:::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":::
179
+
:::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":::
180
180
181
181
### Use published pipelines
182
182
183
-
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.
183
+
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.
184
184
185
185
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).
186
186
187
187
## Next steps
188
188
189
-
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).
189
+
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).
190
190
191
191
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