Skip to content

Commit 7e59bef

Browse files
Merge pull request #284587 from laujan/update-custom-neural-284582
Update custom neural 284582
2 parents 83401d8 + f09e5d4 commit 7e59bef

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

articles/ai-services/document-intelligence/concept-custom-neural.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
---
22
title: Custom neural document model - Document Intelligence (formerly Form Recognizer)
33
titleSuffix: Azure AI services
4-
description: Use the custom neural document model to train a model to extract data from structured, semistructured, and unstructured documents.
4+
description: Use the custom neural document model to train a model to extract data from structured, semi-structured, and unstructured documents.
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 08/07/2024
9+
ms.date: 08/13/2024
1010
ms.author: lajanuar
1111
ms.custom:
1212
- references_regions
1313
monikerRange: '>=doc-intel-3.0.0'
1414
---
1515

16+
<!-- markdownlint-disable MD001 -->
17+
<!-- markdownlint-disable MD033 -->
18+
<!-- markdownlint-disable MD051 -->
19+
<!-- markdownlint-disable MD024 -->
1620

1721
# Document Intelligence custom neural model
1822

@@ -212,13 +216,13 @@ Custom neural models are available in the [v3.0 and later models](v3-1-migration
212216

213217
| Document Type | REST API | SDK | Label and Test Models|
214218
|--|--|--|--|
215-
| Custom document | [Document Intelligence 3.1](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)| [Document Intelligence SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)| [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio)
219+
| Custom document | [Document Intelligence 3.1](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)| [Document Intelligence SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)| [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio)|
216220

217221
The `Build` operation to train model supports a new ```buildMode``` property, to train a custom neural model, set the ```buildMode``` to ```neural```.
218222

219223
:::moniker range="doc-intel-4.0.0"
220224

221-
```REST
225+
```bash
222226
https://{endpoint}/documentintelligence/documentModels:build?api-version=2024-07-31-preview
223227

224228
{
@@ -237,7 +241,7 @@ https://{endpoint}/documentintelligence/documentModels:build?api-version=2024-07
237241

238242
:::moniker range="doc-intel-3.1.0"
239243

240-
```REST
244+
```bash
241245
https://{endpoint}/formrecognizer/documentModels:build?api-version=v3.1:2023-07-31
242246

243247
{
@@ -256,7 +260,7 @@ https://{endpoint}/formrecognizer/documentModels:build?api-version=v3.1:2023-07-
256260

257261
:::moniker range="doc-intel-3.0.0"
258262

259-
```REST
263+
```bash
260264
https://{endpoint}/formrecognizer/documentModels/{modelId}:copyTo?api-version=2022-08-31
261265

262266
{
@@ -276,8 +280,10 @@ https://{endpoint}/formrecognizer/documentModels/{modelId}:copyTo?api-version=20
276280
:::moniker range="doc-intel-4.0.0"
277281

278282
## Billing
279-
280-
Starting with version `2024-07-31-preview`, you can train your custom neural model for longer durations than 30 minutes. Previous versions have been capped at 30 minutes per training instance, with a total of 20 free training instances per month. Now with `2024-07-31-preview`, you can receive **10 hours** of free model training, and train a model for as long as 10 hours. If you would like to train a model for longer than 10 hours, billing charges are calculated for model trainings that exceed 10 hours. You can choose to spend all of 10 free hours on a single build with a large set of data, or utilize it across multiple builds by adjusting the maximum duration value for the `build` operation by specifying `maxTrainingHours` as below:
283+
284+
Starting with version `2024-07-31-preview`, you can train your custom neural model for longer durations than the standard 30 minutes. Previous versions are limited to 30 minutes per training instance, with a total of 20 free training instances per month. Now with `2024-07-31-preview`, you can receive **10 hours** of **free model training**, and train a model for as long as 10 hours.
285+
286+
You can choose to spend all of 10 free hours on a single model build with a large set of data, or utilize it across multiple builds by adjusting the maximum duration value for the `build` operation by specifying `maxTrainingHours`:
281287

282288
```bash
283289

@@ -288,10 +294,12 @@ POST /documentModels:build
288294
}
289295
```
290296

291-
> [!NOTE]
292-
> For Document Intelligence versions `v3.1 (2023-07-31)` and `v3.0 (2022-08-31)`, custom neural model's paid training is not enabled. For the two older versions, you will get a maximum of 30 minutes training duration per model. If you would like to train more than 20 model instances, you can request for increase in the training limit.
293-
294-
Each training hour is the amount of compute a single V100 GPU can perform in an hour. As each build takes different amount of time, billing is calculated for the actual time spent (excluding time in queue), with a minimum of 30 minutes per training job. The elapsed time is converted to V100 equivalent training hours and reported as part of the model.
297+
> [!IMPORTANT]
298+
>
299+
> * If you would like to train additional neural models or train models for a longer time period that **exceed 10 hours**, billing charges apply. For details on the billing charges, refer to the [pricing page](https://azure.microsoft.com/pricing/details/ai-document-intelligence/).
300+
> * You can opt in for this paid training service by setting the `maxTrainingHours` to the desired maximum number of hours. API calls with no budget but with the `maxTrainingHours` set as over 10 hours will fail.
301+
> * As each build takes different amount of time depending on the type and size of the training dataset, billing is calculated for the actual time spent training the neural model, with a minimum of 30 minutes per training job.
302+
> * This paid billing structure enables you to train larger data sets for longer durations with flexibility in the training hours.
295303
296304
```bash
297305

@@ -304,27 +312,28 @@ GET /documentModels/{myCustomModel}
304312
}
305313
```
306314
307-
This billing structure enables you to train larger data sets for longer durations with flexibility in the training hours.
315+
> [!NOTE]
316+
> For Document Intelligence versions `v3.1 (2023-07-31)` and `v3.0 (2022-08-31)`, custom neural model's paid training is not enabled. For the two older versions, you will get a maximum of 30 minutes training duration per model. If you would like to train more than 20 model instances, you can create an [Azure support ticket](service-limits.md#create-and-submit-support-request) to increase in the training limit.
308317
309318
:::moniker-end
310319
311320
:::moniker range="doc-intel-3.1.0"
312321
313322
## Billing
314323
315-
For Document Intelligence versions `v3.1 (2023-07-31)` and `v3.0 (2022-08-31)`, you will get a maximum of 30 minutes training duration per model, and a maximum of 20 trainings for free per month. If you would like to train more than 20 model instances, you can request for increase in the training limit.
324+
For Document Intelligence versions `v3.1 (2023-07-31) and v3.0 (2022-08-31)`, you receive a maximum 30 minutes of training duration per model, and a maximum of 20 trainings for free per month. If you would like to train more than 20 model instances, you can create an [Azure support ticket](service-limits.md#create-and-submit-support-request) to increase in the training limit. For the Azure support ticket, enter in the `summary` section a phrase such as `Increase Document Intelligence custom neural training (TPS) limit`. A ticket can only apply at a resource-level, not a subscription level. You can request a training limit increase for a single Document Intelligence resource by specifying your resource ID and region in the support ticket.
316325
317-
If you are interested in training models for longer durations than 30 minutes, we support **paid training** for our newest version, `v4.0 (2024-07-31)`. Using the latest version, you can train your model for a longer duration to process larger documents.
326+
If you want to train models for longer durations than 30 minutes, we support **paid training** with our newest version, `v4.0 (2024-07-31-preview)`. Using the latest version, you can train your model for a longer duration to process larger documents. For more information about paid training, *see* [Billing v4.0](service-limits.md#billing).
318327
319328
:::moniker-end
320329
321330
:::moniker range="doc-intel-3.0.0"
322331
323332
## Billing
324333
325-
For Document Intelligence versions `v3.1 (2023-07-31)` and `v3.0 (2022-08-31)`, you will get a maximum of 30 minutes training duration per model, and a maximum of 20 trainings for free per month. If you would like to train more than 20 model instances, you can request for increase in the training limit.
334+
For Document Intelligence versions `v3.1 (2023-07-31) and v3.0 (2022-08-31)`, you receive a maximum 30 minutes of training duration per model, and a maximum of 20 trainings for free per month. If you would like to train more than 20 model instances, you can create an [Azure support ticket](service-limits.md#create-and-submit-support-request) to increase in the training limit. For the Azure support ticket, enter in the `summary` section a phrase such as `Increase Document Intelligence custom neural training (TPS) limit`. A ticket can only apply at a resource-level, not a subscription level. You can request a training limit increase for a single Document Intelligence resource by specifying your resource ID and region in the support ticket.
326335
327-
If you are interested in training models for longer durations than 30 minutes, we support **paid training** for our newest version, `v4.0 (2024-07-31)`. Using the latest version, you can train your model for a longer duration to process larger documents.
336+
If you want to train models for longer durations than 30 minutes, we support **paid training** with our newest version, `v4.0 (2024-07-31)`. Using the latest version, you can train your model for a longer duration to process larger documents. For more information about paid training, *see* [Billing v4.0](service-limits.md#billing).
328337
329338
:::moniker-end
330339

0 commit comments

Comments
 (0)