Skip to content

Commit 9ac4438

Browse files
authored
Update README.md (#228)
1 parent 51a53d5 commit 9ac4438

1 file changed

Lines changed: 52 additions & 2 deletions

File tree

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Audio Separator 🎶
1+
<div align="center">
2+
3+
# 🎶 Audio Separator 🎶
24

35
[![PyPI version](https://badge.fury.io/py/audio-separator.svg)](https://badge.fury.io/py/audio-separator)
46
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/audio-separator.svg)](https://anaconda.org/conda-forge/audio-separator)
@@ -7,12 +9,57 @@
79
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1gSlmSmna7f7fH6OjsiMEDLl-aJ9kGPkY?usp=sharing)
810
[![Open In Huggingface](https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/theneos/audio-separator)
911

12+
</div>
13+
1014
**Summary:** Easy to use audio stem separation from the command line or as a dependency in your own Python project, using the amazing MDX-Net, VR Arch, Demucs and MDXC models available in UVR by @Anjok07 & @aufr33.
1115

1216
Audio Separator is a Python package that allows you to separate an audio file into various stems, using models trained by @Anjok07 for use with [Ultimate Vocal Remover](https://github.com/Anjok07/ultimatevocalremovergui).
1317

1418
The simplest (and probably most used) use case for this package is to separate an audio file into two stems, Instrumental and Vocals, which can be very useful for producing karaoke videos! However, the models available in UVR can separate audio into many more stems, such as Drums, Bass, Piano, and Guitar, and perform other audio processing tasks, such as denoising or removing echo/reverb.
1519

20+
<details>
21+
<summary align="center"><b>Table of Contents</div></b></summary>
22+
23+
- [🎶 Audio Separator 🎶](#-audio-separator-)
24+
- [Features](#features)
25+
- [Installation 🛠️](#installation-%EF%B8%8F)
26+
- [🐳 Docker](#-docker)
27+
- [🎮 Nvidia GPU with CUDA or 🧪 Google Colab](#-nvidia-gpu-with-cuda-or--google-colab)
28+
- [ Apple Silicon, macOS Sonoma+ with M1 or newer CPU (CoreML acceleration)](#-apple-silicon-macos-sonoma-with-m1-or-newer-cpu-coreml-acceleration)
29+
- [🐢 No hardware acceleration, CPU only](#-no-hardware-acceleration-cpu-only)
30+
- [🎥 FFmpeg dependency](#-ffmpeg-dependency)
31+
- [GPU / CUDA specific installation steps with Pip](#gpu--cuda-specific-installation-steps-with-pip)
32+
- [Multiple CUDA library versions may be needed](#multiple-cuda-library-versions-may-be-needed)
33+
- [Usage 🚀](#usage-)
34+
- [Command Line Interface (CLI)](#command-line-interface-cli)
35+
- [Listing and Filtering Available Models](#listing-and-filtering-available-models)
36+
- [Filtering Models](#filtering-models)
37+
- [Limiting Results](#limiting-results)
38+
- [JSON Output](#json-output)
39+
- [Full command-line interface options](#full-command-line-interface-options)
40+
- [As a Dependency in a Python Project](#as-a-dependency-in-a-python-project)
41+
- [Batch processing and processing with multiple models](#batch-processing-and-processing-with-multiple-models)
42+
- [Renaming Stems](#renaming-stems)
43+
- [Parameters for the Separator class](#parameters-for-the-separator-class)
44+
- [Remote API Usage 🌐](#remote-api-usage-)
45+
- [Requirements 📋](#requirements-)
46+
- [Developing Locally](#developing-locally)
47+
- [Prerequisites](#prerequisites)
48+
- [Clone the Repository](#clone-the-repository)
49+
- [Create and activate the Conda Environment](#create-and-activate-the-conda-environment)
50+
- [Install Dependencies](#install-dependencies)
51+
- [Running the Command-Line Interface Locally](#running-the-command-line-interface-locally)
52+
- [Deactivate the Virtual Environment](#deactivate-the-virtual-environment)
53+
- [Building the Package](#building-the-package)
54+
- [Contributing 🤝](#contributing-)
55+
- [License 📄](#license-)
56+
- [Credits 🙏](#credits-)
57+
- [Contact 💌](#contact-)
58+
- [Thanks to all contributors for their efforts](#thanks-to-all-contributors-for-their-efforts)
59+
</details>
60+
61+
---
62+
1663
## Features
1764

1865
- Separate audio into multiple stems, e.g. instrumental and vocals.
@@ -555,7 +602,8 @@ This project is licensed under the MIT [License](LICENSE).
555602
556603
For questions or feedback, please raise an issue or reach out to @beveradb ([Andrew Beveridge](mailto:andrew@beveridge.uk)) directly.
557604
558-
## Sponsors
605+
---
606+
<div align="center">
559607
560608
<!-- sponsors --><!-- sponsors -->
561609
@@ -564,3 +612,5 @@ For questions or feedback, please raise an issue or reach out to @beveradb ([And
564612
<a href="https://github.com/nomadkaraoke/python-audio-separator/graphs/contributors">
565613
<img src="https://contrib.rocks/image?repo=nomadkaraoke/python-audio-separator" />
566614
</a>
615+
616+
</div>

0 commit comments

Comments
 (0)