Skip to content

Commit

Permalink
Merge pull request #2315 from ChamathKB/documentation-fixes
Browse files Browse the repository at this point in the history
updating docker tag to latest in playbook
  • Loading branch information
wasertech authored Dec 9, 2022
2 parents fcec06b + 8909217 commit 2c81b04
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/playbook/ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,11 @@ As you become more proficient with using 🐸STT, you can use the pre-built Dock
**Running this command will download several gigabytes of data. Do not perform this command if you are on a limited or metered internet connection**

```
$ docker pull ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4
v0.10.0-alpha.4: Pulling from coqui-ai/stt-train
$ docker pull ghcr.io/coqui-ai/stt-train:latest
latest: Pulling from coqui-ai/stt-train
Digest: sha256:0f8ee9208874a925618e527f1d06ea9065dd09c700972cba740884e7e7e4cd17
Status: Image is up to date for ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4
ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4
Status: Image is up to date for ghcr.io/coqui-ai/stt-train:latest
ghcr.io/coqui-ai/stt-train:latest
```

<!-- FIXME uncomment once we have CI publishing of these images:
Expand All @@ -175,17 +175,17 @@ You will now see the `ghcr.io/coqui-ai/stt-train` image when you run the command
```
$ docker image ls
REPOSITORY TAG IMAGE ID CREATED SIZE
ghcr.io/coqui-ai/stt-train v0.10.0-alpha.4 d145cb0930ea 37 minutes ago 5.12GB
ghcr.io/coqui-ai/stt-train latest e1ab9313051d 37 minutes ago 5.12GB
``` -->

### Testing the image by creating a container and running a script

Now that you have your Docker image pulled down, you can create a _container_ from the image. Here, we're going to create a container and run a simple test to make sure that the image is working correctly.

_Note that you can refer to Docker images by `id` - such as `7cdc0bb1fe2a` in the example above, or by the image's name and `tag`. Here, we will be using the image name and `tag` - ie `ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4`._
_Note that you can refer to Docker images by `id` - such as `e1ab9313051d` in the example above, or by the image's name and `tag`. Here, we will be using the image name and `tag` - ie `ghcr.io/coqui-ai/stt-train:latest`._

```
$ docker run -it --name stt-test --entrypoint /bin/bash ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4
$ docker run -it --name stt-test --entrypoint /bin/bash ghcr.io/coqui-ai/stt-train:latest
```

The `entrypoint` instruction following `docker run` tells Docker to run the `/bin/bash` (ie shell) after creating the container.
Expand Down Expand Up @@ -282,7 +282,7 @@ As you become more comfortable training speech recognition models with 🐸STT,
# Custom Dockerfile for training models using 🐸STT
# Get the latest 🐸STT image
FROM ghcr.io/coqui-ai/stt-train:v0.10.0-alpha.4
FROM ghcr.io/coqui-ai/stt-train:latest
# Install nano editor
RUN apt-get -y update && apt-get install -y nano
Expand Down

0 comments on commit 2c81b04

Please sign in to comment.