Skip to content

Commit

Permalink
Add docs for method parameter.
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasnewman committed Oct 31, 2024
1 parent b474331 commit fdcc956
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions f5_tts_mlx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,30 @@ float

Specify the length of the generated audio in seconds.


`--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."

Provide a caption for the reference audio.


`--output`

string, default: "output.wav"
Expand All @@ -55,21 +50,24 @@ float, default: 2.0

Specifies the strength used for classifier free guidance

`--method`

str, default: "euler"

Specify the sampling method for the ODE. Options are "euler" and "midpoint".

`--steps`

int, default: 32

Specify the number of steps used to sample the neural ODE. Lower steps trade off quality for latency.


`--sway-coef`

float, default: -1.0

Set the sway sampling coefficient. The best values according to the paper are in the range of [-1.0...1.0].


`--seed`

int, default: None (random)
Expand Down

0 comments on commit fdcc956

Please sign in to comment.