Skip to content

fix documentation in enhance.py (DeepFilterNet3 vs DeepFilterNet2 as default) #652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix documentation in enhance.py (DeepFilterNet3 vs DeepFilterNet2 as default) #652

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DeepFilterNet/df/enhance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def init_df(

Args:
model_base_dir (str): Path to the model directory containing checkpoint and config. If None,
load the pretrained DeepFilterNet2 model.
load the pretrained DeepFilterNet3 model.
post_filter (bool): Enable post filter for some minor, extra noise reduction.
log_level (str): Control amount of logging. Defaults to `INFO`.
log_file (str): Optional log file name. None disables it. Defaults to `enhance.log`.
Expand Down Expand Up @@ -254,7 +254,7 @@ def maybe_download_model(name: str = DEFAULT_MODEL) -> str:
"""Download a DeepFilterNet model.

Args:
- name (str): Model name. Currently needs to one of `[DeepFilterNet, DeepFilterNet2]`.
- name (str): Model name. Currently needs to one of `[DeepFilterNet, DeepFilterNet2, DeepFilterNet3]`.

Returns:
- base_dir: Return the model base directory as string.
Expand Down Expand Up @@ -308,7 +308,7 @@ def setup_df_argument_parser(
default=None,
help="Model directory containing checkpoints and config. "
"To load a pretrained model, you may just provide the model name, e.g. `DeepFilterNet`. "
"By default, the pretrained DeepFilterNet2 model is loaded.",
"By default, the pretrained DeepFilterNet3 model is loaded.",
)
parser.add_argument(
"--pf",
Expand Down