Skip to content

docs: clarify transcription example setup#5600

Open
AdamMomen wants to merge 1 commit intolivekit:mainfrom
AdamMomen:docs/clarify-transcription-example
Open

docs: clarify transcription example setup#5600
AdamMomen wants to merge 1 commit intolivekit:mainfrom
AdamMomen:docs/clarify-transcription-example

Conversation

@AdamMomen
Copy link
Copy Markdown

Summary

Updates the transcription examples README to cover both available examples:

  • transcriber.py for single-participant transcription
  • multi-user-transcriber.py for transcribing multiple remote participants

The README now includes:

  • the STT setup used by each example
  • uv run commands for both examples
  • the expected log output shape for the multi-user transcriber
  • a short troubleshooting checklist for common setup issues

This also makes two small updates to multi-user-transcriber.py:

  • avoid raising KeyError if a participant disconnects before a session is stored
  • log the room name when the multi-user transcriber starts

Testing

UV_CACHE_DIR=.uv-cache uv tool run ruff format examples/other/transcription/multi-user-transcriber.py
UV_CACHE_DIR=.uv-cache uv tool run ruff check examples/other/transcription/multi-user-transcriber.py
python3 -m py_compile examples/other/transcription/multi-user-transcriber.py
git diff --check

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 29, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants