Skip to content

Commit c7da750

Browse files
committed
First Commit
Deleted Gradio app, Makefile, Dockerfile, shell/batch scripts, and all UI-related assets and tabs to convert the project to a command-line only tool. Updated README and TERMS_OF_USE to reflect the new CLI focus and removed references to the original Applio WebUI. The main entry point is now rvc_cli.py.
1 parent b9a9eaa commit c7da750

155 files changed

Lines changed: 45 additions & 34124 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Dockerfile

Lines changed: 0 additions & 35 deletions
This file was deleted.

Makefile

Lines changed: 0 additions & 22 deletions
This file was deleted.

README.md

Lines changed: 36 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,54 @@
1-
<h1 align="center">
2-
<a href="https://applio.org" target="_blank"><img src="https://github.com/IAHispano/Applio/assets/133521603/78e975d8-b07f-47ba-ab23-5a31592f322a" alt="Applio"></a>
3-
</h1>
1+
# Retrieval-based Voice Conversion (RVC) CLI
42

5-
<p align="center">
6-
<img alt="Contributors" src="https://img.shields.io/github/contributors/iahispano/applio?style=for-the-badge&color=FFFFFF" />
7-
<img alt="Release" src="https://img.shields.io/github/release/iahispano/applio?style=for-the-badge&color=FFFFFF" />
8-
<img alt="Stars" src="https://img.shields.io/github/stars/iahispano/applio?style=for-the-badge&color=FFFFFF" />
9-
<img alt="Fork" src="https://img.shields.io/github/forks/iahispano/applio?style=for-the-badge&color=FFFFFF" />
10-
<img alt="Issues" src="https://img.shields.io/github/issues/iahispano/applio?style=for-the-badge&color=FFFFFF" />
11-
</p>
3+
A stripped-down, command-line interface version of the Retrieval-based Voice Conversion (RVC) tool, optimized for performance and ease of integration.
124

13-
<p align="center">A simple, high-quality voice conversion tool, focused on ease of use and performance.</p>
5+
## Features
146

15-
<p align="center">
16-
<a href="https://applio.org" target="_blank">🌐 Website</a>
17-
18-
<a href="https://docs.applio.org" target="_blank">📚 Documentation</a>
19-
20-
<a href="https://discord.gg/urxFjYmYYh" target="_blank">☎️ Discord</a>
21-
</p>
7+
- **CLI-Only**: No WebUI overhead (Gradio removed).
8+
- **Core ML Functionality**: Supports core RVC features including Inference, Training, and Preprocessing.
9+
- **Lightweight**: Minimized dependencies for easier deployment.
2210

23-
<p align="center">
24-
<a href="https://github.com/IAHispano/Applio-Plugins" target="_blank">🛒 Plugins</a>
25-
26-
<a href="https://huggingface.co/IAHispano/Applio/tree/main/Compiled" target="_blank">📦 Compiled</a>
27-
28-
<a href="https://applio.org/playground" target="_blank">🎮 Playground</a>
29-
30-
<a href="https://colab.research.google.com/github/iahispano/applio/blob/main/assets/Applio.ipynb" target="_blank">🔎 Google Colab (UI)</a>
31-
32-
<a href="https://colab.research.google.com/github/iahispano/applio/blob/main/assets/Applio_NoUI.ipynb" target="_blank">🔎 Google Colab (No UI)</a>
33-
</p>
11+
## Installation
3412

35-
> [!NOTE]
36-
> Applio will no longer receive frequent updates. Going forward, development will focus mainly on security patches, dependency updates, and occasional feature improvements. This is because the project is already stable and mature with limited room for further improvements. Pull requests are still welcome and will be reviewed.
13+
1. **Clone the repository**:
14+
```bash
15+
git clone https://github.com/Acelogic/Retrieval-based-Voice-Conversion-MLX.git
16+
cd Retrieval-based-Voice-Conversion-MLX
17+
```
3718

38-
## Introduction
19+
2. **Install dependencies**:
20+
```bash
21+
pip install -r requirements.txt
22+
```
3923

40-
Applio is a powerful voice conversion tool focused on simplicity, quality, and performance. Whether you're an artist, developer, or researcher, Applio offers a straightforward platform for high-quality voice transformations. Its flexible design allows for customization through plugins and configurations, catering to a wide range of projects.
24+
*Note: Ensure you have `ffmpeg` installed on your system if not using the python wrapper.*
4125

42-
## Terms of Use and Commercial Usage
26+
## Usage
4327

44-
Using Applio responsibly is essential.
28+
The main entry point is `rvc_cli.py`. You can see all available commands by running:
4529

46-
- Users must respect copyrights, intellectual property, and privacy rights.
47-
- Applio is intended for lawful and ethical purposes, including personal, academic, and investigative projects.
48-
- Commercial usage is permitted, provided users adhere to legal and ethical guidelines, secure appropriate rights and permissions, and comply with the [MIT license](./LICENSE).
30+
```bash
31+
python rvc_cli.py --help
32+
```
4933

50-
The source code and model weights in this repository are licensed under the permissive [MIT license](./LICENSE), allowing modification, redistribution, and commercial use.
34+
### Common Commands
5135

52-
However, if you choose to use this official version of Applio (as provided in this repository, without significant modification), you must also comply with our [Terms of Use](./TERMS_OF_USE.md). These terms apply to our integrations, configurations, and default project behavior, and are intended to ensure responsible and ethical use without limiting their use in any way.
36+
**Inference:**
37+
```bash
38+
python rvc_cli.py infer --model_path <path_to_pth> --input_path <audio_file> --output_path <output_file> --index_path <path_to_index>
39+
```
5340

54-
For commercial use, we recommend contacting us at [support@applio.org](mailto:support@applio.org) to ensure your usage aligns with ethical standards. All audio generated with Applio must comply with applicable copyright laws. If you find Applio helpful, consider supporting its development [through a donation](https://ko-fi.com/iahispano).
41+
**Training:**
42+
```bash
43+
python rvc_cli.py train --model_name <name> --total_epoch 100 ...
44+
```
5545

56-
By using the official version of Applio, you accept full responsibility for complying with both the MIT license and our Terms of Use. Applio and its contributors are not liable for misuse. For full legal details, see the [Terms of Use](./TERMS_OF_USE.md).
46+
**(Add more usage examples as you explore the CLI options)**
5747

58-
## Getting Started
48+
## License
5949

60-
### 1. Installation
50+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
6151

62-
Run the installation script based on your operating system:
52+
## Disclaimer
6353

64-
- **Windows:** Double-click `run-install.bat`.
65-
- **Linux/macOS:** Execute `run-install.sh`.
66-
67-
### 2. Running Applio
68-
69-
Start Applio using:
70-
71-
- **Windows:** Double-click `run-applio.bat`.
72-
- **Linux/macOS:** Run `run-applio.sh`.
73-
74-
This launches the Gradio interface in your default browser.
75-
76-
### 3. Optional: TensorBoard Monitoring
77-
78-
To monitor training or visualize data:
79-
80-
- **Windows:** Run `run-tensorboard.bat`.
81-
- **Linux/macOS:** Run `run-tensorboard.sh`.
82-
83-
For more detailed instructions, visit the [documentation](https://docs.applio.org).
84-
85-
## References
86-
87-
Applio is made possible thanks to these projects and their references:
88-
89-
- [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
90-
- [rvc-cli](https://github.com/blaisewf/rvc-cli) by blaisewf
91-
92-
### Contributors
93-
94-
<a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
95-
<img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
96-
</a>
54+
This project is based on the [Applio](https://github.com/IAHispano/Applio) repository but has been stripped down to its core CLI components. All original credits go to the respective authors.

TERMS_OF_USE.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
## Responsibilities of the User
44

5-
By using Applio, you agree to the following responsibilities:
5+
By using this software, you agree to the following responsibilities:
66

77
### 1. Respect Intellectual Property and Privacy Rights
88

9-
- Ensure that any audio or material processed through Applio is either owned by you or used with explicit permission from the rightful owner.
9+
- Ensure that any audio or material processed is either owned by you or used with explicit permission from the rightful owner.
1010
- Respect copyrights, intellectual property rights, and privacy rights of all individuals and entities.
1111

1212
### 2. Avoid Harmful or Unethical Use
1313

14-
- Do not use Applio to create or distribute content that harms, defames, or infringes upon the rights of others.
14+
- Do not use this tool to create or distribute content that harms, defames, or infringes upon the rights of others.
1515
- Avoid any activities that may violate ethical standards, promote hate speech, or facilitate illegal conduct.
1616

1717
### 3. Adhere to Local Laws and Regulations
@@ -20,15 +20,14 @@ By using Applio, you agree to the following responsibilities:
2020

2121
## Disclaimer of Liability
2222

23-
Applio and its contributors disclaim all liability for any misuse or unintended consequences arising from the use of this tool.
23+
The contributors disclaim all liability for any misuse or unintended consequences arising from the use of this tool.
2424

25-
- **No Warranty**: Applio is provided "as is" without any warranty, express or implied.
26-
- **User Responsibility**: You bear full responsibility for how you choose to use Applio and any outcomes resulting from that use.
27-
- **No Endorsement**: Applio does not endorse or support any activities or content created with this tool that result in harm, illegal activity, or unethical practices.
25+
- **No Warranty**: The software is provided "as is" without any warranty, express or implied.
26+
- **User Responsibility**: You bear full responsibility for how you choose to use the tool and any outcomes resulting from that use.
2827

2928
## Permitted Use Cases
3029

31-
Applio is designed for:
30+
This tool is designed for:
3231

3332
- **Personal Projects**: Experimentation and creative endeavors for personal enrichment.
3433
- **Academic Research**: Advancing scientific understanding and education.
@@ -42,11 +41,3 @@ The following uses are explicitly prohibited:
4241
- **Harmful Applications**: Generating audio to defame, harm, or manipulate others.
4342
- **Unauthorized Distribution**: Sharing content that violates copyrights or the rights of others.
4443
- **Deceptive Practices**: Creating content intended to deceive or defraud others.
45-
46-
## Training Data
47-
48-
All official models distributed by Applio have been trained under publicly available datasets such as [VCTK](https://huggingface.co/datasets/IAHispano/Applio-Dataset). We strive to maintain transparency and ethical practices in the development and distribution of our tools.
49-
50-
## Amendments
51-
52-
Applio reserves the right to modify these terms at any time. Continued use of the tool signifies your acceptance of any updated terms.

0 commit comments

Comments
 (0)