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

piper: add page #13144

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

piper: add page #13144

wants to merge 1 commit into from

Conversation

socksy
Copy link

@socksy socksy commented Jun 25, 2024

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 1.2.0

@socksy socksy requested a review from spageektti as a code owner June 25, 2024 12:21
@CLAassistant
Copy link

CLAassistant commented Jun 25, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Jun 25, 2024
@tldr-bot

This comment was marked as resolved.

pages/common/piper.md Outdated Show resolved Hide resolved
Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! I have added some suggestions.

@@ -0,0 +1,28 @@
# piper

> A fast, local neural text to speech system that sounds great.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> A fast, local neural text to speech system that sounds great.
> A fast, local neural text to speech system.

This is the self-description of the program.

> A fast, local neural text to speech system that sounds great.
> More information: <https://github.com/rhasspy/piper>.

- Output a wav [f]ile using a [m]odel (assuming config json at path to model_path + .json):
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Output a wav [f]ile using a [m]odel (assuming config json at path to model_path + .json):
- Output a WAV [f]ile using a text-to-speech [m]odel (assuming config json at path to model_path + .json):


`echo {{Thing to say}} | piper -m {{path/to/model.onnx}} -f {{outputfile.wav}}`

- Output a wav [f]ile using a [m]odel and specifying its [c]onfig json:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Output a wav [f]ile using a [m]odel and specifying its [c]onfig json:
- Output a WAV [f]ile using a [m]odel and specifying its [c]onfig json:


`echo {{Thing to say}} | piper -m {{path/to/model.onnx}} -c {{path/to/model.onnx.json}} -f {{outputfile.wav}}`

- Select a particular speaker in a voice with multiple speakers:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Select a particular speaker in a voice with multiple speakers:
- Select a particular speaker in a voice with the specified number of speakers:

Comment on lines +18 to +20
- Stream output immediately to mpv (synthesizing second sentence while first sentence is spoken):

`echo {{'First sentence. Second sentence'}} | piper -m {{en_GB-northern_english_male-medium.onnx}} --output-raw -f - | mpv -`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Stream output immediately to mpv (synthesizing second sentence while first sentence is spoken):
`echo {{'First sentence. Second sentence'}} | piper -m {{en_GB-northern_english_male-medium.onnx}} --output-raw -f - | mpv -`
- Stream the output to the MPV media player:
`echo {{'First sentence. Second sentence'}} | piper -m {{en_GB-northern_english_male-medium.onnx}} --output-raw -f - | mpv -`

Comment on lines +26 to +28
- Download model and config after trying it out on <https://rhasspy.github.io/piper-samples/>:

`export MODEL="{{en_GB-alba-medium}}"; for EXT in .onnx .onnx.json; do curl -L "https://huggingface.co/rhasspy/piper-voices/resolve/main/{{en/en_GB/alba/medium/}}$MODEL$EXT" > $MODEL$EXT; done`
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if I'd keep this example ... After all, this demonstrates how to download files, and not the usage of piper

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants