Update docstring to clarify download_root and output_dir

This commit is contained in:
Guillaume Klein
2023-04-26 17:37:51 +02:00
parent 6f9d68dd6b
commit 89a4c7f1f0
2 changed files with 3 additions and 3 deletions

View File

@@ -101,8 +101,8 @@ class WhisperModel:
having multiple workers enables true parallelism when running the model having multiple workers enables true parallelism when running the model
(concurrent calls to self.model.generate() will run in parallel). (concurrent calls to self.model.generate() will run in parallel).
This can improve the global throughput at the cost of increased memory usage. This can improve the global throughput at the cost of increased memory usage.
download_root: Directory where the model should be saved. If not set, the model download_root: Directory where the models should be saved. If not set, the models
is saved in the standard Hugging Face cache directory. are saved in the standard Hugging Face cache directory.
local_files_only: If True, avoid downloading the file and return the path to the local_files_only: If True, avoid downloading the file and return the path to the
local cached file if it exists. local cached file if it exists.
""" """

View File

@@ -45,7 +45,7 @@ def download_model(
size: Size of the model to download (tiny, tiny.en, base, base.en, small, small.en, size: Size of the model to download (tiny, tiny.en, base, base.en, small, small.en,
medium, medium.en, large-v1, or large-v2). medium, medium.en, large-v1, or large-v2).
output_dir: Directory where the model should be saved. If not set, the model is saved in output_dir: Directory where the model should be saved. If not set, the model is saved in
the standard Hugging Face cache directory. the cache directory.
local_files_only: If True, avoid downloading the file and return the path to the local local_files_only: If True, avoid downloading the file and return the path to the local
cached file if it exists. cached file if it exists.
cache_dir: Path to the folder where cached files are stored. cache_dir: Path to the folder where cached files are stored.