Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasnewman authored Oct 15, 2024
1 parent 76b2bad commit 063de6c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,36 @@ string

Provide the text that you want to generate.

## Optional Parameters

`-–duration`

float

Specify the length of the generated audio in seconds.

## Optional Parameters

`-–speed`

float, default: 1.0

Speaking speed modifier, used when an exact duration is not specified.


`--model`

string, default: "lucasnewman/f5-tts-mlx"

Specify a custom model to use for generation. If not provided, the script will use the default model.


`--ref-audio`

string, default: "tests/test_en_1_ref_short.wav"

Provide a reference audio file path to help guide the generation.


`–-ref-text`

string, default: "Some call me nature, others call me mother nature."
Expand Down

0 comments on commit 063de6c

Please sign in to comment.