docs: clarify --ref_audio needs an absolute path#1304
Open
moduvoice wants to merge 1 commit into
Open
Conversation
Relative paths are resolved against the installed f5_tts package directory, not the caller's cwd, causing a confusing doubled-path FileNotFoundError. No code/behavior change. Verified on Tesla T4 16GB (driver 550.163.01, torch 2.8.0+cu128): absolute path works immediately, reproduced 2x.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Following the README's CLI example verbatim, but passing a relative path for
--ref_audio(the same convention the repo's own bundledinfer/examples/basic/basic.tomluses:ref_audio = "infer/examples/basic/basic_ref_en.wav"), fails:The path gets doubled —
preprocess_ref_audio_text()resolves the given path relative to the installedf5_ttspackage directory, not the caller's working directory. An absolute path works immediately with no other change:Fix
--ref_audio(and other file-path CLI args) should be given as an absolute path, since relative paths resolve against the installed package directory rather than the current working directory.No code/behavior change — this is a documentation-only clarification.
Verification (Tesla T4 16GB)
Reproduced twice with the fix (absolute path) applied, using the maintainer's own bundled example (
infer/examples/basic/basic.tomlvalues):Peak VRAM: 1.625 GB (comfortably fits Tesla T4's 16GB, ~90% headroom).
Environment: Tesla T4 16GB · driver 550.163.01 (CUDA 12.4) · Python 3.10.12 · torch 2.8.0+cu128 (the README-pinned
cu128wheel works fine on this driver — no CUDA-version mismatch here).Also confirmed the model's own dtype auto-selection (
load_checkpoint()pickingtorch.float16whentorch.cuda.get_device_properties(device).major >= 7) already does the right thing on Turing/T4 — no change needed there, this PR is scoped to the path-resolution documentation gap only.Raw metrics JSON
{ "run1": {"gen_time_s": 4.43, "wall_time_s": 16.263, "output_duration_s": 11.24, "sample_rate": 24000}, "run2": {"gen_time_s": 4.50, "wall_time_s": 16.316, "output_duration_s": 11.24, "sample_rate": 24000}, "peak_vram_mib": 1625, "gpu": "Tesla T4", "driver": "550.163.01", "torch": "2.8.0+cu128" }