wyoming-whisper

wyoming-whisper

CONTAINERS IMAGES RUN BUILD

Home Assistant add-on that uses wyoming-faster-whisper for speech-to-text system using the wyoming protocol on NVIDIA Jetson devices. Thank you to @ms1design for contributing these Home Assistant & Wyoming containers!

Features

• Works well with home-assistant-core container on Jetson devices as well as Home Assistant hosted on different hosts
• GPU accelerated on Jetson Devices thanks to faster-whisper container

Requires Home Assistant 2023.9 or later.

docker-compose example

If you want to use docker compose to run Home Assistant Core Voice Assistant Pipeline on a Jetson device with cuda enabled, you can find a full example docker-compose.yaml here.

name: home-assistant-jetson
version: "3.9"
services:
  homeassistant:
    image: dustynv/homeassistant-core:latest-r36.2.0
    restart: unless-stopped
    init: false
    privileged: true
    network_mode: host
    container_name: homeassistant
    hostname: homeassistant
    ports:
      - "8123:8123"
    volumes:
      - ha-config:/config
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro

  whisper:
    image: dustynv/wyoming-whisper:latest-r36.2.0
    restart: unless-stopped
    runtime: nvidia
    network_mode: host
    container_name: faster-whisper
    hostname: faster-whisper
    init: false
    ports:
      - "10300:10300/tcp"
    volumes:
      - ha-whisper-models:/share/whisper
      - ha-whisper-data:/data
      - /etc/localtime:/etc/localtime:ro
      - /etc/timezone:/etc/timezone:ro

volumes:
  ha-config:
  ha-whisper-models:
  ha-whisper-data:

Environment variables

Variable	Type	Default	Description
WHISPER_PORT	str	10300	Port number to use on host
WHISPER_MODEL	str	tiny-int8	Name of faster-whisper model to use from supported models list
WHISPER_BEAM_SIZE	int	1	Beam size
WHISPER_LANGUAGE	str	en	Default language to set for transcription from supported languages list
WHISPER_DEBUG	bool	true	Log DEBUG messages

Configuration

Read more how to configure wyoming-whisper in the official documentation:

TODO's

• Testing

Support

Got questions? You have several options to get them answered:

For general Home Assistant Support:

• The Home Assistant Discord Chat Server.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant
• In case you've found an bug in Home Assistant, please open an issue on our GitHub.

For NVIDIA Jetson based Home Assistant Support:

• The NVIDIA Jetson AI Lab tutorials section.
• The Jetson AI Lab - Home Assistant Integration thread on NVIDIA's Developers Forum.
• In case you've found an bug in jetson-containers, please open an issue on our GitHub.

Note

This project was created by Jetson AI Lab Research Group.

CONTAINERS

wyoming-whisper:latest
Aliases	wyoming-whisper
Requires	L4T ['>=34.1.0']
Dependencies	build-essential homeassistant-base cuda cudnn python:3.11 cmake ctranslate2 huggingface_hub numpy faster-whisper
Dockerfile	Dockerfile
Images	dustynv/wyoming-whisper:latest-r36.2.0 (2024-04-30, 5.2GB)
Notes	The faster-whisper using the wyoming protocol for usage with Home Assistant. Based on https://github.com/home-assistant/addons/blob/master/whisper/Dockerfile

CONTAINER IMAGES

Repository/Tag	Date	Arch	Size
dustynv/wyoming-whisper:latest-r36.2.0	2024-04-30	arm64	5.2GB
dustynv/wyoming-whisper:r36.2.0	2024-04-24	arm64	5.2GB

_{Container images are compatible with other minor versions of JetPack/L4T:
    • L4T R32.7 containers can run on other versions of L4T R32.7 (JetPack 4.6+)
    • L4T R35.x containers can run on other versions of L4T R35.x (JetPack 5.1+)}

RUN CONTAINER

To start the container, you can use jetson-containers run and autotag, or manually put together a docker run command:

# automatically pull or build a compatible container image
jetson-containers run $(autotag wyoming-whisper)

# or explicitly specify one of the container images above
jetson-containers run dustynv/wyoming-whisper:latest-r36.2.0

# or if using 'docker run' (specify image and mounts/ect)
sudo docker run --runtime nvidia -it --rm --network=host dustynv/wyoming-whisper:latest-r36.2.0

^{jetson-containers run forwards arguments to docker run with some defaults added (like --runtime nvidia, mounts a /data cache, and detects devices)
autotag finds a container image that's compatible with your version of JetPack/L4T - either locally, pulled from a registry, or by building it.}

To mount your own directories into the container, use the -v or --volume flags:

jetson-containers run -v /path/on/host:/path/in/container $(autotag wyoming-whisper)

To launch the container running a command, as opposed to an interactive shell:

jetson-containers run $(autotag wyoming-whisper) my_app --abc xyz

You can pass any options to it that you would to docker run, and it'll print out the full command that it constructs before executing it.

BUILD CONTAINER

If you use autotag as shown above, it'll ask to build the container for you if needed. To manually build it, first do the system setup, then run:

jetson-containers build wyoming-whisper

The dependencies from above will be built into the container, and it'll be tested during. Run it with --help for build options.