Update README.md

README.md

@@ -1,31 +1,62 @@
-# Applio
-
-Welcome to **Applio**, the ultimate voice cloning tool meticulously optimized for unrivaled power, modularity, and a user-friendly experience.
-
-[![🍏 Applio Plugins](https://img.shields.io/badge/%F0%9F%8D%8F%20Applio%20Plugins-ffffff?style=flat-square&link=https://github.com/IAHispano/Applio-Plugins)](https://github.com/IAHispano/Applio-Plugins)
-[![Precompiled Versions](https://img.shields.io/badge/Precompiled%20Versions-ffffff?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAALEsAACxLAaU9lqkAAAHzSURBVDhPrVFNaBNBFP5m9idJU9tE2srS5KSNlxT00AhSEEH01GMOIkpPBSmCehE99aIgVOrJgzdP6kE8qoQKEqmIV00PhRQ3jSbdTbRVm7rbnfHNJLV4lX7w3sx8733z3szDvkIIkQyCoEB2otls9vfof8B6q0a9Xu8b2V66bTSez7BguU+FhT3eQfb8Q549d4sxttVL3RNKKS3xaeEVX797GkOxHkuQZF4Ikb3zZjmcOJvP5wNFc+UUwrXFWd6Y1yK3YWlOadx12o9Y4O7cqZyDKzpA2BUy7j6bRprBWwsw/yTdLfTNwL3HaeBnB0gF4KtPp1WuEuwJ2cYYLAPDjokbF9rUOpA+IHDzYhtIUOsxCyxqjalcJdDCYrHIpLA7aPwAOiEW38dx+XoGM9cy+Lhiak7HWKKjcpVGu99+5ZL9buoR7BY9NkJE98nPo5AxCXP0C1USgGkAO8MIT76ctQ8efqAr8u+VY0ATMOg4EIcxYMMc92DlfLCkrTmYFBNfgY3Kca1RDiZdLah4PyWlEsAg2eZ219RecSomGZgRV//WbbVWq2UObb29b7RfT/FwxQZPIUoWlqQUkfHrwySTm0zauXBn6MyLVnLyquM4q0q3C14qlQY9z5uoVqtH6UyPovG57hHf9wvlcpnm8ncK/wvgD6Orstc1XrkKAAAAAElFTkSuQmCC&link=https://huggingface.co/IAHispano/applio/tree/main/Applio%20V3%20Precompiled)](https://huggingface.co/IAHispano/applio/tree/main/Applio%20V3%20Precompiled)
-![GitHub Release](https://img.shields.io/github/v/release/iahispano/applio-rvc-fork?style=flat-square)
-![GitHub Repo stars](https://img.shields.io/github/stars/iahispano/applio-rvc-fork?style=flat-square)
-![GitHub forks](https://img.shields.io/github/forks/iahispano/applio-rvc-fork?style=flat-square)
-[![Support Discord](https://img.shields.io/discord/1096877223765606521?style=flat-square)](https://discord.gg/iahispano)
-[![Issues](https://img.shields.io/github/issues/iahispano/applio-rvc-fork?style=flat-square)](https://github.com/IAHispano/Applio-RVC-Fork/issues)
-[![Open In Collab](https://img.shields.io/badge/google_colab-F9AB00?style=flat-square&logo=googlecolab&logoColor=white)](https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio.ipynb)
+---
+pipeline_tag: audio-to-audio
+tags:
+- AI
+- RVC
+- VITS
+- VC
+- Voice Conversion
+- Voice2Voice
+---
+<h1 align="center">
+  <a href="https://applio.org" target="_blank"><img src="https://github.com/IAHispano/Applio/assets/133521603/a5cc5c72-ed68-48a5-954f-db9f1dc4e7de" alt="Applio"></a>
+</h1>
+  
+<p align="center">
+    <img alt="Contributors" src="https://img.shields.io/github/contributors/iahispano/applio?style=for-the-badge&color=00AA68" />
+    <img alt="Release" src="https://img.shields.io/github/release/iahispano/applio?style=for-the-badge&color=00AA68" />
+    <img alt="Stars" src="https://img.shields.io/github/stars/iahispano/applio?style=for-the-badge&color=00AA68" />
+    <img alt="Fork" src="https://img.shields.io/github/forks/iahispano/applio?style=for-the-badge&color=00AA68" />
+    <img alt="Issues" src="https://img.shields.io/github/issues/iahispano/applio?style=for-the-badge&color=00AA68" />
+</p>
+  
+<p align="center">VITS-based Voice Conversion focused on simplicity, quality and performance</p>
+
+<p align="center">
+  <a href="https://applio.org" target="_blank">🌐 Website</a>
+  •
+  <a href="https://docs.applio.org" target="_blank">📚 Documentation</a>
+  •
+  <a href="https://discord.gg/iahispano" target="_blank">☎️ Discord</a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/IAHispano/Applio-Plugins" target="_blank">🛒 Plugins</a>
+  •
+  <a href="https://huggingface.co/IAHispano/Applio/tree/main/Compiled" target="_blank">📦 Compiled</a>
+  •
+  <a href="https://applio.org/playground" target="_blank">🎮 Playground</a>
+  •
+  <a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio.ipynb" target="_blank">🔎 Google Colab (UI)</a>
+  •
+  <a href="https://colab.research.google.com/github/iahispano/applio/blob/master/assets/Applio_NoUI.ipynb" target="_blank">🔎 Google Colab (No UI)</a>
+</p>
 
 ## Content Table
 - [**Installation**](#installation)
   - [Windows](#windows)
   - [Linux](#linux)
-  - [Using Makefile](#using-makefile-for-platforms-such-as-paperspace)
+  - [Makefile](#makefile)
 - [**Usage**](#usage)
   - [Windows](#windows-1)
   - [Linux](#linux-1)
-  - [Using Makefile](#using-makefile-for-platforms-such-as-paperspace-1)
+  - [Makefile](#makefile-1)
 - [**Repository Enhancements**](#repository-enhancements)
-- [**Credits**](#credits)
+- [**References**](#references)
   - [Contributors](#contributors)
 
 ## Installation
-Download the latest version from [GitHub Releases](https://github.com/IAHispano/Applio-RVC-Fork/releases) or use [Precompiled Versions](https://huggingface.co/IAHispano/applio/tree/main/Applio%20V3%20Precompiled).
+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).
 
 ### Windows
 ```bash
@@ -33,12 +64,14 @@ Download the latest version from [GitHub Releases](https://github.com/IAHispano/
 ```
 
 ### Linux
+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.
 ```bash
 chmod +x run-install.sh
 ./run-install.sh
 ```
 
-### Using Makefile (for platforms such as [Paperspace](https://www.paperspace.com/))
+### Makefile
+For platforms such as [Paperspace](https://www.paperspace.com/)
 ```
 make run-install
 ```
@@ -57,21 +90,40 @@ chmod +x run-applio.sh
 ./run-applio.sh
 ```
 
-### Using Makefile (for platforms such as [Paperspace](https://www.paperspace.com/))
+### Makefile
+For platforms such as [Paperspace](https://www.paperspace.com/)
 ```
 make run-applio
 ```
 
 ## Repository Enhancements
 
-This repository has undergone significant improvements to enhance its functionality and maintainability:
-
-- **Code Modularization:** The codebase has been restructured to follow a modular approach. This ensures better organization, readability, and ease of maintenance.
-- **Hop Length Implementation:** Special thanks to [@Mangio621](https://github.com/Mangio621/Mangio-RVC-Fork) for introducing hop length implementation. This enhancement enhances the efficiency and performance on Crepe (previously known as Mangio-Crepe).
-- **Translations to +30 Languages:** The repository now supports translations in over 30 languages, making it more accessible to a global audience.
-- **Cross-Platform Compatibility:** With multiplatform compatibility, this repository can seamlessly operate across various platforms, providing a consistent experience to users.
-- **Optimized Requirements:** The project's requirements have been fine-tuned for improved performance and resource utilization.
-- **Simple Installation:** The installation process has been streamlined, ensuring a straightforward and user-friendly experience for setup.
+This repository has undergone significant enhancements to improve its functionality and maintainability:
+
+- **Modular Codebase:** Restructured codebase following a modular approach for better organization, readability, and maintenance.
+- **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).
+- **Translations in 30+ Languages:** Added support for translations in over 30 languages, enhancing accessibility for a global audience.
+- **Cross-Platform Compatibility:** Ensured seamless operation across various platforms for a consistent user experience.
+- **Optimized Requirements:** Fine-tuned project requirements for enhanced performance and resource efficiency.
+- **Streamlined Installation:** Simplified installation process for a user-friendly setup experience.
+- **Hybrid F0 Estimation:** Introduced a personalized 'hybrid' F0 estimation method utilizing nanmedian, combining F0 calculations from various methods to achieve optimal results.
+- **Easy-to-Use UI:** Implemented a user-friendly interface for intuitive interaction.
+- **Optimized Code & Dependencies:** Enhanced code and streamlined dependencies for improved efficiency.
+- **Plugin System:** Introduced a plugin system for extending functionality and customization.
+- **Overtraining Detector:** Implemented an overtraining detector which halts training once a specified epoch limit is reached, preventing excessive training.
+- **Model Search:** Integrated a model search feature directly into the application interface, facilitating easy model discovery.
+- **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.
+- **Voice Blender:** Developed a voice blender feature that combines two trained models to create a new one, offering versatility in model generation.
+- **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.
+- **New F0 Extraction Methods:** Introduced new F0 extraction methods such as FCPE or Hybrid, expanding options for pitch extraction.
+- **Output Format Selection:** Implemented an output format selection feature, allowing users to choose the format in which they want to save their audio files.
+- **Hashing System:** Implemented a hashing system where each created model is assigned a unique ID to prevent unauthorized duplication or theft.
+- **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.
+- **TTS Enhancements:** Improved Text-to-Speech functionality with support for uploading TXT files, increasing flexibility in input methods.
+- **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.
+- **Discord Presence:** Displayed presence on Discord indicating active usage of Applio, with plans to incorporate different statuses based on activities within the application.
+- **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.
+- **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.
 
 These enhancements contribute to a more robust and scalable codebase, making the repository more accessible for contributors and users alike.
 
@@ -81,29 +133,11 @@ These enhancements contribute to a more robust and scalable codebase, making the
 
 We appreciate all contributions ❤️
 
-## Planned Features
-- Implement: Support for Apple Devices ([Issue Link](https://github.com/pytorch/pytorch/issues/77764))
-- Implement: rmvpe_gpu
-- Implement: Overtraining detector
-- Implement: Autotune
-- Implement: Training stop
-- Fix: Model fusion
-
-## Credits
-- [VITS](https://github.com/jaywalnut310/vits) by jaywalnut310
-- [RMVPE](https://github.com/Dream-High/RMVPE) by Dream-High
-- [ContentVec](https://github.com/auspicious3000/contentvec/) by auspicious3000
-- [HIFIGAN](https://github.com/jik876/hifi-gan) by jik876
-- [Gradio](https://github.com/gradio-app/gradio) by gradio-app
-- [FFmpeg](https://github.com/FFmpeg/FFmpeg) by FFmpeg
-- [audio-slicer](https://github.com/openvpi/audio-slicer) by openvpi
-- [Ilaria-Audio-Analyzer](https://github.com/TheStingerX/Ilaria-Audio-Analyzer) by TheStingerX
+## References
 - [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
 - [RVC_CLI](https://github.com/blaise-tk/RVC_CLI) by blaise-tk
-  - [Retrieval-based-Voice-Conversion-WebUI](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI) by RVC-Project
-  - [Mangio-RVC-Fork](https://github.com/Mangio621/Mangio-RVC-Fork) by Mangio621
 
 ### Contributors
 <a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
   <img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
-</a>
+</a>