Update README.md
Browse files
README.md
CHANGED
|
@@ -12,89 +12,10 @@ datasets:
|
|
| 12 |
- CSTR-Edinburgh/vctk
|
| 13 |
base_model:
|
| 14 |
- lj1995/VoiceConversionWebUI
|
|
|
|
| 15 |
---
|
| 16 |
|
| 17 |
-
<h1 align="center">
|
| 18 |
-
<a href="https://applio.org" target="_blank"><img src="https://github.com/IAHispano/Applio/assets/133521603/78e975d8-b07f-47ba-ab23-5a31592f322a" alt="Applio"></a>
|
| 19 |
-
</h1>
|
| 20 |
|
| 21 |
-
<p align="center">A simple, high-quality voice conversion tool, focused on ease of use and performance.</p>
|
| 22 |
|
| 23 |
-
<p align="center">
|
| 24 |
-
<a href="https://applio.org" target="_blank">🌐 Website</a>
|
| 25 |
-
•
|
| 26 |
-
<a href="https://docs.applio.org" target="_blank">📚 Documentation</a>
|
| 27 |
-
•
|
| 28 |
-
<a href="https://discord.gg/urxFjYmYYh" target="_blank">☎️ Discord</a>
|
| 29 |
-
</p>
|
| 30 |
|
| 31 |
-
<p align="center">
|
| 32 |
-
<a href="https://github.com/IAHispano/Applio-Plugins" target="_blank">🛒 Plugins</a>
|
| 33 |
-
•
|
| 34 |
-
<a href="https://huggingface.co/IAHispano/Applio/tree/main/Compiled" target="_blank">📦 Compiled</a>
|
| 35 |
-
•
|
| 36 |
-
<a href="https://applio.org/playground" target="_blank">🎮 Playground</a>
|
| 37 |
-
•
|
| 38 |
-
<a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio.ipynb" target="_blank">🔎 Google Colab (UI)</a>
|
| 39 |
-
•
|
| 40 |
-
<a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio_NoUI.ipynb" target="_blank">🔎 Google Colab (No UI)</a>
|
| 41 |
-
</p>
|
| 42 |
|
| 43 |
-
## Introduction
|
| 44 |
-
|
| 45 |
-
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.
|
| 46 |
-
|
| 47 |
-
## Terms of Use
|
| 48 |
-
The use of Applio is entirely at your own discretion and responsibility. By using this tool, you agree to:
|
| 49 |
-
|
| 50 |
-
1. Respect all applicable copyrights, intellectual property rights, and privacy rights. Ensure that any audio or material processed through Applio is either owned by you or used with explicit permission from the rightful owner.
|
| 51 |
-
|
| 52 |
-
2. Avoid using Applio in ways that may harm, defame, or infringe upon the rights of others. This includes, but is not limited to, the creation or distribution of unauthorized content.
|
| 53 |
-
|
| 54 |
-
3. Comply with all relevant laws and regulations governing the use of AI and voice transformation tools in your jurisdiction.
|
| 55 |
-
|
| 56 |
-
Applio and its contributors are not liable for any misuse of the tool. The responsibility for adhering to ethical practices and legal compliance lies solely with the user. Applio does not endorse or support any activities that result in harm to individuals, groups, or entities. All official models distributed by Applio have been trained under public use datasets such as VCTK.
|
| 57 |
-
|
| 58 |
-
## Getting Started
|
| 59 |
-
|
| 60 |
-
### 1. Installation
|
| 61 |
-
|
| 62 |
-
Run the installation script based on your operating system:
|
| 63 |
-
|
| 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 |
-
## Commercial Usage
|
| 86 |
-
|
| 87 |
-
For commercial use, follow the [MIT license](./LICENSE) and contact us at support@applio.org to ensure ethical use. The use of Applio-generated audio files must comply with applicable copyrights. Consider supporting Applio’s development [through a donation](https://ko-fi.com/iahispano).
|
| 88 |
-
|
| 89 |
-
## References
|
| 90 |
-
|
| 91 |
-
Applio is made possible thanks to these projects and their references:
|
| 92 |
-
|
| 93 |
-
- [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
|
| 94 |
-
- [rvc-cli](https://github.com/blaisewf/rvc-cli) by blaisewf
|
| 95 |
-
|
| 96 |
-
### Contributors
|
| 97 |
-
|
| 98 |
-
<a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
|
| 99 |
-
<img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
|
| 100 |
-
</a>
|
|
|
|
| 12 |
- CSTR-Edinburgh/vctk
|
| 13 |
base_model:
|
| 14 |
- lj1995/VoiceConversionWebUI
|
| 15 |
+
- IAHispano/Applio
|
| 16 |
---
|
| 17 |
|
|
|
|
|
|
|
|
|
|
| 18 |
|
|
|
|
| 19 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 20 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|