Skip to content

Commit 6d52a4b

Browse files
committed
add web service module doc
1 parent 1bc92cf commit 6d52a4b

File tree

4 files changed

+48
-3
lines changed

4 files changed

+48
-3
lines changed
94.8 KB
Loading

articles/machine-learning/algorithm-module-reference/module-reference.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ ms.service: machine-learning
77
ms.subservice: core
88
ms.topic: reference
99

10-
author: peterclu
11-
ms.author: peterlu
12-
ms.date: 02/22/2020
10+
author: likebupt
11+
ms.author: keli19
12+
ms.date: 04/13/2020
1313
---
1414
# Algorithm & module reference for Azure Machine Learning designer (preview)
1515

@@ -55,6 +55,10 @@ For help with choosing algorithms, see
5555
| Anomaly Detection | Build anomaly detection models. | [PCA-Based Anomaly Detection](pca-based-anomaly-detection.md) <br/> [Train Anomaly Detection Model](train-anomaly-detection-model.md) |
5656

5757

58+
## Web Service
59+
60+
Learn about the [web service modules](web-service-input-output.md) which are necessary for real-time inference in Azure Machine Learning designer.
61+
5862
## Error messages
5963

6064
Learn about the [error messages and exception codes](designer-error-codes.md) you might encounter using modules in Azure Machine Learning designer.

articles/machine-learning/algorithm-module-reference/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@
152152
href: pca-based-anomaly-detection.md
153153
- name: Train Anomaly Detection Model
154154
href: train-anomaly-detection-model.md
155+
- name: Web Service
156+
items:
157+
- name: Web Servcie Input/Output
158+
href: web-service-input-output.md
155159
- name: Module errors & troubleshooting
156160
href: designer-error-codes.md
157161

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Web Service Input/Output
2+
3+
This article describes **Web Service Input** module and **Web Service Output** module in Azure Machine Learning designer (preview).
4+
5+
**Web Service Input** module can only connect to input port with type **DataFrameDirectory**. And **Web Service Output** module can only be connected from output port with type **DataFrameDirectory**. The two modules can be found in the module tree, under **Web Service** category.
6+
7+
**Web Service Input** module is used to indicate where user data enters the pipeline and **Web Service Output** module is used to indicate where user data is returned in a Real-time inference Pipeline.
8+
9+
## How to use Web Service Input/Output
10+
11+
1. When you create a real-time inference pipeline from your training pipeline, **Web Service Input** and **Web Service Output** module will be automatically added to show where user data enters the pipeline and where data is returned.
12+
13+
Learn more about [create a real-time inference pipeline](https://docs.microsoft.com/en-us/azure/machine-learning/tutorial-designer-automobile-price-deploy#create-a-real-time-inference-pipeline).
14+
15+
> Note:
16+
>
17+
> Automatically generating real-time inference pipeline is a rule-based best-effort process, there is no guarantee for the correctness. You can manually add or remove **Web Service Input/Output** modules to satisfy your requirements. Make sure there is at least one **Web Service Input** module and one **Web Service Output** module in your real-time inference pipeline. If you have multiple **Web Service Input** or **Web Service Output** modules, make sure they have unique names, which you can input the name in the right panel of the module.
18+
19+
2. You can also manually create a real-time inference pipeline by adding **Web Service Input** and **Web Service Output** modules to your unsubmitted pipeline.
20+
21+
> Note:
22+
>
23+
> The pipeline type will be determined at the first time you submit it. So be sure to add **Web Service Input** and **Web Service Output** module before you submit for the first time if you want to create a real-time inference pipeline.
24+
25+
Below example shows how to manually create real-time inference pipeline from **Execute Python Script** module.
26+
27+
![Example](media/module/web-service-input-output-example.png)
28+
29+
After you submit the pipeline and the run completes successfully, you will be able to deploy the real-time endpoint.
30+
31+
> Note:
32+
>
33+
> In the above example, **Enter Data Manually** provides the data schema for web service input and is necessary for deploying the real-time endpoint. Generally, you should always connect a module or dataset to the port which **Web Service Input** is connected to provide the data schema.
34+
35+
## Next steps
36+
Learn more about [deploy the real-time endpoint](https://docs.microsoft.com/en-us/azure/machine-learning/tutorial-designer-automobile-price-deploy#deploy-the-real-time-endpoint).
37+
See the [set of modules available](module-reference.md) to Azure Machine Learning.

0 commit comments

Comments
 (0)