Skip to content

Commit 1694e15

Browse files
Merge pull request #223400 from laujan/55552-preliminary-updates
55552 preliminary updates
2 parents ddddf53 + 218a2af commit 1694e15

File tree

4 files changed

+29
-25
lines changed

4 files changed

+29
-25
lines changed

articles/applied-ai-services/form-recognizer/deploy-label-tool.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 10/10/2022
10+
ms.date: 01/09/2023
1111
ms.author: lajanuar
1212
monikerRange: 'form-recog-2.1.0'
1313
recommendations: false
1414
---
1515

1616
# Deploy the Sample Labeling tool
1717

18+
**This article applies to:** ![Form Recognizer v2.1 checkmark](media/yes-icon.png) **Form Recognizer v2.1**.
19+
1820
>[!TIP]
1921
>
20-
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio ](https://formrecognizer.appliedai.azure.com/studio).
22+
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio](https://formrecognizer.appliedai.azure.com/studio).
2123
> * The v3.0 Studio supports any model trained with v2.1 labeled data.
2224
> * You can refer to the [API migration guide](v3-migration-guide.md) for detailed information about migrating from v2.1 to v3.0.
2325
> * *See* our [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) or [**C#**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**Java**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), or [Python](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) SDK quickstarts to get started with the v3.0 version.
@@ -94,7 +96,7 @@ Follow these steps to create a new resource using the Azure portal:
9496

9597
### Continuous deployment
9698

97-
After you have created your web app, you can enable the continuous deployment option:
99+
After you've created your web app, you can enable the continuous deployment option:
98100

99101
* From the left pane, choose **Container settings**.
100102
* In the main window, navigate to Continuous deployment and toggle between the **On** and **Off** buttons to set your preference:

articles/applied-ai-services/form-recognizer/label-tool.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 10/10/2022
10+
ms.date: 01/09/2023
1111
ms.author: lajanuar
1212
monikerRange: 'form-recog-2.1.0'
1313
recommendations: false
@@ -18,6 +18,8 @@ recommendations: false
1818
<!-- markdownlint-disable MD034 -->
1919
# Train a custom model using the Sample Labeling tool
2020

21+
**This article applies to:** ![Form Recognizer v2.1 checkmark](media/yes-icon.png) **Form Recognizer v2.1**.
22+
2123
>[!TIP]
2224
>
2325
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio](https://formrecognizer.appliedai.azure.com/studio).
@@ -35,7 +37,7 @@ In this article, you'll use the Form Recognizer REST API with the Sample Labelin
3537

3638
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services)
3739
* Once you have your Azure subscription, <a href="https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer" title="Create a Form Recognizer resource" target="_blank">create a Form Recognizer resource </a> in the Azure portal to get your key and endpoint. After it deploys, select **Go to resource**.
38-
* You'll need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. You'll paste your key and endpoint into the code below later in the quickstart.
40+
* You'll need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. You'll paste your key and endpoint into the code later in the quickstart.
3941
* You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
4042
* A set of at least six forms of the same type. You'll use this data to train the model and test a form. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) (download and extract *sample_data.zip*) for this quickstart. Upload the training files to the root of a blob storage container in a standard-performance-tier Azure Storage account.
4143

@@ -69,7 +71,7 @@ You'll use the Docker engine to run the Sample Labeling tool. Follow these steps
6971

7072
| Container | Minimum | Recommended|
7173
|:--|:--|:--|
72-
|Sample Labeling tool|2 core, 4-GB memory|4 core, 8-GB memory|
74+
|Sample Labeling tool|`2` core, 4-GB memory|`4` core, 8-GB memory|
7375

7476
Install Docker on your machine by following the appropriate instructions for your operating system:
7577

@@ -89,7 +91,7 @@ You'll use the Docker engine to run the Sample Labeling tool. Follow these steps
8991
docker run -it -p 3000:80 mcr.microsoft.com/azure-cognitive-services/custom-form/labeltool:latest-2.1 eula=accept
9092
```
9193

92-
This command will make the Sample Labeling tool available through a web browser. Go to `http://localhost:3000`.
94+
This command will make the sample-labeling tool available through a web browser. Go to `http://localhost:3000`.
9395

9496
> [!NOTE]
9597
> You can also label documents and train models using the Form Recognizer REST API. To train and Analyze with the REST API, see [Train with labels using the REST API and Python](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/python/FormRecognizer/rest/python-labeled-data.md).
@@ -171,6 +173,7 @@ Next, you'll create tags (labels) and apply them to the text elements that you w
171173
1. Press Enter to save the tag.
172174
1. In the main editor, select words from the highlighted text elements or a region you drew in.
173175
1. Select the tag you want to apply, or press the corresponding keyboard key. The number keys are assigned as hotkeys for the first 10 tags. You can reorder your tags using the up and down arrow icons in the tag editor pane.
176+
1. Follow these steps to label at least five of your forms.
174177
> [!Tip]
175178
> Keep the following tips in mind when you're labeling your forms:
176179
>
@@ -186,8 +189,6 @@ Next, you'll create tags (labels) and apply them to the text elements that you w
186189

187190
:::image type="content" source="media/label-tool/main-editor-2-1.png" alt-text="Main editor window of Sample Labeling tool.":::
188191

189-
Follow the steps above to label at least five of your forms.
190-
191192
### Specify tag value types
192193

193194
You can set the expected data type for each tag. Open the context menu to the right of a tag and select a type from the menu. This feature allows the detection algorithm to make assumptions that will improve the text-detection accuracy. It also ensures that the detected values will be returned in a standardized format in the final JSON output. Value type information is saved in the **fields.json** file in the same path as your label files.
@@ -262,7 +263,7 @@ Choose the Train icon on the left pane to open the Training page. Then select th
262263

263264
:::image type="content" source="media/label-tool/train-screen.png" alt-text="Training view.":::
264265

265-
After training finishes, examine the **Average Accuracy** value. If it's low, you should add more input documents and repeat the steps above. The documents you've already labeled will remain in the project index.
266+
After training finishes, examine the **Average Accuracy** value. If it's low, you should add more input documents and repeat the labeling steps. The documents you've already labeled will remain in the project index.
266267

267268
> [!TIP]
268269
> You can also run the training process with a REST API call. To learn how to do this, see [Train with labels using Python](https://github.com/Azure-Samples/cognitive-services-quickstart-code/blob/master/python/FormRecognizer/rest/python-labeled-data.md).
@@ -271,14 +272,16 @@ After training finishes, examine the **Average Accuracy** value. If it's low, yo
271272

272273
With Model Compose, you can compose up to 100 models to a single model ID. When you call Analyze with the composed `modelID`, Form Recognizer will first classify the form you submitted, choose the best matching model, and then return results for that model. This operation is useful when incoming forms may belong to one of several templates.
273274

274-
To compose models in the Sample Labeling tool, select the Model Compose (merging arrow) icon on the left. On the left, select the models you wish to compose together. Models with the arrows icon are already composed models.
275-
Choose the **Compose button**. In the pop-up, name your new composed model and select **Compose**. When the operation completes, your newly composed model should appear in the list.
275+
* To compose models in the Sample Labeling tool, select the Model Compose (merging arrow) icon from the navigation bar.
276+
* Select the models you wish to compose together. Models with the arrows icon are already composed models.
277+
* Choose the **Compose button**. In the pop-up, name your new composed model and select **Compose**.
278+
* When the operation completes, your newly composed model should appear in the list.
276279

277280
:::image type="content" source="media/label-tool/model-compose.png" alt-text="Model compose UX view.":::
278281

279282
## Analyze a form
280283

281-
Select the Analyze (light bulb) icon on the left to test your model. Select source 'Local file'. Browse for a file and select a file from the sample dataset that you unzipped in the test folder. Then choose the **Run analysis** button to get key/value pairs, text and tables predictions for the form. The tool will apply tags in bounding boxes and will report the confidence of each tag.
284+
Select the Analyze icon from the navigation bar to test your model. Select source 'Local file'. Browse for a file and select a file from the sample dataset that you unzipped in the test folder. Then choose the **Run analysis** button to get key/value pairs, text and tables predictions for the form. The tool will apply tags in bounding boxes and will report the confidence of each tag.
282285

283286
:::image type="content" source="media/analyze.png" alt-text="Screenshot: analyze-a-custom-form window":::
284287

@@ -301,7 +304,7 @@ Go to your project settings page (slider icon) and take note of the security tok
301304

302305
### Restore project credentials
303306

304-
When you want to resume your project, you first need to create a connection to the same blob storage container. To do so, repeat the steps above. Then, go to the application settings page (gear icon) and see if your project's security token is there. If it isn't, add a new security token and copy over your token name and key from the previous step. Select **Save** to retain your settings.
307+
When you want to resume your project, you first need to create a connection to the same blob storage container. To do so, repeat the steps. Then, go to the application settings page (gear icon) and see if your project's security token is there. If it isn't, add a new security token and copy over your token name and key from the previous step. Select **Save** to retain your settings.
305308

306309
### Resume a project
307310

articles/applied-ai-services/form-recognizer/quickstarts/try-sample-label-tool.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ ms.subservice: forms-recognizer
99
ms.topic: quickstart
1010
ms.date: 10/10/2022
1111
ms.author: lajanuar
12-
ms.custom: cog-serv-seo-may-2021, ignite-fall-2021, mode-other
1312
monikerRange: 'form-recog-2.1.0'
1413
recommendations: false
1514
---
@@ -20,11 +19,11 @@ recommendations: false
2019
<!-- markdownlint-disable MD029 -->
2120
# Get started with the Form Recognizer Sample Labeling tool
2221

23-
[!INCLUDE [applies to v2.1](../includes/applies-to-v2-1.md)]
22+
**This article applies to:** ![Form Recognizer v2.1 checkmark](../media/yes-icon.png) **Form Recognizer v2.1**.
2423

2524
>[!TIP]
2625
>
27-
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio ](https://formrecognizer.appliedai.azure.com/studio).
26+
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio](https://formrecognizer.appliedai.azure.com/studio).
2827
> * The v3.0 Studio supports any model trained with v2.1 labeled data.
2928
> * You can refer to the API migration guide for detailed information about migrating from v2.1 to v3.0.
3029
> * *See* our [**REST API**](get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) or [**C#**](get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**Java**](get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**JavaScript**](get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), or [Python](get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) SDK quickstarts to get started with the v3.0 version.
@@ -243,7 +242,7 @@ Use the tags editor pane to create a new tag you'd like to identify:
243242

244243
1. In the main editor, select the total value from the highlighted text elements.
245244

246-
1. Select the Total tag to apply to the value, or press the corresponding keyboard key. The number keys are assigned as hotkeys for the first 10 tags. You can reorder your tags using the up and down arrow icons in the tag editor pane.
245+
1. Select the Total tag to apply to the value, or press the corresponding keyboard key. The number keys are assigned as hotkeys for the first 10 tags. You can reorder your tags using the up and down arrow icons in the tag editor pane. Follow these steps to label all five forms in the sample dataset:
247246

248247
> [!Tip]
249248
> Keep the following tips in mind when you're labeling your forms:
@@ -259,8 +258,6 @@ Use the tags editor pane to create a new tag you'd like to identify:
259258
> * To remove an applied tag without deleting the tag itself, select the tagged rectangle on the document view and press the delete key.
260259
>
261260
262-
1. Continue to follow the steps above to label all five forms in the sample dataset.
263-
264261
:::image type="content" source="../media/label-tool/custom-1.jpg" alt-text="Label the samples.":::
265262

266263
#### Train a custom model
@@ -276,7 +273,7 @@ Choose the Train icon on the left pane to open the Training page. Then select th
276273

277274
#### Analyze a custom form
278275

279-
1. Select the **Analyze** (light bulb) icon on the left to test your model.
276+
1. Select the **Analyze** icon from the navigation bar to test your model.
280277

281278
1. Select source **Local file** and browse for a file to select from the sample dataset that you unzipped in the test folder.
282279

articles/applied-ai-services/form-recognizer/supervised-table-tags.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
---
2-
title: "How to use table tags to train your custom template model - Form Recognizer"
2+
title: "Train your custom template model with the sample-labeling tool and table tags"
33
titleSuffix: Azure Applied AI Services
44
description: Learn how to effectively use supervised table tag labeling.
55
author: laujan
66
manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 10/10/2022
10+
ms.date: 01/09/2023
1111
ms.author: lajanuar
1212
#Customer intent: As a user of the Form Recognizer custom model service, I want to ensure I'm training my model in the best way.
1313
monikerRange: 'form-recog-2.1.0'
1414
recommendations: false
1515
---
1616

17-
# Use table tags to train your custom template model
17+
# Train models with the sample-labeling tool
18+
19+
**This article applies to:** ![Form Recognizer v2.1 checkmark](media/yes-icon.png) **Form Recognizer v2.1**.
1820

1921
>[!TIP]
2022
>
21-
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio ](https://formrecognizer.appliedai.azure.com/studio).
23+
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio](https://formrecognizer.appliedai.azure.com/studio).
2224
> * The v3.0 Studio supports any model trained with v2.1 labeled data.
2325
> * You can refer to the [API migration guide](v3-migration-guide.md) for detailed information about migrating from v2.1 to v3.0.
2426
> * *See* our [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) or [**C#**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**Java**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true), or [Python](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) SDK quickstarts to get started with version v3.0.

0 commit comments

Comments
 (0)