github/ebook2audiobook
1
1
Fork 0
mirror of https://github.com/DrewThomasson/ebook2audiobook.git synced 2026-01-10 06:18:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update --help output command in readme

Browse Source
This commit is contained in:
Drew Thomasson
2025-06-13 17:20:44 -04:00
committed by GitHub
parent 6cf448502d
commit 3549a45852
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -238,7 +238,7 @@ to let the web page reconnect to the new connection socket.**
usage: app.py [-h] [--session SESSION] [--share] [--headless] [--ebook EBOOK]
[--ebooks_dir EBOOKS_DIR] [--language LANGUAGE] [--voice VOICE]
[--device {cpu,gpu,mps}]
[--tts_engine {xtts,bark,vits,fairseq,yourtts}]
[--tts_engine {xtts,bark,vits,fairseq,tacotron,yourtts}]
[--custom_model CUSTOM_MODEL] [--fine_tuned FINE_TUNED]
[--output_format OUTPUT_FORMAT] [--temperature TEMPERATURE]
[--length_penalty LENGTH_PENALTY] [--num_beams NUM_BEAMS]
@@ -277,8 +277,8 @@ optional parameters:
--device {cpu,gpu,mps}
(Optional) Pprocessor unit type for the conversion.
Default is set in ./lib/conf.py if not present. Fall back to CPU if GPU not available.
--tts_engine {xtts,bark,vits,fairseq,yourtts}
(Optional) Preferred TTS engine (available are: ['xtts', 'bark', 'vits', 'fairseq', 'yourtts'].
--tts_engine {xtts,bark,vits,fairseq,tacotron,yourtts}
(Optional) Preferred TTS engine (available are: ['xtts', 'bark', 'vits', 'fairseq', 'tacotron', 'yourtts'].
Default depends on the selected language. The tts engine should be compatible with the chosen language
--custom_model CUSTOM_MODEL
(Optional) Path to the custom model zip file cntaining mandatory model files.
@@ -311,10 +311,10 @@ optional parameters:
Default to config.json model.
--text_temp TEXT_TEMP
(bark only, optional) Text Temperature for the model.
Default to 0.88. Higher temperatures lead to more creative outputs.
Default to 0.4. Higher temperatures lead to more creative outputs.
--waveform_temp WAVEFORM_TEMP
(bark only, optional) Waveform Temperature for the model.
Default to 0.88. Higher temperatures lead to more creative outputs.
Default to 0.4. Higher temperatures lead to more creative outputs.
--output_dir OUTPUT_DIR
(Optional) Path to the output directory. Default is set in ./lib/conf.py
--version Show the version of the script and exit
@@ -331,12 +331,13 @@ Linux/Mac:
Headless mode:
./ebook2audiobook.sh --headless --ebook '/path/to/file'
Tip: to add of silence (1.4 seconds) into your text just use "###" or "[pause]".
Tip: to add of silence (2 seconds) into your text just use "###" or "[pause]".
```
NOTE: in gradio/gui mode, to cancel a running conversion, just click on the [X] from the ebook upload component.
TIP: if it needs some more pauses, just add '###' or '[pause]' between the words you wish more pause. one [pause] equals to 1.4 seconds
TIP: if it needs some more pauses, just add '###' or '[pause]' between the words you wish more pause. one [pause] equals to 2 seconds
#### Docker GPU Options