Skip to content

Commit aac2ad8

Browse files
authored
Merge pull request #204340 from laujan/204230-update-Lu-neural-model-pr
204230 update lu neural model pr
2 parents 7c4cdcb + f4b6cfa commit aac2ad8

File tree

12 files changed

+85
-84
lines changed

12 files changed

+85
-84
lines changed

articles/applied-ai-services/form-recognizer/compose-custom-models-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To get started, you'll need the following resources:
3838
:::image border="true" type="content" source="media/containers/keys-and-endpoint.png" alt-text="Still photo showing how to access resource key and endpoint URL.":::
3939

4040
> [!TIP]
41-
> For more information, see* [**create a Form Recognizer resource**](create-a-form-recognizer-resource.md).
41+
> For more information, see [**create a Form Recognizer resource**](create-a-form-recognizer-resource.md).
4242
4343
* **An Azure storage account.** If you don't know how to create an Azure storage account, follow the [Azure Storage quickstart for Azure portal](../../storage/blobs/storage-quickstart-blobs-portal.md). You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
4444

articles/applied-ai-services/form-recognizer/concept-custom-neural.md

Lines changed: 16 additions & 28 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: conceptual
10-
ms.date: 06/06/2022
10+
ms.date: 07/11/2022
1111
ms.author: lajanuar
1212
ms.custom: references_regions
1313
recommendations: false
@@ -37,8 +37,8 @@ Custom neural models currently only support key-value pairs and selection marks,
3737

3838
With the release of API version **2022-06-30-preview**, custom neural models will support tabular fields (tables):
3939

40-
* Models trained with API version 2022-06-30-preview or later will accept tabular field labels.
41-
* Documents analyzed with custom neural models using API version 2022-06-30-preview or later will produce tabular fields aggregated across the tables.
40+
* Models trained with API version 2022-06-30-preview or later will accept tabular field labels.
41+
* Documents analyzed with custom neural models using API version 2022-06-30-preview or later will produce tabular fields aggregated across the tables.
4242
* The results can be found in the ```analyzeResult``` object's ```documents``` array that is returned following an analysis operation.
4343

4444
Tabular fields support **cross page tables** by default:
@@ -50,34 +50,22 @@ Tabular fields are also useful when extracting repeating information within a do
5050

5151
## Supported regions
5252

53-
For the **2022-06-30-preview**, custom neural models can only be trained in the following Azure regions:
54-
55-
* AustraliaEast
56-
* BrazilSouth
57-
* CanadaCentral
58-
* CentralIndia
59-
* CentralUS
60-
* EastUS
61-
* EastUS2
62-
* FranceCentral
63-
* JapanEast
64-
* JioIndiaWest
65-
* KoreaCentral
66-
* NorthEurope
67-
* SouthCentralUS
68-
* SoutheastAsia
69-
* UKSouth
70-
* WestEurope
71-
* WestUS
72-
* WestUS2
73-
* WestUS3
53+
As of August 01 2022, Form Recognizer custom neural model training will only be available in the following Azure regions until further notice:
54+
55+
* Brazil South
56+
* Canada Central
57+
* Central India
58+
* Japan East
59+
* North Europe
60+
* South Central US
61+
* Southeast Asia
7462

7563
> [!TIP]
76-
> You can copy a model trained in one of the select regions listed above to **any other region** and use it accordingly.
64+
> You can [copy a model](disaster-recovery.md) trained in one of the select regions listed above to **any other region** and use it accordingly.
7765
7866
## Best practices
7967

80-
Custom neural models differ from custom template models in a few different ways. The custom template or model relies on a consistent visual template to extract the labeled data. Custom neural models support structured, semi-structured, and unstructured documents to extract fields. When you're choosing between the two model types, start with a neural model and test to determine if it supports your functional needs.
68+
Custom neural models differ from custom template models in a few different ways. The custom template or model relies on a consistent visual template to extract the labeled data. Custom neural models support structured, semi-structured, and unstructured documents to extract fields. When you're choosing between the two model types, start with a neural model, and test to determine if it supports your functional needs.
8169

8270
### Dealing with variations
8371

@@ -98,7 +86,6 @@ Value tokens/words of one field must be either
9886

9987
Values in training cases should be diverse and representative. For example, if a field is named "date", values for this field should be a date. synthetic value like a random string can affect model performance.
10088

101-
10289
## Current Limitations
10390

10491
* The model doesn't recognize values split across page boundaries.
@@ -130,6 +117,7 @@ https://{endpoint}/formrecognizer/documentModels:build?api-version=2022-06-30
130117
}
131118
}
132119
```
120+
133121
## Next steps
134122

135123
* Train a custom model:
@@ -145,4 +133,4 @@ https://{endpoint}/formrecognizer/documentModels:build?api-version=2022-06-30
145133
* View the REST API:
146134

147135
> [!div class="nextstepaction"]
148-
> [Form Recognizer API v3.0](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/AnalyzeDocument)
136+
> [Form Recognizer API v3.0](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/AnalyzeDocument)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.author: lajanuar
1717
>
1818
> * For an enhanced experience and advanced model quality, try the [Form Recognizer v3.0 Studio (preview)](https://formrecognizer.appliedai.azure.com/studio).
1919
> * The v3.0 Studio supports any model trained with v2.1 labeled data.
20-
> * You can refer to the API migration guide for detailed information about migrating from v2.1 to v3.0.
20+
> * You can refer to the [API migration guide](v3-migration-guide.md) for detailed information about migrating from v2.1 to v3.0.
2121
> * *See* our [**REST API**](quickstarts/try-v3-rest-api.md) or [**C#**](quickstarts/try-v3-csharp-sdk.md), [**Java**](quickstarts/try-v3-java-sdk.md), [**JavaScript**](quickstarts/try-v3-javascript-sdk.md), or [Python](quickstarts/try-v3-python-sdk.md) SDK quickstarts to get started with the V3.0 preview.
2222
2323
> [!NOTE]

articles/applied-ai-services/form-recognizer/how-to-guides/build-custom-model-v3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The Form Recognizer Studio provides and orchestrates all the API calls required
4949
1. On the next step in the workflow, choose or create a Form Recognizer resource before you select continue.
5050

5151
> [!IMPORTANT]
52-
> Custom neural models models are only available in a few regions. If you plan on training a neural model, please select or create a resource in one of [these supported regions](../concept-custom-neural.md).
52+
> Custom neural models models are only available in a few regions. If you plan on training a neural model, please select or create a resource in one of [these supported regions](../concept-custom-neural.md#supported-regions).
5353
5454
:::image type="content" source="../media/how-to/studio-select-resource.png" alt-text="Screenshot: Select the Form Recognizer resource.":::
5555

articles/applied-ai-services/form-recognizer/includes/how-to-guides/csharp-sdk.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: nitinme
66
ms.service: applied-ai-services
77
ms.subservice: forms-recognizer
88
ms.topic: include
9-
ms.date: 11/02/2021
9+
ms.date: 07/11/2022
1010
ms.author: lajanuar
1111
ms.custom: devx-track-csharp, ignite-fall-2021
1212
---
@@ -28,8 +28,10 @@ ms.custom: devx-track-csharp, ignite-fall-2021
2828
* The [Visual Studio IDE](https://visualstudio.microsoft.com/vs/) or current version of [.NET Core](https://dotnet.microsoft.com/download/dotnet-core).
2929
* An Azure Storage blob that contains a set of training data. See [Build a training data set for a custom model](../../build-training-data-set.md) for tips and options for putting together your training data set. For this project, you can use the files under the **Train** folder of the [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) (download and extract *sample_data.zip*).
3030
* 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**.
31-
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the project.
31+
* You'll need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the project.
3232
* You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
33+
> [!TIP]
34+
> Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Form Recognizer access only, create a Form Recognizer resource. Please note that you'll need a single-service resource if you intend to use [Azure Active Directory authentication](../../../../active-directory/authentication/overview-authentication.md).
3335
3436
## Setting up
3537

@@ -76,7 +78,7 @@ In the application's **Program** class, create variables for your resource's key
7678
7779
[!code-csharp[](~/cognitive-services-quickstart-code/dotnet/FormRecognizer/FormRecognizerQuickstart.cs?name=snippet_creds)]
7880

79-
In the application's **Main** method, add a call to the asynchronous tasks used in this project. You will implement them later:
81+
In the application's **Main** method, add a call to the asynchronous tasks used in this project. You'll implement them later:
8082

8183
[!code-csharp[](~/cognitive-services-quickstart-code/dotnet/FormRecognizer/FormRecognizerQuickstart-preview.cs?name=snippet_main)]
8284

@@ -86,11 +88,11 @@ With Form Recognizer, you can create two different client types. The first, `For
8688

8789
### FormRecognizerClient
8890

89-
`FormRecognizerClient` provides operations for:
91+
`FormRecognizerClient` provides the following operations:
9092

91-
* Recognizing form fields and content, using custom models trained to analyze your custom forms. These values are returned in a collection of `RecognizedForm` objects. See example [Analyze custom forms](#analyze-forms-with-a-custom-model).
92-
* Recognizing form content, including tables, lines and words, without the need to train a model. Form content is returned in a collection of `FormPage` objects. See example [Analyze layout](#analyze-layout).
93-
* Recognizing common fields from US receipts, business cards, invoices, and ID documents using a pre-trained model on the Form Recognizer service.
93+
* Recognize form fields and content, using custom models trained to analyze your custom forms. These values are returned in a collection of `RecognizedForm` objects. See example [Analyze custom forms](#analyze-forms-with-a-custom-model).
94+
* Recognize form content, including tables, lines and words, without the need to train a model. Form content is returned in a collection of `FormPage` objects. See example [Analyze layout](#analyze-layout).
95+
* Recognize common fields from US receipts, business cards, invoices, and ID documents using a pre-trained model on the Form Recognizer service.
9496

9597
### FormTrainingClient
9698

@@ -289,7 +291,7 @@ The following code processes the ID document at the given URI and prints the maj
289291

290292
## Train a custom model
291293

292-
This section demonstrates how to train a model with your own data. A trained model can output structured data that includes the key/value relationships in the original form document. After you train the model, you can test and retrain it and eventually use it to reliably extract data from more forms according to your needs.
294+
This section demonstrates how to train a model with your own data. A trained model can output structured data that includes the key/value relationships in the original form document. After you train the model, you can test, retrain, and eventually use it to reliably extract data from more forms according to your needs.
293295

294296
> [!NOTE]
295297
> You can also train models with a graphical user interface such as the [Form Recognizer Sample Labeling tool](../../label-tool.md).
@@ -366,7 +368,7 @@ Submodel Form Type: form-0
366368

367369
### Train a model with labels
368370

369-
You can also train custom models by manually labeling the training documents. Training with labels leads to better performance in some scenarios. To train with labels, you need to have special label information files (`\<filename\>.pdf.labels.json`) in your blob storage container alongside the training documents. The [Form Recognizer Sample Labeling tool](../../label-tool.md) provides a UI to help you create these label files. Once you have them, you can call the `StartTrainingAsync` method with the `uselabels` parameter set to `true`.
371+
You can also train custom models by manually labeling the training documents. Training with labels leads to better performance in some scenarios. To train with labels, you need to have special label information files (`\<filename\>.pdf.labels.json`) in your blob storage container alongside the training documents. The [Form Recognizer Sample Labeling tool](../../label-tool.md) provides a UI to help you create these label files. Once you've them, you can call the `StartTrainingAsync` method with the `uselabels` parameter set to `true`.
370372

371373
[!code-csharp[](~/cognitive-services-quickstart-code/dotnet/FormRecognizer/FormRecognizerQuickstart.cs?name=snippet_trainlabels)]
372374

@@ -503,7 +505,7 @@ This section demonstrates how to manage the custom models stored in your account
503505

504506
### Check the number of models in the FormRecognizer resource account
505507

506-
The following code block checks how many models you have saved in your Form Recognizer account and compares it to the account limit.
508+
The following code block checks how many models you've saved in your Form Recognizer account and compares it to the account limit.
507509

508510
[!code-csharp[](~/cognitive-services-quickstart-code/dotnet/FormRecognizer/FormRecognizerQuickstart.cs?name=snippet_manage_model_count)]
509511

@@ -516,7 +518,7 @@ It can have at most 5000 models.
516518

517519
### List the models currently stored in the resource account
518520

519-
The following code block lists the current models in your account and prints their details to the console.
521+
The following code blocklists the current models in your account and prints their details to the console.
520522

521523
[!code-csharp[](~/cognitive-services-quickstart-code/dotnet/FormRecognizer/FormRecognizerQuickstart.cs?name=snippet_manage_model_list)]
522524

0 commit comments

Comments
 (0)