Adds comprehensive README documentation #70
Conversation
Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK. The README includes: - Quick start instructions for installation and basic usage - Information on key features, use cases, and integration examples - Documentation links and migration guides - Information about Speechmatics technology - Links to resources and community support
Updates the README to remove bold formatting from the "Full Migration Guides" section. This improves the visual consistency of the document and avoids unnecessary emphasis on the links.
README.md
Outdated
| language="en", | ||
| diarization="speaker", | ||
| speaker_diarization_config={ | ||
| "max_speakers": 4 |
There was a problem hiding this comment.
not sure that max speakers works with batch? Didnt work for me anyway.
There was a problem hiding this comment.
replaced with prefer current speaker instead
| asyncio.run(main()) | ||
| ``` | ||
|
|
||
| ### Custom Dictionary |
There was a problem hiding this comment.
This code doesnt ouput anything - but I am sure people can work it out
There was a problem hiding this comment.
Have chnaged all examples to be fully working
README.md
Outdated
| # Access translations | ||
| if result.translations: | ||
| for lang_code, translation_data in result.translations.items(): | ||
| translated_text = translation_data.get("content", "") |
There was a problem hiding this comment.
.get didnt work here? I think it should be translation_data[0].get...
| ) | ||
|
|
||
| # Configure Speechmatics TTS | ||
| tts = SpeechmaticsTTSService( |
| ## 💡 Use Cases | ||
|
|
||
|
|
||
| ### Healthcare & Medical |
There was a problem hiding this comment.
this should use the medical domain?
Refactors the examples in the README to use environment variables for the API key and includes an async close on the client in the batch example. Also adds prefer_current_speaker to the speaker diarization config example.
Enhances the README with detailed examples for batch, realtime, TTS, and voice agent functionalities. Also, includes installation instructions, key features, and use cases for the Speechmatics Python SDK.
LArmstrongDev
left a comment
LArmstrongDev
left a comment
There was a problem hiding this comment.
Overall, looks good! Most of my comments are small things to polish and ensure high quality.
My comments cover a few common themes, especially:
- Layout - making sure to use content nested under headers appropriately, and considering adding in a list at the top of a section, then going into further details - since it's really hard to navigate through information in some of the longer sections (especially with code snippets too!)
- Capitalisation - need to have a consistent approach for capitalisation of headers.
- Speech-to-text vs Speech to text
- Code comments - let's make sure the code examples include suitable comments to make it easy to understand at a glance and demonstrate good programming practices.
README.md
Outdated
|
|
||
| ## 📋 Table of Contents | ||
|
|
||
| - [Quick Start](#quick-start) |
There was a problem hiding this comment.
You also need to update the corresponding header itself.
|
Also, not related to your changes, but I spotted a formatting issue you could also fix up easily. In the "Migrating from speechmatics-python?" section, the could you change the Tick button emoji points to actually be bullet points? They could also include the emoji too. ( e.g. - Tick button ...) Thanks. |
Updates the README to include more detailed examples for batch transcription, realtime streaming, text-to-speech, and voice agent functionalities. Adds sections on key features like speaker diarization, custom dictionaries, audio intelligence, and translation with corresponding code snippets. Provides information on framework integrations, focusing on LiveKit Agents and Pipecat AI, improving user understanding and adoption.
Introduces a detailed README file to provide users with a comprehensive guide to the Speechmatics Python SDK.
The README includes: