You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
By using containers, you can run _some_ of the Azure Cognitive Services Speech service 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 Speech container.
19
+
The Custom speech-to-text container transcribes real-time speech or batch audio recordings with intermediate results. You can use a custom model that you created in the [Custom Speech portal](https://speech.microsoft.com/customspeech). In this article, you'll learn how to download, install, and run a Custom speech-to-text container.
20
20
21
-
With Speech containers, you can build a speech application architecture that's optimized for both robust cloud capabilities and edge locality. Several containers are available, which use the same [pricing](https://azure.microsoft.com/pricing/details/cognitive-services/speech-services/) as the cloud-based Azure Speech services.
22
-
23
-
## Available Speech containers
21
+
> [!NOTE]
22
+
> You must [request and get approval](speech-container-overview.md#request-approval-to-run-the-container) to use a Speech container.
24
23
24
+
For more information about prerequisites, validating that a container is running, running multiple containers on the same host, and running disconnected containers, see [Install and run Speech containers with Docker](speech-container-howto.md).
25
25
26
-
Using a custom model from the [Custom Speech portal](https://speech.microsoft.com/customspeech), transcribes continuous real-time speech or batch audio recordings into text with intermediate results.
26
+
## Container images
27
27
28
-
The latest supported version is 3.12.0. For all supported versions and locales, see the [Microsoft Container Registry (MCR)](https://mcr.microsoft.com/product/azure-cognitive-services/speechservices/custom-speech-to-text/tags)and [JSON tags](https://mcr.microsoft.com/v2/azure-cognitive-services/speechservices/speech-to-text/tags/list).
28
+
The Custom speech-to-text container image for all supported versions and locales can be found on the [Microsoft Container Registry (MCR)](https://mcr.microsoft.com/product/azure-cognitive-services/speechservices/custom-speech-to-text/tags)syndicate. It resides within the `azure-cognitive-services/speechservices/` repository and is named `custom-speech-to-text`.
29
29
30
-
You need the [prerequisites](speech-container-howto.md#prerequisites).
30
+
:::image type="content" source="./media/containers/mcr-tags-custom-speech-to-text.png" alt-text="A screenshot of the search connectors and triggers dialog." lightbox="./media/containers/mcr-tags-custom-speech-to-text.png":::
31
31
32
-
## Speech container images
32
+
The fully qualified container image name is, `mcr.microsoft.com/azure-cognitive-services/speechservices/custom-speech-to-text`. Either append a specific version or append `:latest` to get the most recent version.
33
33
34
-
The Custom Speech-to-text container image can be found on the `mcr.microsoft.com` container registry syndicate. It resides within the `azure-cognitive-services/speechservices/` repository and is named `custom-speech-to-text`. The fully qualified container image name is `mcr.microsoft.com/azure-cognitive-services/speechservices/custom-speech-to-text`.
To use the latest version of the container, you can use the `latest` tag. You can also find a full list of [tags on the MCR](https://mcr.microsoft.com/product/azure-cognitive-services/speechservices/custom-speech-to-text/tags).
39
+
All tags, except for `latest`, are in the following format and are case sensitive:
> The `locale` and `voice` for custom speech-to-text containers is determined by the custom model ingested by the container.
47
+
48
+
The tags are also available [in JSON format](https://mcr.microsoft.com/v2/azure-cognitive-services/speechservices/custom-speech-to-text/tags/list) for your convenience. The body includes the container path and list of tags. The tags aren't sorted by version, but `"latest"` is always included at the end of the list as shown in this snippet:
You need the [prerequisites](speech-container-howto.md#prerequisites).
45
67
46
68
Use the [docker pull](https://docs.docker.com/engine/reference/commandline/pull/) command to download a container image from Microsoft Container Registry:
> The `locale` and `voice` for custom Speech containers is determined by the custom model ingested by the container.
54
76
55
77
56
-
## Use the container
57
-
58
-
After the container is on the [host computer](speech-container-howto.md#host-computer-requirements-and-recommendations), use the following process to work with the container.
59
-
60
-
1.[Run the container](#run-the-container-with-docker-run) with the required billing settings. More [examples](speech-container-configuration.md#example-docker-run-commands) of the `docker run` command are available.
61
-
1.[Query the container's prediction endpoint](#query-the-containers-prediction-endpoint).
62
-
63
-
## Run the container with docker run
64
-
65
-
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. For more information on how to get the `{Endpoint_URI}` and `{API_Key}` values, see [Gather required parameters](speech-container-howto.md#gather-required-parameters). More [examples](speech-container-configuration.md#example-docker-run-commands) of the `docker run` command are also available.
66
-
67
-
> [!NOTE]
68
-
> For general container requirements, see [Container requirements and recommendations](speech-container-howto.md#container-requirements-and-recommendations).
69
-
78
+
## Get the custom model ID
70
79
71
80
The custom speech-to-text container relies on a Custom Speech model. The custom model has to have been [trained](how-to-custom-speech-train-model.md) by using the [Speech Studio](https://aka.ms/speechstudio/customspeech).
72
81
@@ -78,16 +87,22 @@ Obtain the **Model ID** to use as the argument to the `ModelId` parameter of the
78
87
79
88

80
89
90
+
## Run the container with docker run
91
+
92
+
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container.
93
+
81
94
The following table represents the various `docker run` parameters and their corresponding descriptions:
82
95
83
96
| Parameter | Description |
84
97
|---------|---------|
85
-
|`{VOLUME_MOUNT}`| The host computer [volume mount](https://docs.docker.com/storage/volumes/), which Docker uses to persist the custom model. An example is *C:\CustomSpeech* where the C drive is located on the host machine. |
86
-
|`{MODEL_ID}`| The custom speech model ID. For more information, see [Custom Speech model lifecycle](how-to-custom-speech-model-and-endpoint-lifecycle.md). |
87
-
|`{ENDPOINT_URI}`| The endpoint is required for metering and billing. For more information, see [Gather required parameters](#gather-required-parameters). |
88
-
|`{API_KEY}`| The API key is required. For more information, see [Gather required parameters](#gather-required-parameters). |
98
+
|`{VOLUME_MOUNT}`| The host computer [volume mount](https://docs.docker.com/storage/volumes/), which Docker uses to persist the custom model. An example is `c:\CustomSpeech` where the `c:\` drive is located on the host machine. |
99
+
|`{MODEL_ID}`| The custom speech model ID. For more information, see [Get the custom model ID](#get-the-custom-model-id). |
100
+
|`{ENDPOINT_URI}`| The endpoint is required for metering and billing. For more information, see [billing arguments](speech-container-howto.md#billing-arguments). |
101
+
|`{API_KEY}`| The API key is required. For more information, see [billing arguments](speech-container-howto.md#billing-arguments). |
89
102
90
-
To run the custom speech-to-text container, execute the following `docker run` command:
103
+
When you run the custom speech-to-text container, configure the port, memory, and CPU according to the custom speech-to-text container [requirements and recommendations](speech-container-howto.md#container-requirements-and-recommendations).
104
+
105
+
Here's an example `docker run` command with placeholder values. You must specify the `VOLUME_MOUNT`, `MODEL_ID`, `ENDPOINT_URI`, and `API_KEY` values:
* If the custom model was previously downloaded, the `ModelId` is ignored.
110
125
* Automatically removes the container after it exits. The container image is still available on the host computer.
111
126
112
-
####Base model download on the custom speech-to-text container
127
+
### Base model download on the custom speech-to-text container
113
128
114
-
Starting in v2.6.0 of the custom-speech-to-text container, you can get the available base model information by using option `BaseModelLocale={LOCALE}`. This option gives you a list of available base models on that locale under your billing account. For example:
129
+
You can get the available base model information by using option `BaseModelLocale={LOCALE}`. This option gives you a list of available base models on that locale under your billing account. For example:
115
130
116
131
```bash
117
132
docker run --rm -it \
@@ -145,8 +160,12 @@ Checking available base model for en-us
145
160
2020/10/30 21:54:21 [Fatal] Please run this tool again and assign --modelId '<one above base model id>'. If no model id listed above, it means currently there is no available base model for en-us
146
161
```
147
162
148
-
#### Display model download on the custom speech-to-text container
149
-
Starting in v3.1.0 of the custom-speech-to-text container, you can get the available display models information and choose to download those models into your speech-to-text container to get highly improved final display output.
163
+
### Display model download on the custom speech-to-text container
164
+
165
+
You can get the available display models information and choose to download those models into your speech-to-text container to get highly improved final display output.
166
+
167
+
> [!NOTE]
168
+
> Display model download is available with custom-speech-to-text container version 3.1.0 and later.
150
169
151
170
You can query or download any or all of these display model types: Rescoring (`Rescore`), Punctuation (`Punct`), resegmentation (`Resegment`), and wfstitn (`Wfstitn`). Otherwise, you can use the `FullDisplay` option (with or without the other types) to query or download all types of display models.
152
171
@@ -190,10 +209,10 @@ ApiKey={API_KEY}
190
209
191
210
#### Custom pronunciation on the custom speech-to-text container
192
211
193
-
Starting in v2.5.0 of the custom-speech-to-text container, you can get custom pronunciation results in the output. All you need to do is have your own custom pronunciation rules set up in your custom model and mount the model to a custom-speech-to-text container.
212
+
You can get custom pronunciation results in the output. All you need to do is have your own custom pronunciation rules set up in your custom model and mount the model to a custom-speech-to-text container.
194
213
195
214
> [!IMPORTANT]
196
-
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container. Otherwise, the container won't start. For more information, see [Billing](#billing).
215
+
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container. Otherwise, the container won't start. For more information, see [billing arguments](speech-container-howto.md#billing-arguments).
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/speech-container-howto.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,6 +102,9 @@ The host is an x64-based computer that runs the Docker container. It can be a co
102
102
* A [Kubernetes](https://kubernetes.io/) cluster deployed to [Azure Stack](/azure-stack/operator). For more information, see [Deploy Kubernetes to Azure Stack](/azure-stack/user/azure-stack-solution-template-kubernetes-deploy).
103
103
104
104
105
+
> [!NOTE]
106
+
> Containers support compressed audio input to the Speech SDK by using GStreamer.
107
+
> To install GStreamer in a container, follow Linux instructions for GStreamer in [Use codec compressed audio input with the Speech SDK](how-to-use-codec-compressed-audio-input-streams.md).
105
108
106
109
### Advanced Vector Extension support
107
110
@@ -193,7 +196,7 @@ When you start or run the container, you might experience issues. Use an output
193
196
194
197
Speech containers come with ASP.NET Core logging support. Here's an example of the `neural-text-to-speech container` started with defaut logging to the console:
By using containers, you can run _some_ of the Azure Cognitive Services Speech service 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 Speech container.
20
20
21
-
With Speech containers, you can build a speech application architecture that's optimized for both robust cloud capabilities and edge locality. Several containers are available, which use the same [pricing](https://azure.microsoft.com/pricing/details/cognitive-services/speech-services/) as the cloud-based Azure Speech services.
21
+
> [!NOTE]
22
+
> You must [request and get approval](speech-container-overview.md#request-approval-to-run-the-container) to use a Speech container.
22
23
23
24
## Available Speech containers
24
25
@@ -49,7 +50,7 @@ To use the latest version of the container, you can use the `latest` tag. You ca
49
50
50
51
Use the [docker pull](https://docs.docker.com/engine/reference/commandline/pull/) command to download a container image from Microsoft Container Registry:
If you want to run this container with the speech-to-text container, you can use this [docker image](https://hub.docker.com/r/antsu/on-prem-client). After both containers have been started, use this `docker run` command to execute `speech-to-text-with-languagedetection-client`:
By using containers, you can run _some_ of the Azure Cognitive Services Speech service 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 Speech container.
20
20
21
-
With Speech containers, you can build a speech application architecture that's optimized for both robust cloud capabilities and edge locality. Several containers are available, which use the same [pricing](https://azure.microsoft.com/pricing/details/cognitive-services/speech-services/) as the cloud-based Azure Speech services.
21
+
> [!NOTE]
22
+
> You must [request and get approval](speech-container-overview.md#request-approval-to-run-the-container) to use a Speech container.
22
23
23
24
## Available Speech containers
24
25
@@ -46,7 +47,7 @@ To use the latest version of the container, you can use the `latest` tag. You ca
46
47
47
48
Use the [docker pull](https://docs.docker.com/engine/reference/commandline/pull/) command to download a container image from Microsoft Container Registry:
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/speech-container-overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ By using containers, you can use a subset of the Speech service features in your
23
23
24
24
## Request approval to run the container
25
25
26
-
To use the Speech containers, you must submit a request form and wait for approval. Fill out and submit a [request form](https://aka.ms/csgate) to request access to the container.
26
+
To use the Speech containers, you must submit a request form and wait for approval. Fill out and submit a request form to request access to the container.
27
27
* For connected containers, you must submit [this request form](https://aka.ms/csgate) and wait for approval.
28
28
* For disconnected containers (not connected to the internet), you must submit [this request form](https://aka.ms/csdisconnectedcontainers) and wait for approval. For more information about applying and purchasing a commitment plan to use containers in disconnected environments, see [Use containers in disconnected environments](../containers/disconnected-containers.md#request-access-to-use-containers-in-disconnected-environments).
0 commit comments