Skip to content

Commit 8e018b2

Browse files
eric-urbaneric-urban
committed
tabs for disconnected
1 parent b613dc6 commit 8e018b2

File tree

4 files changed

+22
-86
lines changed

4 files changed

+22
-86
lines changed

‎articles/cognitive-services/Speech-Service/speech-container-cstt.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Obtain the **Model ID** to use as the argument to the `ModelId` parameter of the
9191

9292
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container.
9393

94-
# [Container run](#tab/container)
94+
# [Custom speech to text](#tab/container)
9595

9696
The following table represents the various `docker run` parameters and their corresponding descriptions:
9797

@@ -211,7 +211,7 @@ ApiKey={API_KEY}
211211
> [!NOTE]
212212
> If you set more than one query or download parameter, the command will prioritize in this order: `BaseModelLocale`, model ID, and then `DisplayLocale` (only applicable for display models).
213213
214-
# [Disconnected container run](#tab/disconnected)
214+
# [Disconnected custom speech to text](#tab/disconnected)
215215

216216
To run 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) in the Azure Cognitive Services documentation.
217217

@@ -224,7 +224,7 @@ In order to prepare and configure the Custom Speech-to-Text container you will n
224224

225225
Download the docker container and run it to get the required speech model as [described above](#get-the-container-image-with-docker-pull) using the regular Azure Speech resource. Next, you will need to download your disconnected license file.
226226

227-
The `DownloadLicense=True` parameter in your `docker run` command will download a license file that will enable your Docker container to run when it isn't connected to the internet. It also contains an expiration date, after which the license file will be invalid to run the container. You can only use a license file with the appropriate container that you've been approved for. For example, you can't use a license file for a speech-to-text container with a form recognizer container.
227+
The `DownloadLicense=True` parameter in your `docker run` command will download a license file that will enable your Docker container to run when it isn't connected to the internet. It also contains an expiration date, after which the license file will be invalid to run the container. You can only use a license file with the appropriate container that you've been approved for. For example, you can't use a license file for a `speech-to-text` container with a `neural-text-to-speech` container.
228228

229229
| Placeholder | Description |
230230
|-------------|-------|
@@ -249,16 +249,18 @@ Once the license file has been downloaded, you can run the container in a discon
249249

250250
Wherever the container is run, the license file must be mounted to the container and the location of the license folder on the container's local filesystem must be specified with `Mounts:License=`. An output mount must also be specified so that billing usage records can be written.
251251

252-
Placeholder | Value | Format or example |
253-
|-------------|-------|---|
254-
| `{IMAGE}` | The container image you want to use. | `mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice` |
255-
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container. | `4g` |
256-
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container. | `4` |
257-
| `{LICENSE_MOUNT}` | The path where the license will be located and mounted. | `/host/license:/path/to/license/directory` |
252+
| Placeholder | Description |
253+
|-------------|-------|
254+
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/custom-speech-to-text:latest` |
255+
| `{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container.<br/><br/>For example: `4g` |
256+
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container.<br/><br/>For example: `4` |
257+
| `{LICENSE_MOUNT}` | The path where the license will be downloaded, and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |
258+
| `{ENDPOINT_URI}` | The endpoint for authenticating your service request. You can find it on your resource's **Key and endpoint** page, on the Azure portal.<br/><br/>For example: `https://<your-resource-name>.cognitiveservices.azure.com` |
259+
| `{API_KEY}` | The key for your Speech resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |
260+
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem.<br/><br/>For example: `/path/to/license/directory` |
261+
| `{CONTAINER_OUTPUT_DIRECTORY}` | Location of the output folder on the container's local filesystem.<br/><br/>For example: `/path/to/output/directory` |
258262
| `{OUTPUT_PATH}` | The output path for logging.<br/><br/>For example: `/host/output:/path/to/output/directory`<br/><br/>For more information, see [usage records](../containers/disconnected-containers.md#usage-records) in the Azure Cognitive Services documentation. |
259-
| `{MODEL_PATH}` | The path where the model is located. | `/path/to/model/` |
260-
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem. | `/path/to/license/directory` |
261-
| `{CONTAINER_OUTPUT_DIRECTORY}` | Location of the output folder on the container's local filesystem. | `/path/to/output/directory` |
263+
| `{MODEL_PATH}` | The path where the model is located.<br/><br/>For example: `/path/to/model/` |
262264

263265
```bash
264266
docker run --rm -it -p 5000:5000 --memory {MEMORY_SIZE} --cpus {NUMBER_CPUS} \

‎articles/cognitive-services/Speech-Service/speech-container-lid.md

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@ docker pull mcr.microsoft.com/azure-cognitive-services/speechservices/language-d
8080

8181
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container.
8282

83-
# [Container run](#tab/container)
84-
8583
The following table represents the various `docker run` parameters and their corresponding descriptions:
8684

8785
| Parameter | Description |
@@ -108,70 +106,6 @@ This command:
108106
* Exposes TCP port 5003 and allocates a pseudo-TTY for the container.
109107
* Automatically removes the container after it exits. The container image is still available on the host computer.
110108

111-
112-
# [Disconnected container run](#tab/disconnected)
113-
114-
To run 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) in the Azure Cognitive Services documentation.
115-
116-
If you have been approved to run the container disconnected from the internet, the following example shows the formatting of the `docker run` command to use, with placeholder values. Replace these placeholder values with your own values.
117-
118-
The `DownloadLicense=True` parameter in your `docker run` command will download a license file that will enable your Docker container to run when it isn't connected to the internet. It also contains an expiration date, after which the license file will be invalid to run the container. You can only use a license file with the appropriate container that you've been approved for. For example, you can't use a license file for a `speech-to-text` container with a `neural-text-to-speech` container.
119-
120-
| Placeholder | Description |
121-
|-------------|-------|
122-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
123-
| `{LICENSE_MOUNT}` | The path where the license will be downloaded, and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |
124-
| `{ENDPOINT_URI}` | The endpoint for authenticating your service request. You can find it on your resource's **Key and endpoint** page, on the Azure portal.<br/><br/>For example: `https://<your-resource-name>.cognitiveservices.azure.com` |
125-
| `{API_KEY}` | The key for your Speech resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |
126-
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem.<br/><br/>For example: `/path/to/license/directory` |
127-
128-
```bash
129-
docker run --rm -it -p 5000:5000 \
130-
-v {LICENSE_MOUNT} \
131-
{IMAGE} \
132-
eula=accept \
133-
billing={ENDPOINT_URI} \
134-
apikey={API_KEY} \
135-
DownloadLicense=True \
136-
Mounts:License={CONTAINER_LICENSE_DIRECTORY}
137-
```
138-
139-
Once the license file has been downloaded, you can run the container in a disconnected environment. The following example shows the formatting of the `docker run` command you'll use, with placeholder values. Replace these placeholder values with your own values.
140-
141-
Wherever the container is run, the license file must be mounted to the container and the location of the license folder on the container's local filesystem must be specified with `Mounts:License=`. An output mount must also be specified so that billing usage records can be written.
142-
143-
Placeholder | Value | Format or example |
144-
|-------------|-------|---|
145-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
146-
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container.<br/><br/>For example: `4g` |
147-
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container.<br/><br/>For example: `4` |
148-
| `{LICENSE_MOUNT}` | The path where the license will be located and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |
149-
| `{OUTPUT_PATH}` | The output path for logging.<br/><br/>For example: `/host/output:/path/to/output/directory`<br/><br/>For more information, see [usage records](../containers/disconnected-containers.md#usage-records) in the Azure Cognitive Services documentation. |
150-
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem.<br/><br/>For example: `/path/to/license/directory` |
151-
| `{CONTAINER_OUTPUT_DIRECTORY}` | Location of the output folder on the container's local filesystem.<br/><br/>For example: `/path/to/output/directory` |
152-
153-
```bash
154-
docker run --rm -it -p 5003:5003 --memory {MEMORY_SIZE} --cpus {NUMBER_CPUS} \
155-
-v {LICENSE_MOUNT} \
156-
-v {OUTPUT_PATH} \
157-
{IMAGE} \
158-
eula=accept \
159-
Mounts:License={CONTAINER_LICENSE_DIRECTORY}
160-
Mounts:Output={CONTAINER_OUTPUT_DIRECTORY}
161-
```
162-
163-
Speech containers provide a default directory for writing the license file and billing log at runtime. The default directories are /license and /output respectively.
164-
165-
When you're mounting these directories to the container with the `docker run -v` command, make sure the local machine directory is set ownership to `user:group nonroot:nonroot` before running the container.
166-
167-
Below is a sample command to set file/directory ownership.
168-
169-
```bash
170-
sudo chown -R nonroot:nonroot <YOUR_LOCAL_MACHINE_PATH_1> <YOUR_LOCAL_MACHINE_PATH_2> ...
171-
```
172-
173-
---
174-
175109
For more information about `docker run` with Speech containers, see [Install and run Speech containers with Docker](speech-container-howto.md#run-the-container).
176110

177111
## Run with the speech-to-text container

‎articles/cognitive-services/Speech-Service/speech-container-ntts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ docker pull mcr.microsoft.com/azure-cognitive-services/speechservices/neural-tex
7979

8080
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container.
8181

82-
# [Container run](#tab/container)
82+
# [Neural text to speech](#tab/container)
8383

8484
The following table represents the various `docker run` parameters and their corresponding descriptions:
8585

@@ -107,7 +107,7 @@ This command:
107107
* Exposes TCP port 5000 and allocates a pseudo-TTY for the container.
108108
* Automatically removes the container after it exits. The container image is still available on the host computer.
109109

110-
# [Disconnected container run](#tab/disconnected)
110+
# [Disconnected neural text to speech](#tab/disconnected)
111111

112112
To run 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) in the Azure Cognitive Services documentation.
113113

@@ -117,7 +117,7 @@ The `DownloadLicense=True` parameter in your `docker run` command will download
117117

118118
| Placeholder | Description |
119119
|-------------|-------|
120-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
120+
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/neural-text-to-speech:latest` |
121121
| `{LICENSE_MOUNT}` | The path where the license will be downloaded, and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |
122122
| `{ENDPOINT_URI}` | The endpoint for authenticating your service request. You can find it on your resource's **Key and endpoint** page, on the Azure portal.<br/><br/>For example: `https://<your-resource-name>.cognitiveservices.azure.com` |
123123
| `{API_KEY}` | The key for your Speech resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |
@@ -140,7 +140,7 @@ Wherever the container is run, the license file must be mounted to the container
140140

141141
Placeholder | Value | Format or example |
142142
|-------------|-------|---|
143-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
143+
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/neural-text-to-speech:latest` |
144144
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container.<br/><br/>For example: `4g` |
145145
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container.<br/><br/>For example: `4` |
146146
| `{LICENSE_MOUNT}` | The path where the license will be located and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |

‎articles/cognitive-services/Speech-Service/speech-container-stt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ docker pull mcr.microsoft.com/azure-cognitive-services/speechservices/speech-to-
7676

7777
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container.
7878

79-
# [Container run](#tab/container)
79+
# [Speech to text](#tab/container)
8080

8181
The following table represents the various `docker run` parameters and their corresponding descriptions:
8282

@@ -103,7 +103,7 @@ This command:
103103
* Exposes TCP port 5000 and allocates a pseudo-TTY for the container.
104104
* Automatically removes the container after it exits. The container image is still available on the host computer.
105105

106-
# [Disconnected container run](#tab/disconnected)
106+
# [Disconnected speech to text](#tab/disconnected)
107107

108108
To run 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) in the Azure Cognitive Services documentation.
109109

@@ -113,7 +113,7 @@ The `DownloadLicense=True` parameter in your `docker run` command will download
113113

114114
| Placeholder | Description |
115115
|-------------|-------|
116-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
116+
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text:latest` |
117117
| `{LICENSE_MOUNT}` | The path where the license will be downloaded, and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |
118118
| `{ENDPOINT_URI}` | The endpoint for authenticating your service request. You can find it on your resource's **Key and endpoint** page, on the Azure portal.<br/><br/>For example: `https://<your-resource-name>.cognitiveservices.azure.com` |
119119
| `{API_KEY}` | The key for your Speech resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |
@@ -136,7 +136,7 @@ Wherever the container is run, the license file must be mounted to the container
136136

137137
Placeholder | Value | Format or example |
138138
|-------------|-------|---|
139-
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text` |
139+
| `{IMAGE}` | The container image you want to use.<br/><br/>For example: `mcr.microsoft.com/azure-cognitive-services/speech-to-text:latest` |
140140
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container.<br/><br/>For example: `4g` |
141141
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container.<br/><br/>For example: `4` |
142142
| `{LICENSE_MOUNT}` | The path where the license will be located and mounted.<br/><br/>For example: `/host/license:/path/to/license/directory` |

0 commit comments

Comments
 (0)