Skip to content

Commit

Permalink
Updated readme with new params
Browse files Browse the repository at this point in the history
  • Loading branch information
beveradb committed Jul 7, 2023
1 parent 012c394 commit 913c4c0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ audio-separator [audio_file] --model_name [model_name]
model_name: (Optional) The name of the model to use for separation. Default: UVR_MDXNET_KARA_2
model_file_dir: (Optional) Directory to cache model files in. Default: /tmp/audio-separator-models/
output_dir: (Optional) The directory where the separated files will be saved. If not specified, outputs to current dir.
use_cuda: (Optional) Flag to use Nvidia GPU via CUDA for separation if available. Default: False
log_level: (Optional) The log level. Default: logging.DEBUG
log_formatter: (Optional) The log format. Default: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
```
Example:
Expand Down Expand Up @@ -69,6 +72,9 @@ print(f'Secondary stem saved at {secondary_stem_path}')
- model_name: (Optional) The name of the model to use for separation. Defaults to 'UVR_MDXNET_KARA_2', a very powerful model for Karaoke instrumental tracks.
- model_file_dir: (Optional) Directory to cache model files in. Default: /tmp/audio-separator-models/
- output_dir: (Optional) Directory where the separated files will be saved. If not specified, outputs to current dir.
- use_cuda: (Optional) Flag to use Nvidia GPU via CUDA for separation if available. Default: False
- log_level: (Optional) The log level. Default: logging.DEBUG
- log_formatter: (Optional) The log format. Default: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
## Requirements 📋
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "audio-separator"
version = "0.3.1"
version = "0.3.2"
description = "Easy to use vocal separation on CLI or as a python package, using the amazing MDX-Net models from UVR trained by @Anjok07"
authors = ["Andrew Beveridge <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 913c4c0

Please sign in to comment.