blaise-tk commited on
Commit
74db1ab
β€’
1 Parent(s): 30b461b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -100
README.md CHANGED
@@ -9,18 +9,18 @@ tags:
9
  - Voice2Voice
10
  ---
11
  <h1 align="center">
12
- <a href="https://applio.org" target="_blank"><img src="https://github.com/IAHispano/Applio/assets/133521603/a5cc5c72-ed68-48a5-954f-db9f1dc4e7de" alt="Applio"></a>
13
  </h1>
14
-
15
  <p align="center">
16
- <img alt="Contributors" src="https://img.shields.io/github/contributors/iahispano/applio?style=for-the-badge&color=00AA68" />
17
- <img alt="Release" src="https://img.shields.io/github/release/iahispano/applio?style=for-the-badge&color=00AA68" />
18
- <img alt="Stars" src="https://img.shields.io/github/stars/iahispano/applio?style=for-the-badge&color=00AA68" />
19
- <img alt="Fork" src="https://img.shields.io/github/forks/iahispano/applio?style=for-the-badge&color=00AA68" />
20
- <img alt="Issues" src="https://img.shields.io/github/issues/iahispano/applio?style=for-the-badge&color=00AA68" />
21
  </p>
22
-
23
- <p align="center">VITS-based Voice Conversion focused on simplicity, quality and performance</p>
24
 
25
  <p align="center">
26
  <a href="https://applio.org" target="_blank">🌐 Website</a>
@@ -42,102 +42,53 @@ tags:
42
  <a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio_NoUI.ipynb" target="_blank">πŸ”Ž Google Colab (No UI)</a>
43
  </p>
44
 
