Skip to content

Commit 63b5771

Browse files
authored
Merge pull request #94299 from MicrosoftDocs/release-ignite-cogsvcs-containers-read
Ignite
2 parents eeccb2f + 1669327 commit 63b5771

8 files changed

+31
-283
lines changed

articles/cognitive-services/Computer-vision/computer-vision-how-to-install-containers.md

Lines changed: 12 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,16 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: computer-vision
1010
ms.topic: conceptual
11-
ms.date: 10/03/2019
11+
ms.date: 11/04/2019
1212
ms.author: dapine
1313
ms.custom: seodec18
1414
---
1515

16-
# Install and run Computer Vision containers
16+
# Install and run Read containers
1717

1818
Containers enable you to run the Computer Vision APIs in your own environment. Containers are great for specific security and data governance requirements. In this article you'll learn how to download, install, and run a Computer Vision container.
1919

20-
There are two Docker containers available for Computer Vision: *Recognize Text* and *Read*. The *Recognize Text* container allows you to detect and extract *printed text* from images of various objects with different surfaces and backgrounds, such as receipts, posters, and business cards. The *Read* container, however; also detects *handwritten text* in images and provides PDF/TIFF/multi-page support. For more information, see the [Read API](concept-recognizing-text.md#read-api) documentation.
21-
22-
> [!IMPORTANT]
23-
> The Recognize Text container is being deprecated in favor of the Read container. The Read container is a superset of its predecessor the Recognize Text container, and consumers should migrate to using the Read container. Both containers work only with English.
20+
A single Docker container, *Read*, is available for Computer Vision. The *Read* container allows you to detect and extract *printed text* from images of various objects with different surfaces and backgrounds, such as receipts, posters, and business cards. Additionally, the *Read* container detects *handwritten text* in images and provides PDF, TIFF, and multi-page file support. For more information, see the [Read API](concept-recognizing-text.md#read-api) documentation.
2421

2522
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2623

@@ -36,10 +33,6 @@ You must meet the following prerequisites before using the containers:
3633

3734
[!INCLUDE [Gathering required container parameters](../containers/includes/container-gathering-required-parameters.md)]
3835

39-
## Request access to the private container registry
40-
41-
[!INCLUDE [Request access to public preview](../../../includes/cognitive-services-containers-request-access.md)]
42-
4336
### The host computer
4437

4538
[!INCLUDE [Host Computer requirements](../../../includes/cognitive-services-containers-host-computer.md)]
@@ -50,44 +43,20 @@ You must meet the following prerequisites before using the containers:
5043

5144
## Get the container image with `docker pull`
5245

53-
# [Read](#tab/read)
54-
5546
Container images for Read are available.
5647

5748
| Container | Container Registry / Repository / Image Name |
5849
|-----------|------------|
5950
| Read | `containerpreview.azurecr.io/microsoft/cognitive-services-read:latest` |
6051

61-
# [Recognize Text](#tab/recognize-text)
62-
63-
Container images for Recognize Text are available.
64-
65-
| Container | Container Registry / Repository / Image Name |
66-
|-----------|------------|
67-
| Recognize Text | `containerpreview.azurecr.io/microsoft/cognitive-services-recognize-text:latest` |
68-
69-
***
70-
7152
Use the [`docker pull`](https://docs.docker.com/engine/reference/commandline/pull/) command to download a container image.
7253

73-
# [Read](#tab/read)
74-
7554
### Docker pull for the Read container
7655

7756
```bash
7857
docker pull containerpreview.azurecr.io/microsoft/cognitive-services-read:latest
7958
```
8059

81-
# [Recognize Text](#tab/recognize-text)
82-
83-
### Docker pull for the Recognize Text container
84-
85-
```bash
86-
docker pull containerpreview.azurecr.io/microsoft/cognitive-services-recognize-text:latest
87-
```
88-
89-
***
90-
9160
[!INCLUDE [Tip for using docker list](../../../includes/cognitive-services-containers-docker-list-tip.md)]
9261

9362
## How to use the container
@@ -103,8 +72,6 @@ Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/)
10372

10473
[Examples](computer-vision-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
10574

106-
# [Read](#tab/read)
107-
10875
```bash
10976
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
11077
containerpreview.azurecr.io/microsoft/cognitive-services-read \
@@ -120,25 +87,6 @@ This command:
12087
* Exposes TCP port 5000 and allocates a pseudo-TTY for the container.
12188
* Automatically removes the container after it exits. The container image is still available on the host computer.
12289

123-
# [Recognize Text](#tab/recognize-text)
124-
125-
```bash
126-
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
127-
containerpreview.azurecr.io/microsoft/cognitive-services-recognize-text \
128-
Eula=accept \
129-
Billing={ENDPOINT_URI} \
130-
ApiKey={API_KEY}
131-
```
132-
133-
This command:
134-
135-
* Runs the Recognize Text container from the container image.
136-
* Allocates 8 CPU core and 16 gigabytes (GB) of memory.
137-
* Exposes TCP port 5000 and allocates a pseudo-TTY for the container.
138-
* Automatically removes the container after it exits. The container image is still available on the host computer.
139-
140-
***
141-
14290
More [examples](./computer-vision-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
14391

14492
> [!IMPORTANT]
@@ -156,8 +104,6 @@ The container provides REST-based query prediction endpoint APIs.
156104

157105
Use the host, `http://localhost:5000`, for container APIs.
158106

159-
# [Read](#tab/read)
160-
161107
### Asynchronous read
162108

163109
You can use the `POST /vision/v2.0/read/core/asyncBatchAnalyze` and `GET /vision/v2.0/read/operations/{operationId}` operations in concert to asynchronously read an image, similar to how the Computer Vision service uses those corresponding REST operations. The asynchronous POST method will return an `operationId` that is used as the identifer to the HTTP GET request.
@@ -309,26 +255,19 @@ export interface Line {
309255
words?: Word[] | null;
310256
}
311257

258+
export enum Confidence {
259+
High = 0,
260+
Low = 1
261+
}
262+
312263
export interface Word {
313264
boundingBox?: number[] | null;
314265
text: string;
315-
confidence?: string | null;
266+
confidence?: Confidence | null;
316267
}
317268
```
318269

319-
For an example use-case, see the [TypeScript sandbox here](https://aka.ms/ts-read-api-types) and select "Run" to visualize its ease-of-use.
320-
321-
# [Recognize Text](#tab/recognize-text)
322-
323-
### Asynchronous text recognition
324-
325-
You can use the `POST /vision/v2.0/recognizeText` and `GET /vision/v2.0/textOperations/*{id}*` operations in concert to asynchronously recognize printed text in an image, similar to how the Computer Vision service uses those corresponding REST operations. The Recognize Text container only recognizes printed text, not handwritten text, at this time, so the `mode` parameter normally specified for the Computer Vision service operation is ignored by the Recognize Text container.
326-
327-
### Synchronous text recognition
328-
329-
You can use the `POST /vision/v2.0/recognizeTextDirect` operation to synchronously recognize printed text in an image. Because this operation is synchronous, the request body for this operation is the same as the `POST /vision/v2.0/recognizeText` operation, but the response body for this operation is the same as that returned by the `GET /vision/v2.0/textOperations/*{id}*` operation.
330-
331-
***
270+
For an example use-case, see the <a href="https://aka.ms/ts-read-api-types" target="_blank" rel="noopener noreferrer">TypeScript sandbox here <span class="docon docon-navigate-external x-hidden-focus"></span></a> and select **Run** to visualize its ease-of-use.
332271

333272
## Stop the container
334273

@@ -356,10 +295,10 @@ For more information about these options, see [Configure containers](./computer-
356295

357296
In this article, you learned concepts and workflow for downloading, installing, and running Computer Vision containers. In summary:
358297

359-
* Computer Vision provides a Linux container for Docker, encapsulating both Recognize Text and Read.
298+
* Computer Vision provides a Linux container for Docker, encapsulating Read.
360299
* Container images are downloaded from the "Container Preview" container registry in Azure.
361300
* Container images run in Docker.
362-
* You can use either the REST API or SDK to call operations in Recognize Text or Read containers by specifying the host URI of the container.
301+
* You can use either the REST API or SDK to call operations in Read containers by specifying the host URI of the container.
363302
* You must specify billing information when instantiating a container.
364303

365304
> [!IMPORTANT]

articles/cognitive-services/Computer-vision/computer-vision-resource-container-config.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: computer-vision
1010
ms.topic: conceptual
11-
ms.date: 09/18/2019
11+
ms.date: 11/04/2019
1212
ms.author: dapine
1313
ms.custom: seodec18
1414
---
@@ -101,13 +101,11 @@ Replace {_argument_name_} with your own values:
101101
102102
## Container Docker examples
103103

104-
#### [Read](#tab/read)
105-
106104
The following Docker examples are for the Read container.
107105

108106
### Basic example
109107

110-
```
108+
```docker
111109
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
112110
containerpreview.azurecr.io/microsoft/cognitive-services-read \
113111
Eula=accept \
@@ -117,7 +115,7 @@ The following Docker examples are for the Read container.
117115

118116
### Logging example
119117

120-
```
118+
```docker
121119
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
122120
containerpreview.azurecr.io/microsoft/cognitive-services-read \
123121
Eula=accept \
@@ -126,33 +124,6 @@ The following Docker examples are for the Read container.
126124
Logging:Console:LogLevel:Default=Information
127125
```
128126

129-
#### [Recognize Text](#tab/recognize-text)
130-
131-
The following Docker examples are for the Recognize Text container.
132-
133-
### Basic example
134-
135-
```
136-
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
137-
containerpreview.azurecr.io/microsoft/cognitive-services-recognize-text \
138-
Eula=accept \
139-
Billing={ENDPOINT_URI} \
140-
ApiKey={API_KEY}
141-
```
142-
143-
### Logging example
144-
145-
```
146-
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
147-
containerpreview.azurecr.io/microsoft/cognitive-services-recognize-text \
148-
Eula=accept \
149-
Billing={ENDPOINT_URI} \
150-
ApiKey={API_KEY} \
151-
Logging:Console:LogLevel:Default=Information
152-
```
153-
154-
***
155-
156127
## Next steps
157128

158129
* Review [How to install and run containers](computer-vision-how-to-install-containers.md).

articles/cognitive-services/Computer-vision/deploy-computer-vision-on-container-instances.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: computer-vision
1010
ms.topic: conceptual
11-
ms.date: 7/5/2019
11+
ms.date: 11/04/2019
1212
ms.author: dapine
1313
---
1414

0 commit comments

Comments
 (0)