Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Voice chapter 9 blog upload #37449

Merged
merged 5 commits into from
Feb 13, 2025
Merged

Conversation

googanhiem
Copy link
Contributor

@googanhiem googanhiem commented Feb 13, 2025

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features

    • Introduced Speech-to-Phrase, a fast, offline voice processing tool for Home Assistant, enabling rapid recognition of specific voice commands on low-end hardware.
  • Documentation

    • Published a detailed post outlining the tool’s capabilities, supported commands, limitations, and future improvements, encouraging community collaboration to enhance voice command functionalities.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 13, 2025
Copy link

netlify bot commented Feb 13, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit f7a4fe2
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67ae1d01844a8d000865a571
😎 Deploy Preview https://deploy-preview-37449--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

📝 Walkthrough

Walkthrough

A new markdown post has been added that outlines the Speech-to-Phrase tool. The document describes an offline speech processing tool tailored for low-end hardware in Home Assistant environments. It details how the tool uses a limited set of pre-trained phrases to rapidly recognize voice commands for home automation, lists supported and unsupported commands, and explains the potential for community-driven customizations and future enhancements.

Changes

File(s) Change Summary
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown Added a post detailing the Speech-to-Phrase tool, including its offline processing, limited phrase recognition, supported commands for home automation, and community engagement.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as Microphone/Input
    participant SP as Speech-to-Phrase Module
    participant HA as Home Assistant
    U->>M: Speak voice command
    M->>SP: Transmit audio input
    SP->>SP: Process audio offline (match against pre-trained phrases)
    alt Command recognized
        SP->>HA: Trigger corresponding home automation action
    else Command not recognized
        SP->>U: Provide no-match feedback
    end
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (2)

30-30: Add missing commas for better readability.

Several sentences would benefit from proper comma placement.

Apply these changes:

  • Line 30: "To run this software, you needed..."
  • Line 46: "Really, any commands that..."
  • Line 95: "Thanks, Allen!"
  • Line 107: "Previously, Assist could only..."
  • Line 118: "You can provide the opening sentence, and via..."

Also applies to: 46-46, 95-95, 107-107, 118-118

🧰 Tools
🪛 LanguageTool

[typographical] ~30-~30: It seems that a comma is missing.
Context: ...program introduced in 1997. To run this software you needed at least a 133 MHz Pentium p...

(IN_ORDER_TO_VB_COMMA)


110-110: Remove trailing punctuation from headings.

According to markdown style guidelines, headings should not end with punctuation marks.

Apply these changes:

-## Home Assistant phones home: analog phones are back!
+## Home Assistant phones home: analog phones are back

-## 🫵 Help us bring choice to voice!
+## 🫵 Help us bring choice to voice

Also applies to: 132-132

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

110-110: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2790b2e and 2a7f316.

⛔ Files ignored due to path filters (4)
  • source/images/blog/2025-02-voice-chapter-9/art.jpg is excluded by !**/*.jpg
  • source/images/blog/2025-02-voice-chapter-9/green-pe.png is excluded by !**/*.png
  • source/images/blog/2025-02-voice-chapter-9/shared-history.png is excluded by !**/*.png
  • source/images/blog/2025-02-voice-chapter-9/stp-logo.jpg is excluded by !**/*.jpg
📒 Files selected for processing (1)
  • source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown

[typographical] ~30-~30: It seems that a comma is missing.
Context: ...program introduced in 1997. To run this software you needed at least a 133 MHz Pentium p...

(IN_ORDER_TO_VB_COMMA)


[formatting] ~46-~46: Insert a comma after “Really,”.
Context: ...oadcasts are not usable out of the box. Really any commands that can accept random wor...

(INTRODUCTORY_PHRASE_MISSING_COMMA)


[formatting] ~95-~95: Insert a comma after ‘Thanks’.
Context: ...t home will be ready to be integrated. Thanks Allen! ## Expanding Voice Capabilities...

(SENT_START_THANKS_COMMA)


[uncategorized] ~107-~107: Possible missing comma found.
Context: ...ure to 19 degrees" Previously Assist could only tell you the temperat...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~118-~118: Possible missing comma found.
Context: ...l. You can provide the opening sentence and via a new "extra system prompt" option,...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 markdownlint-cli2 (0.17.2)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown

