Skip to content

Commit 0694460

Browse files
committed
final edit
1 parent fedeb34 commit 0694460

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

articles/ai-services/document-intelligence/how-to-guides/compose-custom-models.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ ms.author: lajanuar
3636

3737
::: moniker range=">=doc-intel-3.0.0"
3838

39-
A composed model is created by taking a collection of custom models and assigning them to a single model ID. You can assign up to 200 trained custom models to a single composed model ID. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis. Composed models are useful when you've trained several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
39+
A composed model is created by taking a collection of custom models and assigning them to a single model ID. You can assign up to 200 trained custom models to a single composed model ID. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis. Composed models are useful when you train several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
4040

4141
To learn more, see [Composed custom models](../concept-composed-models.md).
4242

@@ -48,7 +48,7 @@ To get started, you need the following resources:
4848

4949
* **An Azure subscription**. You can [create a free Azure subscription](https://azure.microsoft.com/free/cognitive-services/).
5050

51-
* **A Document Intelligence instance**. Once you have your Azure subscription, [create a Document Intelligence resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) in the Azure portal to get your key and endpoint. If you have an existing Document Intelligence resource, navigate directly to your resource page. You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
51+
* **A Document Intelligence instance**. Once you have your Azure subscription, [create a Document Intelligence resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) in the Azure portal to get your key and endpoint. If you have an existing Document Intelligence resource, navigate directly to your resource page. You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
5252

5353
1. After the resource deploys, select **Go to resource**.
5454

@@ -63,7 +63,7 @@ To get started, you need the following resources:
6363

6464
## Create your custom models
6565

66-
First, you need a set of custom models to compose. You can use the Document Intelligence Studio, REST API, or client-library SDKs. The steps are as follows:
66+
First, you need a set of custom models to compose. You can use the Document Intelligence Studio, REST API, or client libraries. The steps are as follows:
6767

6868
* [**Assemble your training dataset**](#assemble-your-training-dataset)
6969
* [**Upload your training set to Azure blob storage**](#upload-your-training-dataset)
@@ -85,7 +85,7 @@ See [Build a training data set](../how-to-guides/build-a-custom-model.md?view=do
8585

8686
## Upload your training dataset
8787

88-
When you've gathered a set of training documents, you need to [upload your training data](../how-to-guides/build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#upload-your-training-data) to an Azure blob storage container.
88+
Once you gather a set of training documents, you need to [upload your training data](../how-to-guides/build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#upload-your-training-data) to an Azure blob storage container.
8989

9090
If you want to use manually labeled data, you have to upload the *.labels.json* and *.ocr.json* files that correspond to your training documents.
9191

@@ -105,7 +105,7 @@ To create custom models, start with configuring your project:
105105

106106
1. Enter project details, select the Azure subscription and resource, and the Azure Blob storage container that contains your data.
107107

108-
1. Review and submit your settings to create the project.
108+
1. Review and submit your settings and create the project.
109109

110110
:::image type="content" source="../media/studio/create-project.gif" alt-text="Animation showing create a custom project in Document Intelligence Studio.":::
111111

@@ -121,7 +121,7 @@ See [Document Intelligence Studio: labeling as tables](../concept-custom-label.m
121121

122122
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.
123123

124-
Label files contain key-value associations that a user has entered manually. They're needed for labeled data training, but not every source file needs to have a corresponding label file. Source files without labels are treated as ordinary training documents. We recommend five or more labeled files for reliable training. You can use a UI tool like [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/customform/projects) to generate these files.
124+
Label files contain key-value associations that a user entered manually. The files are needed for labeled data training, but not every source file needs to have a corresponding label file. Source files without labels are treated as ordinary training documents. We recommend five or more labeled files for reliable training. You can use a UI tool like [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/customform/projects) to generate these files.
125125

126126
Once you have your label files, you can include them with by calling the training method with the *useLabelFile* parameter set to `true`.
127127

@@ -150,7 +150,7 @@ With the [**create compose model**](/rest/api/aiservices/document-models/compose
150150

151151
### [Document Intelligence Studio](#tab/studio)
152152

153-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
153+
Once the training process is successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
154154

155155
* [**Gather your custom model IDs**](#gather-your-model-ids)
156156
* [**Compose your custom models**](#compose-your-custom-models)
@@ -197,15 +197,15 @@ You can manage your custom models throughout life cycles:
197197

198198
### [REST API](#tab/rest)
199199

200-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
200+
Once the training process is successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
201201

202202
* [**Compose your custom models**](#compose-your-custom-models)
203203
* [**Analyze documents**](#analyze-documents)
204204
* [**Manage your composed models**](#manage-your-composed-models)
205205

206206
#### Compose your custom models
207207

208-
The [compose model API](/rest/api/aiservices/document-models/compose-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) accepts a list of model IDs to be composed.
208+
The [composed models API](/rest/api/aiservices/document-models/compose-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) accepts a list of model IDs to be composed.
209209

210210
:::image type="content" source="../media/compose-model-request-body.png" alt-text="Screenshot of compose model request.":::
211211

@@ -221,7 +221,7 @@ You can manage custom models throughout your development needs including [**copy
221221

222222
### [Client libraries](#tab/sdks)
223223

224-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
224+
Once the training process successfully completes, you can begin to build your composed model. Here are the steps for creating and using composed models:
225225

226226
* [**Create a composed model**](#create-a-composed-model)
227227
* [**Analyze documents**](#analyze-documents)
@@ -240,7 +240,7 @@ You can use the programming language of your choice to create a composed model:
240240

241241
#### Analyze documents
242242

243-
Once you've built your composed model, you can use it to analyze forms and documents. Use your composed `model ID` and let the service decide which of your aggregated custom models fits best according to the document provided.
243+
Once you build your composed model, you can use it to analyze forms and documents. Use your composed `model ID` and let the service decide which of your aggregated custom models fits best according to the document provided.
244244

245245
|Programming language| Code sample |
246246
|--|--|
@@ -262,7 +262,7 @@ You can manage a custom model at each stage in its life cycles. You can copy a c
262262

263263
---
264264

265-
Great! You've learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
265+
Great! You learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
266266

267267
## Next steps
268268

@@ -296,7 +296,7 @@ Document Intelligence uses advanced machine-learning technology to detect and ex
296296

297297
* **Composed models**. A composed model is created by taking a collection of custom models and assigning them to a single model that encompasses your form types. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis.
298298

299-
In this article, you learn how to create Document Intelligence custom and composed models using our [Document Intelligence Sample Labeling tool](../label-tool.md), [REST APIs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true), or [client-library SDKs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true).
299+
In this article, you learn how to create Document Intelligence custom and composed models using our [Document Intelligence Sample Labeling tool](../label-tool.md), [REST APIs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true), or [client libraries](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true).
300300

301301
## Sample Labeling tool
302302

@@ -315,11 +315,11 @@ In the Document Intelligence UI:
315315

316316
1. Select **Use Custom to train a model with labels and get key value pairs**.
317317

318-
:::image type="content" source="../media/label-tool/fott-use-custom.png" alt-text="Screenshot of the FOTT tool select custom model option.":::
318+
:::image type="content" source="../media/label-tool/fott-use-custom.png" alt-text="Screenshot of the `FOTT` tool select custom model option.":::
319319

320320
1. In the next window, select **New project**:
321321

322-
:::image type="content" source="../media/label-tool/fott-new-project.png" alt-text="Screenshot of the FOTT tool select new project option.":::
322+
:::image type="content" source="../media/label-tool/fott-new-project.png" alt-text="Screenshot of the `FOTT` tool select new project option.":::
323323

324324
## Create your models
325325

@@ -360,14 +360,14 @@ Document Intelligence uses the [Layout](../concept-layout.md) API to learn the e
360360
361361
With the Model Compose operation, you can assign up to 200 trained custom models to a single model ID. When you call Analyze with the composed model ID, Document Intelligence classifies the form you submitted first, chooses the best matching assigned model, and then returns results for that model. This operation is useful when incoming forms may belong to one of several templates.
362362

363-
Using the Document Intelligence Sample Labeling tool, the REST API, or the Client-library SDKs, follow the steps to set up a composed model:
363+
Using the Document Intelligence Sample Labeling tool, the REST API, or the client libraries, follow the steps to set up a composed model:
364364

365365
1. [**Gather your custom model IDs**](#gather-your-custom-model-ids)
366366
1. [**Compose your custom models**](#compose-your-custom-models)
367367

368368
### Gather your custom model IDs
369369

370-
Once the training process has successfully completed, your custom model is assigned a model ID. You can retrieve a model ID as follows:
370+
Once the training process is successfully completed, your custom model is assigned a model ID. You can retrieve a model ID as follows:
371371

372372
<!-- Applies to FOTT but labeled studio to eliminate tab grouping warning -->
373373
### [**Document Intelligence Sample Labeling tool**](#tab/studio)
@@ -384,7 +384,7 @@ The [**REST API**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=tr
384384

385385
### [**Client-library SDKs**](#tab/sdks)
386386

387-
The [**client-library SDKs**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#train-your-model) return a model object that can be queried to return the trained model ID:
387+
The [**client library SDKs**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#train-your-model) return a model object that can be queried to return the trained model ID:
388388

389389
* C\# | [CustomFormModel Class](/dotnet/api/azure.ai.formrecognizer.training.customformmodel?view=azure-dotnet&preserve-view=true#properties "Azure SDK for .NET")
390390

@@ -398,14 +398,14 @@ The [**REST API**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=tr
398398

399399
#### Compose your custom models
400400

401-
After you've gathered your custom models corresponding to a single form type, you can compose them into a single model.
401+
After you gather your custom models corresponding to a single form type, you can compose them into a single model.
402402

403403
<!-- Applies to FOTT but labeled studio to eliminate tab grouping warning -->
404404
### [**Document Intelligence Sample Labeling tool**](#tab/studio)
405405

406406
The **Sample Labeling tool** enables you to quickly get started training models and composing them to a single model ID.
407407

408-
After you have completed training, compose your models as follows:
408+
After training is complete, compose your models as follows:
409409

410410
1. On the left rail menu, select the **Model Compose** icon (merging arrow).
411411

@@ -445,7 +445,7 @@ Use the programming language code of your choice to create a composed model that
445445

446446
### [**Document Intelligence Sample Labeling tool**](#tab/studio)
447447

448-
1. On the tool's left-pane menu, select the **Analyze icon** (light bulb).
448+
1. On the tool's left-pane menu, select the **`Analyze` icon** (light bulb).
449449

450450
1. Choose a local file or image URL to analyze.
451451

@@ -480,7 +480,7 @@ Test your newly trained models by [analyzing forms](build-a-custom-model.md?view
480480

481481
You can [manage your custom models](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true) throughout their lifecycle by viewing a [list of all custom models](/rest/api/aiservices/document-models/get-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTPs) under your subscription, retrieving information about [a specific custom model](/rest/api/aiservices/document-models/get-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP), and [deleting custom models](/rest/api/aiservices/document-models/delete-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) from your account.
482482

483-
Great! You've learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
483+
Great! You learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
484484

485485
## Next steps
486486

0 commit comments

Comments
 (0)