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
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/speech-container-howto-on-premises.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
2
title: Use Speech service containers with Kubernetes and Helm
3
3
titleSuffix: Azure AI services
4
-
description: Using Kubernetes and Helm to define the speech to text and text to speech container images, we'll create a Kubernetes package. This package will be deployed to a Kubernetes cluster on-premises.
4
+
description: Using Kubernetes and Helm to define the speech to text and text to speech container images, we create a Kubernetes package. This package is deployed to a Kubernetes cluster on-premises.
5
5
author: eric-urban
6
6
manager: nitinme
7
7
ms.service: azure-ai-speech
8
8
ms.topic: how-to
9
-
ms.date: 07/22/2021
9
+
ms.date: 1/22/2024
10
10
ms.author: eur
11
11
---
12
12
13
13
# Use Speech service containers with Kubernetes and Helm
14
14
15
-
One option to manage your Speech containers on-premises is to use Kubernetes and Helm. Using Kubernetes and Helm to define the speech to text and text to speech container images, we'll create a Kubernetes package. This package will be deployed to a Kubernetes cluster on-premises. Finally, we'll explore how to test the deployed services and various configuration options. For more information about running Docker containers without Kubernetes orchestration, see [install and run Speech service containers](speech-container-howto.md).
15
+
One option to manage your Speech containers on-premises is to use Kubernetes and Helm. Using Kubernetes and Helm to define the speech to text and text to speech container images, we create a Kubernetes package. This package is deployed to a Kubernetes cluster on-premises. Finally, we explore how to test the deployed services and various configuration options. For more information about running Docker containers without Kubernetes orchestration, see [install and run Speech service containers](speech-container-howto.md).
16
16
17
17
## Prerequisites
18
18
@@ -21,14 +21,14 @@ The following prerequisites before using Speech containers on-premises:
21
21
| Required | Purpose |
22
22
|----------|---------|
23
23
| Azure Account | If you don't have an Azure subscription, create a [free account][free-azure-account] before you begin. |
24
-
| Container Registry access | In order for Kubernetes to pull the docker images into the cluster, it will need access to the container registry. |
24
+
| Container Registry access | In order for Kubernetes to pull the docker images into the cluster, it needs access to the container registry. |
25
25
| Kubernetes CLI | The [Kubernetes CLI][kubernetes-cli] is required for managing the shared credentials from the container registry. Kubernetes is also needed before Helm, which is the Kubernetes package manager. |
26
26
| Helm CLI | Install the [Helm CLI][helm-install], which is used to install a helm chart (container package definition). |
27
27
|Speech resource |In order to use these containers, you must have:<br><br>A _Speech_ Azure resource to get the associated billing key and billing endpoint URI. Both values are available on the Azure portal's **Speech** Overview and Keys pages and are required to start the container.<br><br>**{API_KEY}**: resource key<br><br>**{ENDPOINT_URI}**: endpoint URI example is: `https://eastus.api.cognitive.microsoft.com/sts/v1.0`|
28
28
29
29
## The recommended host computer configuration
30
30
31
-
Refer to the [Speech service container host computer][speech-container-host-computer] details as a reference. This *helm chart* automatically calculates CPU and memory requirements based on how many decodes (concurrent requests) that the user specifies. Additionally, it will adjust based on whether optimizations for audio/text input are configured as `enabled`. The helm chart defaults to, two concurrent requests and disabling optimization.
31
+
Refer to the [Speech service container host computer][speech-container-host-computer] details as a reference. This *helm chart* automatically calculates CPU and memory requirements based on how many decodes (concurrent requests) that the user specifies. Additionally, it adjusts based on whether optimizations for audio/text input are configured as `enabled`. The helm chart defaults to, two concurrent requests and disabling optimization.
32
32
33
33
| Service | CPU / Container | Memory / Container |
34
34
|--|--|--|
@@ -41,13 +41,13 @@ The host computer is expected to have an available Kubernetes cluster. See this
41
41
42
42
## Configure Helm chart values for deployment
43
43
44
-
Visit the [Microsoft Helm Hub][ms-helm-hub] for all the publicly available helm charts offered by Microsoft. From the Microsoft Helm Hub, you'll find the **Azure AI Speech On-Premises Chart**. The **Azure AI Speech On-Premises** is the chart we'll install, but we must first create an `config-values.yaml` file with explicit configurations. Let's start by adding the Microsoft repository to our Helm instance.
44
+
Visit the [Microsoft Helm Hub][ms-helm-hub] for all the publicly available helm charts offered by Microsoft. From the Microsoft Helm Hub, you find the **Azure AI Speech On-Premises Chart**. The **Azure AI Speech On-Premises** is the chart we install, but we must first create an `config-values.yaml` file with explicit configurations. Let's start by adding the Microsoft repository to our Helm instance.
45
45
46
46
```console
47
47
helm repo add microsoft https://microsoft.github.io/charts/repo
48
48
```
49
49
50
-
Next, we'll configure our Helm chart values. Copy and paste the following YAML into a file named `config-values.yaml`. For more information on customizing the **Azure AI Speech On-Premises Helm Chart**, see [customize helm charts](#customize-helm-charts). Replace the `# {ENDPOINT_URI}` and `# {API_KEY}` comments with your own values.
50
+
Next, we configure our Helm chart values. Copy and paste the following YAML into a file named `config-values.yaml`. For more information on customizing the **Azure AI Speech On-Premises Helm Chart**, see [customize helm charts](#customize-helm-charts). Replace the `# {ENDPOINT_URI}` and `# {API_KEY}` comments with your own values.
51
51
52
52
```yaml
53
53
# These settings are deployment specific and users can provide customizations
@@ -97,15 +97,15 @@ The provided *Helm charts* pull the docker images of the Speech service, both te
97
97
98
98
## Install the Helm chart on the Kubernetes cluster
99
99
100
-
To install the *helm chart* we'll need to execute the [`helm install`][helm-install-cmd] command, replacing the `<config-values.yaml>` with the appropriate path and file name argument. The `microsoft/cognitive-services-speech-onpremise` Helm chart referenced below is available on the [Microsoft Helm Hub here][ms-helm-hub-speech-chart].
100
+
Run the [`helm install`][helm-install-cmd] command to install the helm chart, replacing the `<config-values.yaml>` with the appropriate path and file name argument. The `microsoft/cognitive-services-speech-onpremise` Helm chart is available on the [Microsoft Helm Hub][ms-helm-hub-speech-chart].
The installed Helm charts define *Helm tests*, which serve as a convenience for verification. These tests validate service readiness. To verify both **speech to text** and **text to speech** services, we'll execute the [Helm test][helm-test] command.
185
+
The installed Helm charts define *Helm tests*, which serve as a convenience for verification. These tests validate service readiness. To verify both **speech to text** and **text to speech** services, we execute the [Helm test][helm-test] command.
186
186
187
187
```console
188
188
helm test onprem-speech
@@ -191,7 +191,7 @@ helm test onprem-speech
191
191
> [!IMPORTANT]
192
192
> These tests will fail if the POD status is not `Running` or if the deployment is not listed under the `AVAILABLE` column. Be patient as this can take over ten minutes to complete.
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/speech-container-howto.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ author: eric-urban
6
6
manager: nitinme
7
7
ms.service: azure-ai-speech
8
8
ms.topic: how-to
9
-
ms.date: 04/18/2023
9
+
ms.date: 1/22/2024
10
10
ms.author: eur
11
11
keywords: on-premises, Docker, container
12
12
---
13
13
14
14
# Install and run Speech containers with Docker
15
15
16
-
By using containers, you can use a subset of the Speech service features in your own environment. In this article, you'll learn how to download, install, and run a Speech container.
16
+
By using containers, you can use a subset of the Speech service features in your own environment. In this article, you learn how to download, install, and run a Speech container.
17
17
18
18
> [!NOTE]
19
19
> Disconnected container pricing and commitment tiers vary from standard containers. For more information, see [Speech service pricing](https://azure.microsoft.com/pricing/details/cognitive-services/speech-services/).
@@ -29,13 +29,13 @@ You must meet the following prerequisites before you use Speech service containe
29
29
30
30
### Billing arguments
31
31
32
-
Speech containers aren't licensed to run without being connected to Azure for metering. You must configure your container to communicate billing information with the metering service at all times.
32
+
Speech containers aren't licensed to run without being connected to Azure for metering. You must configure your container to communicate billing information with the metering service always.
33
33
34
34
Three primary parameters for all Azure AI containers are required. The Microsoft Software License Terms must be present with a value of **accept**. An Endpoint URI and API key are also needed.
35
35
36
36
Queries to the container are billed at the pricing tier of the Azure resource that's used for the `ApiKey` parameter.
37
37
38
-
The <ahref="https://docs.docker.com/engine/reference/commandline/run/"target="_blank">`docker run` <spanclass="docon docon-navigate-external x-hidden-focus"></span></a> command will start the container when all three of the following options are provided with valid values:
38
+
The <ahref="https://docs.docker.com/engine/reference/commandline/run/"target="_blank">`docker run` <spanclass="docon docon-navigate-external x-hidden-focus"></span></a> command starts the container when all three of the following options are provided with valid values:
39
39
40
40
| Option | Description |
41
41
|--------|-------------|
@@ -67,7 +67,7 @@ Core and memory correspond to the `--cpus` and `--memory` settings, which are us
67
67
68
68
> [!NOTE]
69
69
> The minimum and recommended allocations are based on Docker limits, *not* the host machine resources.
70
-
> For example, speech to text containers memory map portions of a large language model. We recommend that the entire file should fit in memory. You need to add an additional 4 to 8 GB to load the speech models (see above table).
70
+
> For example, speech to text containers memory map portions of a large language model. We recommend that the entire file should fit in memory. You need to add an additional 4 to 8 GB to load the speech models (see the previous table).
71
71
> Also, the first run of either container might take longer because models are being paged into memory.
72
72
73
73
## Host computer requirements and recommendations
@@ -99,8 +99,8 @@ Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/)
99
99
100
100
Take note the following best practices with the `docker run` command:
101
101
102
-
-**Line-continuation character**: The Docker commands in the following sections use the back slash, `\`, as a line continuation character. Replace or remove this based on your host operating system's requirements.
103
-
-**Argument order**: Do not change the order of the arguments unless you are familiar with Docker containers.
102
+
-**Line-continuation character**: The Docker commands in the following sections use the back slash, `\`, as a line continuation character. Replace or remove this character based on your host operating system's requirements.
103
+
-**Argument order**: Don't change the order of the arguments unless you're familiar with Docker containers.
104
104
105
105
You can use the [docker images](https://docs.docker.com/engine/reference/commandline/images/) command to list your downloaded container images. The following command lists the ID, repository, and tag of each downloaded container image, formatted as a table:
106
106
@@ -191,7 +191,7 @@ Billing={ENDPOINT_URI} \
191
191
ApiKey={API_KEY}
192
192
```
193
193
194
-
The container will test for network connectivity to the billing endpoint.
194
+
The container tests for network connectivity to the billing endpoint.
The Speech language identification container detects the language spoken in audio files. You can get real-time speech or batch audio recordings with intermediate results. In this article, you'll learn how to download, install, and run a language identification container.
18
+
The Speech language identification container detects the language spoken in audio files. You can get real-time speech or batch audio recordings with intermediate results. In this article, you learn how to download, install, and run a language identification container.
19
19
20
20
> [!NOTE]
21
21
> The Speech language identification container is available in public preview. Containers in preview are still under development and don't meet Microsoft's stability and support requirements.
@@ -64,7 +64,7 @@ The tags are also available [in JSON format](https://mcr.microsoft.com/v2/azure-
64
64
65
65
## Get the container image with docker pull
66
66
67
-
You need the [prerequisites](speech-container-howto.md#prerequisites) including required hardware. Please also see the [recommended allocation of resources](speech-container-howto.md#container-requirements-and-recommendations) for each Speech container.
67
+
You need the [prerequisites](speech-container-howto.md#prerequisites) including required hardware. Also see the [recommended allocation of resources](speech-container-howto.md#container-requirements-and-recommendations) for each Speech container.
68
68
69
69
Use the [docker pull](https://docs.docker.com/engine/reference/commandline/pull/) command to download a container image from Microsoft Container Registry:
70
70
@@ -107,7 +107,7 @@ For more information about `docker run` with Speech containers, see [Install and
107
107
108
108
## Run with the speech to text container
109
109
110
-
If you want to run the language identification container with the [speech to text](speech-container-stt.md) 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`:
110
+
If you want to run the language identification container with the [speech to text](speech-container-stt.md) container, you can use this [docker image](https://hub.docker.com/r/antsu/on-prem-client). After both containers are started, use this `docker run` command to execute `speech-to-text-with-languagedetection-client`:
0 commit comments