102-102: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


110-110: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)


132-132: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (2)

1-11: LGTM! Frontmatter is well-structured.

The frontmatter contains all required fields with appropriate values.


13-28: LGTM! Introduction and TOC are well-organized.

The introduction effectively sets context with embedded video and relevant links. The table of contents provides clear navigation.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (2)

110-110: Remove trailing punctuation from headings.

According to markdown style guidelines, headings should not end with punctuation marks.

Apply this diff:

-## Home Assistant phones home: analog phones are back!
+## Home Assistant phones home: analog phones are back
-## 🫵 Help us bring choice to voice!
+## 🫵 Help us bring choice to voice

Also applies to: 132-132

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

110-110: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)


30-30: Add missing commas for improved readability.

Several sentences would benefit from additional commas for better flow and clarity.

Apply this diff:

-To run this software you needed at least
+To run this software, you needed at least
-Really any commands that can accept
+Really, any commands that can accept
-Thanks Allen!
+Thanks, Allen!
-Previously Assist could only tell
+Previously, Assist could only tell
-Also since the user needs
+Also, since the user needs
-You can provide the opening sentence and via
+You can provide the opening sentence, and via

Also applies to: 46-46, 95-95, 107-107, 114-114, 118-118

🧰 Tools
🪛 LanguageTool

[typographical] ~30-~30: It seems that a comma is missing.
Context: ...program introduced in 1997. To run this software you needed at least a 133 MHz Pentium p...

(IN_ORDER_TO_VB_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2a7f316 and f7a4fe2.

📒 Files selected for processing (1)
  • source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown

[typographical] ~30-~30: It seems that a comma is missing.
Context: ...program introduced in 1997. To run this software you needed at least a 133 MHz Pentium p...

(IN_ORDER_TO_VB_COMMA)


[formatting] ~46-~46: Insert a comma after “Really,”.
Context: ...oadcasts are not usable out of the box. Really any commands that can accept random wor...

(INTRODUCTORY_PHRASE_MISSING_COMMA)


[formatting] ~95-~95: Insert a comma after ‘Thanks’.
Context: ...t home will be ready to be integrated. Thanks Allen! ## Expanding Voice Capabilities...

(SENT_START_THANKS_COMMA)


[uncategorized] ~107-~107: Possible missing comma found.
Context: ...ure to 19 degrees" Previously Assist could only tell you the temperat...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~114-~114: Possible missing comma found.
Context: ...in the living room, but not the office. Also since the user needs to pick up the hor...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~118-~118: Possible missing comma found.
Context: ...l. You can provide the opening sentence and via a new "extra system prompt" option,...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 markdownlint-cli2 (0.17.2)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown

102-102: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


110-110: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)


132-132: Trailing punctuation in heading
Punctuation: '!'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown (3)

1-11: LGTM! Frontmatter is well-structured.

All required metadata fields are present and properly formatted.


102-102: Fix heading level for broadcast command section.

The heading level skips from h2 to h4, breaking the document hierarchy.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

102-102: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


44-44:

❓ Verification inconclusive

Verify performance metrics.

Please verify the specific performance claims:

  • "150 milliseconds per command" on Raspberry Pi 5
  • "under a second" on Raspberry Pi 4

🏁 Script executed:

#!/bin/bash
# Search for any benchmark or test results in the codebase
rg -i "benchmark|performance test" --type md

Length of output: 7108


Action Required: Verify and Document Performance Benchmarks

Please confirm that the performance numbers shown in the snippet accurately reflect recent benchmark results. In particular:

  • Verify that a Raspberry Pi 5 processes commands in approximately 150 milliseconds (i.e., seven times faster than the baseline).
  • Confirm that transcription on a Home Assistant Green or Raspberry Pi 4 consistently completes in under one second.

If these figures are based on internal benchmarks (for example, those linked from our LLM benchmark suite), please update the post to reference the source data or adjust the metrics according to the latest results.

Copy link
Contributor Author

@googanhiem googanhiem left a comment

Choose a reason for hiding this comment

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

Ready to go.

@balloob balloob merged commit 10122d7 into home-assistant:current Feb 13, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants