Skip to content

Commit 301492b

Browse files
authored
Merge pull request #191769 from aahill/baher-update-2
Baher update - custom features
2 parents 967e5b4 + 098c152 commit 301492b

File tree

14 files changed

+85
-31
lines changed

14 files changed

+85
-31
lines changed

articles/cognitive-services/language-service/conversational-language-understanding/how-to/deploy-query-model.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: how-to
11-
ms.date: 01/26/2022
11+
ms.date: 03/15/2022
1212
ms.author: aahi
1313
ms.devlang: csharp, python
1414
ms.custom: language-service-clu, ignite-fall-2021
@@ -18,32 +18,57 @@ ms.custom: language-service-clu, ignite-fall-2021
1818

1919
After you have [trained a model](./train-model.md) on your dataset, you're ready to deploy it. After deploying your model, you'll be able to query it for predictions.
2020

21+
> [!Tip]
22+
> Before deploying a model, make sure to view the model details to make sure that the model is performing as expected.
23+
2124
## Deploy model
2225

23-
Deploying a model is to host it and make it available for predictions through an endpoint. You can only have 1 deployed model per project, deploying another one will overwrite the previously deployed model.
26+
Deploying a model hosts and makes it available for predictions through an endpoint.
2427

2528
When a model is deployed, you will be able to test the model directly in the portal or by calling the API associated to it.
2629

27-
Simply select a model and click on deploy model in the Deploy model page.
30+
### Conversation projects deployments
31+
32+
1. Click on *Add deployment* to submit a new deployment job
33+
34+
:::image type="content" source="../media/add-deployment-model.png" alt-text="A screenshot showing the model deployment button in Language Studio." lightbox="../media/add-deployment-model.png":::
35+
36+
2. In the window that appears, you can create a new deployment name by giving the deployment a name or override an existing deployment name. Then, you can add a trained model to this deployment name.
37+
38+
:::image type="content" source="../media/create-deployment-job.png" alt-text="A screenshot showing the add deployment job screen in Language Studio." lightbox="../media/create-deployment-job.png":::
39+
40+
41+
#### Swap deployments
2842

29-
:::image type="content" source="../media/deploy-model.png" alt-text="A screenshot showing the model deployment page in Language Studio." lightbox="../media/deploy-model.png":::
43+
If you would like to swap the models between two deployments, simply select the two deployment names you want to swap and click on **Swap deployments**. From the window that appears, select the deployment name you want to swap with.
44+
45+
:::image type="content" source="../media/swap-deployment.png" alt-text="A screenshot showing a swapped deployment in Language Studio." lightbox="../media/swap-deployment.png":::
46+
47+
#### Delete deployment
48+
49+
To delete a deployment, select the deployment you want to delete and click on **Delete deployment**.
3050

3151
> [!TIP]
3252
> If you're using the REST API, see the [quickstart](../quickstart.md?pivots=rest-api#deploy-your-model) and REST API [reference documentation](https://westus2.dev.cognitive.microsoft.com/docs/services/language-authoring-clu-apis-2021-11-01-preview/operations/Deployments_TriggerDeploymentJob) for examples and more information.
3353
34-
**Orchestration workflow projects deployments**
54+
> [!NOTE]
55+
> You can only have ten deployment names.
56+
57+
### Orchestration workflow projects deployments
58+
59+
1. Click on **Add deployment** to submit a new deployment job.
60+
61+
Like conversation projects, In the window that appears, you can create a new deployment name by giving the deployment a name or override an existing deployment name. Then, you can add a trained model to this deployment name and press next.
3562

36-
When you're deploying an orchestration workflow project, A small window will show up for you to confirm your deployment, and configure parameters for connected services.
63+
:::image type="content" source="../media/create-deployment-job-orch.png" alt-text="A screenshot showing deployment job creation in Language Studio." lightbox="../media/create-deployment-job-orch.png":::
3764

38-
If you're connecting one or more LUIS applications, specify the deployment name, and whether you're using *slot* or *version* type deployment.
39-
* The *slot* deployment type requires you to pick between a production and staging slot.
40-
* The *version* deployment type requires you to specify the version you have published.
65+
2. If you're connecting one or more LUIS applications or conversational language understanding projects, specify the deployment name.
4166

42-
No configurations are required for custom question answering and conversational language understanding connections, or unlinked intents.
67+
No configurations are required for custom question answering or unlinked intents.
4368

44-
LUIS projects **must be published** to the slot configured during the Orchestration deployment, and custom question answering KBs must also be published to their Production slots.
69+
LUIS projects **must be published** to the slot configured during the Orchestration deployment, and custom question answering KBs must also be published to their Production slots.
4570

46-
:::image type="content" source="../media/deploy-connected-services.png" alt-text="A screenshot showing the deployment screen for orchestration workflow projects." lightbox="../media/deploy-connected-services.png":::
71+
:::image type="content" source="../media/deploy-connected-services.png" alt-text="A screenshot showing the deployment screen for orchestration workflow projects." lightbox="../media/deploy-connected-services.png":::
4772

4873
## Send a Conversational Language Understanding request
4974

articles/cognitive-services/language-service/conversational-language-understanding/includes/quickstarts/language-studio.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ manager: nitinme
55
ms.service: cognitive-services
66
ms.subservice: language-service
77
ms.topic: include
8-
ms.date: 01/27/2022
8+
ms.date: 03/15/2022
99
ms.author: aahi
1010
ms.custom: ignite-fall-2021
1111
---
@@ -29,7 +29,7 @@ ms.custom: ignite-fall-2021
2929

3030
Once you have a Language resource associated with your account, create a Conversational Language Understanding project. In this quickstart, you'll create a project that can identify commands for email, such as: reading emails by certain people, deleting emails, and attaching a document to an email.
3131

32-
1. In [Language Studio](https://aka.ms/languageStudio), find the section labelled **Understand conversational language** and select **Conversational language understanding**.
32+
1. In [Language Studio](https://aka.ms/languageStudio), find the section named **Understand conversational language** and select **Conversational language understanding**.
3333
:::image type="content" source="../../media/select-custom-clu.png" alt-text="A screenshot showing the location of Custom Language Understanding in the Language Studio landing page." lightbox="../../media/select-custom-clu.png":::
3434

3535

@@ -99,15 +99,18 @@ When you're done, select **Save Changes** to save the utterances and labels to t
9999

100100
## Train your model and view its details
101101

102-
Select **train model** on the left of the screen. Select **Start a training job**. To train your model, you need to provide a name for the model. Write a name like "*v1*" and press the enter key.
102+
Select **train model** on the left of the screen. Select **Start a training job**. To train your model, you need to provide a name for the model. Write a name like "*v1*" and press the enter key.
103103

104-
Turn off **Run evaluation with training** before selecting **Train**.
104+
> [!NOTE]
105+
> If you did not [tag utterances](#tag-utterances) you will only be allowed to train using the **Automatically split the testing set from all data** option. See [Add utterances to testing set](../../how-to/tag-utterances.md#tag-utterances) for more information.
105106
106-
You should see the **View model details** page. Wait until training completes, which may take about 5 minutes. When training succeeds, Select **Deploy Model** on the left of the screen.
107+
When the training job is complete, which may take some time, you should see the output model performance in the **View model details** page.
107108

108109
## Deploy your model
109110

110-
From the **Deploy model** page on the left of the screen, select the trained model and select the **Deploy model** button. In the screen that appears, select **Deploy**.
111+
From the **Deploy model** page on the left of the screen, select **Add deployment**.
112+
113+
In the window that appears, give your deployment a **deployment name** and then assign your trained model to this deployment name and then select **Submit**.
111114

112115
## Test your model
113116

70.2 KB
Loading
Loading
Loading
99.3 KB
Loading

articles/cognitive-services/language-service/custom-classification/how-to/call-api.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: how-to
11-
ms.date: 01/07/2022
11+
ms.date: 03/15/2022
1212
ms.author: aahi
1313
ms.custom: language-service-custom-classification, ignite-fall-2021
1414
---
@@ -29,11 +29,20 @@ See the [application development lifecycle](../overview.md#project-development-l
2929

3030
## Deploy your model
3131

32-
After your model is [trained](train-model.md), you can deploy it. Deploying your model lets you start using it to classify text. You can deploy your model using the [REST API](https://westus2.dev.cognitive.microsoft.com/docs/services/language-authoring-apis-2021-11-01-preview/operations/Deployments_TriggerDeploymentJob) or Language Studio. To use Language Studio, see the steps below:
32+
Deploying a model hosts it and makes it available for predictions through an endpoint.
33+
34+
35+
36+
When a model is deployed, you will be able to test the model directly in the portal or by calling the API associated with it.
37+
38+
> [!NOTE]
39+
> You can only have ten deployment names.
3340
3441
[!INCLUDE [Deploy a model using Language Studio](../includes/deploy-model-language-studio.md)]
42+
43+
### Delete deployment
3544

36-
If you deploy your model through the Language Studio, your `deployment-name` is `prod`.
45+
To delete a deployment, select the deployment you want to delete and click **Delete deployment**
3746

3847
> [!TIP]
3948
> You can [test your model in Language Studio](../quickstart.md?pivots=language-studio#test-your-model) by sending samples of text for it to classify.
@@ -58,7 +67,7 @@ If you deploy your model through the Language Studio, your `deployment-name` is
5867

5968
5. In the response header you receive extract `jobId` from `operation-location`, which has the format: `{YOUR-ENDPOINT}/text/analytics/v3.2-preview.2/analyze/jobs/<jobId}>`
6069

61-
6. Copy the retrieve request and replace `<OPERATION-ID>` with `jobId` received form last step and submit the request.
70+
6. Copy the retrieve request and replace `<OPERATION-ID>` with `jobId` received from the last step and submit the request.
6271

6372
:::image type="content" source="../media/get-prediction-url-3.png" alt-text="run-inference-3" lightbox="../media/get-prediction-url-3.png":::
6473

articles/cognitive-services/language-service/custom-classification/includes/deploy-model-language-studio.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ manager: nitinme
44
ms.service: cognitive-services
55
ms.subservice: language-service
66
ms.topic: include
7-
ms.date: 02/28/2022
7+
ms.date: 03/15/2022
88
ms.author: aahi
99
---
1010

11-
1. Go to your project in [Language Studio](https://aka.ms/custom-classification)
11+
1. Go to your project in [Language studio](https://aka.ms/custom-classification).
12+
2. From the left panel, select **Deploy model**.
13+
3. Click on **Add deployment** to submit a new deployment job.
1214

13-
2. Select **Deploy model** from the left side menu.
15+
:::image type="content" source="../media/deploy-model.png" alt-text="A screenshot showing the deployment button." lightbox="../media/deploy-model.png":::
1416

15-
3. Select the model you want to deploy and from the top menu click on **Deploy model**.
17+
4. In the window that appears, you can create a new deployment name by or override an existing one. Then, you can add a trained model to this deployment name.
18+
19+
:::image type="content" source="../media/add-deployment.png" alt-text="A screenshot showing the screen for a new deployment" lightbox="../media/add-deployment.png":::
94.5 KB
Loading
66 KB
Loading

0 commit comments

Comments
 (0)