Tweaked short CLI params

nomadkaraoke · Feb 5, 2024 · 8d95f6a · 8d95f6a
1 parent db8b0bd
commit 8d95f6a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -110,10 +110,10 @@ If the GPU isn't being detected, make sure your docker runtime environment is pa
 You can use Audio Separator via the command line:
 
 ```sh
-usage: audio-separator [-h] [-v] [-d] [-e] [-m] [--log_level LOG_LEVEL] [--model_filename MODEL_FILENAME] [--output_format OUTPUT_FORMAT] [--output_dir OUTPUT_DIR] [--model_file_dir MODEL_FILE_DIR] [--denoise]
-                       [--invert_spect] [--normalization NORMALIZATION] [--single_stem SINGLE_STEM] [--sample_rate SAMPLE_RATE] [--mdx_segment_size MDX_SEGMENT_SIZE] [--mdx_overlap MDX_OVERLAP]
-                       [--mdx_batch_size MDX_BATCH_SIZE] [--mdx_hop_length MDX_HOP_LENGTH] [--vr_batch_size VR_BATCH_SIZE] [--vr_window_size VR_WINDOW_SIZE] [--vr_aggression VR_AGGRESSION] [--vr_enable_tta]
-                       [--vr_high_end_process] [--vr_enable_post_process] [--vr_post_process_threshold VR_POST_PROCESS_THRESHOLD]
+usage: audio-separator [-h] [-v] [-d] [-e] [-l] [--log_level LOG_LEVEL] [-m MODEL_FILENAME] [--output_format OUTPUT_FORMAT] [--output_dir OUTPUT_DIR] [--model_file_dir MODEL_FILE_DIR] [--denoise] [--invert_spect]
+                       [--normalization NORMALIZATION] [--single_stem SINGLE_STEM] [--sample_rate SAMPLE_RATE] [--mdx_segment_size MDX_SEGMENT_SIZE] [--mdx_overlap MDX_OVERLAP] [--mdx_batch_size MDX_BATCH_SIZE]
+                       [--mdx_hop_length MDX_HOP_LENGTH] [--vr_batch_size VR_BATCH_SIZE] [--vr_window_size VR_WINDOW_SIZE] [--vr_aggression VR_AGGRESSION] [--vr_enable_tta] [--vr_high_end_process]
+                       [--vr_enable_post_process] [--vr_post_process_threshold VR_POST_PROCESS_THRESHOLD]
                        [audio_file]
 
 Separate audio file into different stems.
@@ -128,11 +128,11 @@ Info and Debugging:
   -v, --version                                          show program's version number and exit
   -d, --debug                                            enable debug logging, equivalent to --log_level=debug
   -e, --env_info                                         print environment information and exit.
-  -m, --list_models                                      list all supported models and exit.
+  -l, --list_models                                      list all supported models and exit.
   --log_level LOG_LEVEL                                  log level, e.g. info, debug, warning (default: info)
 
 Separation I/O Params:
-  --model_filename MODEL_FILENAME                        model to use for separation (default: 2_HP-UVR.pth). Example: --model_filename=UVR_MDXNET_KARA_2.onnx
+  -m MODEL_FILENAME, --model_filename MODEL_FILENAME     model to use for separation (default: UVR-MDX-NET-Inst_HQ_3.onnx). Example: -m 2_HP-UVR.pth
   --output_format OUTPUT_FORMAT                          output format for separated files, any common format (default: FLAC). Example: --output_format=MP3
   --output_dir OUTPUT_DIR                                directory to write output files (default: <current dir>). Example: --output_dir=/app/separated
   --model_file_dir MODEL_FILE_DIR                        model files directory (default: /tmp/audio-separator-models/). Example: --model_file_dir=/app/models

diff --git a/audio_separator/utils/cli.py b/audio_separator/utils/cli.py
@@ -24,11 +24,11 @@ def main():
     info_params.add_argument("-v", "--version", action="version", version=f"%(prog)s {package_version}")
     info_params.add_argument("-d", "--debug", action="store_true", help="enable debug logging, equivalent to --log_level=debug")
     info_params.add_argument("-e", "--env_info", action="store_true", help="print environment information and exit.")
-    info_params.add_argument("-m", "--list_models", action="store_true", help="list all supported models and exit.")
+    info_params.add_argument("-l", "--list_models", action="store_true", help="list all supported models and exit.")
     info_params.add_argument("--log_level", default="info", help="log level, e.g. info, debug, warning (default: %(default)s)")
 
     io_params = parser.add_argument_group("Separation I/O Params")
-    io_params.add_argument("--model_filename", default="UVR-MDX-NET-Inst_HQ_3.onnx", help="model to use for separation (default: %(default)s). Example: --model_filename=2_HP-UVR.pth")
+    io_params.add_argument("-m", "--model_filename", default="UVR-MDX-NET-Inst_HQ_3.onnx", help="model to use for separation (default: %(default)s). Example: -m 2_HP-UVR.pth")
     io_params.add_argument("--output_format", default="FLAC", help="output format for separated files, any common format (default: %(default)s). Example: --output_format=MP3")
     io_params.add_argument("--output_dir", default=None, help="directory to write output files (default: <current dir>). Example: --output_dir=/app/separated")
     io_params.add_argument("--model_file_dir", default="/tmp/audio-separator-models/", help="model files directory (default: %(default)s). Example: --model_file_dir=/app/models")