45
- ## Content Table
46
- - [**Installation**](#installation)
47
- - [Windows](#windows)
48
- - [Linux](#linux)
49
- - [Makefile](#makefile)
50
- - [**Usage**](#usage)
51
- - [Windows](#windows-1)
52
- - [Linux](#linux-1)
53
- - [Makefile](#makefile-1)
54
- - [**Repository Enhancements**](#repository-enhancements)
55
- - [**References**](#references)
56
- - [Contributors](#contributors)
57
-
58
- ## Installation
59
- Download the latest version from [GitHub Releases](https://github.com/IAHispano/Applio-RVC-Fork/releases) or use the [Compiled Versions](https://huggingface.co/IAHispano/Applio/tree/main/Compiled).
60
-
61
- ### Windows
62
- ```bash
63
- ./run-install.bat
64
- ```
65
-
66
- ### Linux
67
- Certain Linux-based operating systems may encounter complications with the installer. In such instances, we suggest installing the `requirements.txt` within a Python environment version 3.9 to 3.11.
68
- ```bash
69
- chmod +x run-install.sh
70
- ./run-install.sh
71
- ```
72
-
73
- ### Makefile
74
- For platforms such as [Paperspace](https://www.paperspace.com/)
75
- ```
76
- make run-install
77
- ```
78
-
79
- ## Usage
80
- Visit [Applio Documentation](https://docs.applio.org/) for a detailed UI usage explanation.
81
-
82
- ### Windows
83
- ```bash
84
- ./run-applio.bat
85
- ```
86
-
87
- ### Linux
88
- ```bash
89
- chmod +x run-applio.sh
90
- ./run-applio.sh
91
- ```
92
-
93
- ### Makefile
94
- For platforms such as [Paperspace](https://www.paperspace.com/)
95
- ```
96
- make run-applio
97
- ```
98
-
99
- ## Repository Enhancements
100
-
101
- This repository has undergone significant enhancements to improve its functionality and maintainability:
102
-
103
- - **Modular Codebase:** Restructured codebase following a modular approach for better organization, readability, and maintenance.
104
- - **Hop Length Implementation:** Implemented hop length, courtesy of [@Mangio621](https://github.com/Mangio621/Mangio-RVC-Fork), boosting efficiency and performance, especially on Crepe (formerly Mangio-Crepe).
105
- - **Translations in 30+ Languages:** Added support for translations in over 30 languages, enhancing accessibility for a global audience.
106
- - **Cross-Platform Compatibility:** Ensured seamless operation across various platforms for a consistent user experience.
107
- - **Optimized Requirements:** Fine-tuned project requirements for enhanced performance and resource efficiency.
108
- - **Streamlined Installation:** Simplified installation process for a user-friendly setup experience.
109
- - **Hybrid F0 Estimation:** Introduced a personalized 'hybrid' F0 estimation method utilizing nanmedian, combining F0 calculations from various methods to achieve optimal results.
110
- - **Easy-to-Use UI:** Implemented a user-friendly interface for intuitive interaction.
111
- - **Optimized Code & Dependencies:** Enhanced code and streamlined dependencies for improved efficiency.
112
- - **Plugin System:** Introduced a plugin system for extending functionality and customization.
113
- - **Overtraining Detector:** Implemented an overtraining detector which halts training once a specified epoch limit is reached, preventing excessive training.
114
- - **Model Search:** Integrated a model search feature directly into the application interface, facilitating easy model discovery.
115
- - **Enhancements in Pretrained Models:** Introduced additional functionalities such as custom pretrained models, allowing users to utilize their preferred pretrained models without requiring RVC1 pretrained models upon installation.
116
- - **Voice Blender:** Developed a voice blender feature that combines two trained models to create a new one, offering versatility in model generation.
117
- - **Accessibility Improvements:** Enhanced accessibility with descriptive tooltips indicating the function of each element in the user interface, making it more user-friendly for all users.
118
- - **New F0 Extraction Methods:** Introduced new F0 extraction methods such as FCPE or Hybrid, expanding options for pitch extraction.
119
- - **Output Format Selection:** Implemented an output format selection feature, allowing users to choose the format in which they want to save their audio files.
120
- - **Hashing System:** Implemented a hashing system where each created model is assigned a unique ID to prevent unauthorized duplication or theft.
121
- - **Model Download System:** Added support for downloading models from various websites such as Google Drive, Yandex, Pixeldrain, Discord, Hugging Face, or Applio.org, enhancing model accessibility.
122
- - **TTS Enhancements:** Improved Text-to-Speech functionality with support for uploading TXT files, increasing flexibility in input methods.
123
- - **Split Audio:** Implemented audio splitting functionality which divides audio into segments for inference, subsequently merging them to create the final audio, resulting in faster processing times and potentially better outcomes.
124
- - **Discord Presence:** Displayed presence on Discord indicating active usage of Applio, with plans to incorporate different statuses based on activities within the application.
125
- - **Flask Integration:** Integration with Flask, initially disabled by default, allows for automatic model downloads from the web by simply clicking the Applio button next to the model download button in the settings tab.
126
- - **Support Tab:** Added a support tab enabling users to record their screen to demonstrate encountered issues, facilitating faster issue resolution by allowing users to create GitHub issues for review and troubleshooting.
127
-
128
- These enhancements contribute to a more robust and scalable codebase, making the repository more accessible for contributors and users alike.
129
-
130
- ## Contributions
131
- - **Backend Contributions:** If you want to contribute to the backend, make your pull requests [here](https://github.com/blaise-tk/RVC_CLI).
132
- - **Frontend Contributions:** For interface or script-related contributions, feel free to contribute to this repository.
133
-
134
- We appreciate all contributions ❀️
135
 
136
  ## References
 
 
 
137
  - [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
138
- - [RVC_CLI](https://github.com/blaise-tk/RVC_CLI) by blaise-tk
139
 
140
  ### Contributors
 
141
  <a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
142
  <img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
143
  </a>
 
9
  - Voice2Voice
10
  ---
11
  <h1 align="center">
12
+ <a href="https://applio.org" target="_blank"><img src="https://github.com/IAHispano/Applio/assets/133521603/78e975d8-b07f-47ba-ab23-5a31592f322a" alt="Applio"></a>
13
  </h1>
14
+
15
  <p align="center">
16
+ <img alt="Contributors" src="https://img.shields.io/github/contributors/iahispano/applio?style=for-the-badge&color=FFFFFF" />
17
+ <img alt="Release" src="https://img.shields.io/github/release/iahispano/applio?style=for-the-badge&color=FFFFFF" />
18
+ <img alt="Stars" src="https://img.shields.io/github/stars/iahispano/applio?style=for-the-badge&color=FFFFFF" />
19
+ <img alt="Fork" src="https://img.shields.io/github/forks/iahispano/applio?style=for-the-badge&color=FFFFFF" />
20
+ <img alt="Issues" src="https://img.shields.io/github/issues/iahispano/applio?style=for-the-badge&color=FFFFFF" />
21
  </p>
22
+
23
+ <p align="center">VITS-based Voice Conversion focused on simplicity, quality, and performance.</p>
24
 
25
  <p align="center">
26
  <a href="https://applio.org" target="_blank">🌐 Website</a>
 
42
  <a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio_NoUI.ipynb" target="_blank">πŸ”Ž Google Colab (No UI)</a>
43
  </p>
44
 
45
+ ## Introduction
46
+
47
+ Applio is a powerful VITS-based voice conversion tool designed with a focus on simplicity, quality, and performance. Whether you're an artist experimenting with voice synthesis, a developer building applications, or a researcher exploring new audio technologies, Applio provides an easy-to-use platform that produces high-quality voice transformations with minimal effort. Built to be flexible, Applio can be customized with various plugins and configurations to meet the needs of your project.
48
+
49
+ ## Getting Started
50
+
51
+ To get started with Applio, simply follow these steps:
52
+
53
+ ### 1. Installation:
54
+
55
+ - Run the installation script based on your operating system:
56
+ - **Windows:** Double-click on the `run-install.bat` file.
57
+ - **Linux/macOS:** Execute the `run-install.sh` script.
58
+
59
+ ### 2. Running Applio:
60
+
61
+ - After the installation is complete, you can start Applio using the appropriate script:
62
+ - **Windows:** Double-click on `run-applio.bat`.
63
+ - **Linux/macOS:** Run the `run-applio.sh` script.
64
+
65
+ The application will start the Gradio interface, allowing you to interact with Applio in your default browser.
66
+
67
+ ### 3. Optional: TensorBoard Monitoring
68
+
69
+ - If you want to monitor the training process or visualize data, you can run TensorBoard using:
70
+ - **Windows:** `run-tensorboard.bat`
71
+ - **Linux/macOS:** `run-tensorboard.sh`
72
+
73
+ For more detailed instructions, check out the [documentation](https://docs.applio.org).
74
+
75
+ ## Commercial Usage
76
+
77
+ For commercial purposes, please adhere to the guidelines outlined in the [MIT license](./LICENSE) governing this project. Prior to integrating Applio into your application, we kindly request that you contact us at support@applio.org to ensure ethical use.
78
+
79
+ Please note, the use of Applio-generated audio files falls under your own responsibility and must always respect applicable copyrights. We encourage you to consider supporting the continuous development and maintenance of Applio through a donation.
80
+
81
+ Your cooperation and support are greatly appreciated. Thank you!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
82
 
83
  ## References
84
+
85
+ Applio is possible thanks to these projects and those cited in their references.
86
+
87
  - [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
88
+ - [rvc-cli](https://github.com/blaisewf/rvc-cli) by blaisewf
89
 
90
  ### Contributors
91
+
92
  <a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
93
  <img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
94
  </a>