Elesh Vaishnav commited on
Commit
8549503
Β·
verified Β·
1 Parent(s): 105e4c0

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -39
README.md CHANGED
@@ -18,9 +18,7 @@
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>
22
-
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>
@@ -32,74 +30,79 @@
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>
34
 
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.
37
 
38
  ## Introduction
39
 
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.
41
 
42
- ## Terms of Use and Commercial Usage
 
43
 
44
- Using Applio responsibly is essential.
45
 
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).
49
 
50
- The source code and model weights in this repository are licensed under the permissive [MIT license](./LICENSE), allowing modification, redistribution, and commercial use.
 
 
 
51
 
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.
53
 
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).
55
 
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).
 
 
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
- ---
86
- title: My Awesome Space
87
- emoji: ✨
88
- colorFrom: blue
89
- colorTo: purple
90
- sdk: gradio
91
- app_file: app.py
92
- pinned: false
93
- ---
94
  ## References
95
 
96
- Applio is made possible thanks to these projects and their references:
97
 
98
- - [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
99
- - [rvc-cli](https://github.com/blaisewf/rvc-cli) by blaisewf
100
 
101
  ### Contributors
102
 
 
 
103
  <a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
104
  <img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
105
- </a>
 
18
  <a href="https://docs.applio.org" target="_blank">πŸ“š Documentation</a>
19
  β€’
20
  <a href="https://discord.gg/urxFjYmYYh" target="_blank">☎️ Discord</a>
21
+ β€’
 
 
22
  <a href="https://github.com/IAHispano/Applio-Plugins" target="_blank">πŸ›’ Plugins</a>
23
  β€’
24
  <a href="https://huggingface.co/IAHispano/Applio/tree/main/Compiled" target="_blank">πŸ“¦ Compiled</a>
 
30
  <a href="https://colab.research.google.com/github/iahispano/applio/blob/main/assets/Applio_NoUI.ipynb" target="_blank">πŸ”Ž Google Colab (No UI)</a>
31
  </p>
32
 
33
+ ---
 
34
 
35
  ## Introduction
36
 
37
+ Applio is a powerful, user-friendly voice conversion tool designed for high-quality audio transformations with a focus on simplicity and performance. It's suitable for artists, developers, and researchers alike, offering a flexible platform that supports customization through plugins and configurations for diverse projects.
38
 
39
+ > [!NOTE]
40
+ > Applio is currently stable and mature, meaning it will receive fewer frequent updates. Future development will concentrate on security patches, dependency updates, and occasional feature enhancements. Pull requests are always welcome and will be reviewed.
41
 
42
+ ## Terms of Use & Commercial Usage
43
 
44
+ Responsible use of Applio is paramount. Users are expected to respect copyrights, intellectual property, and privacy rights. Applio is intended for lawful and ethical purposes, including personal, academic, and investigative projects.
 
 
45
 
46
+ Commercial usage is permitted under the following conditions:
47
+ * Adherence to all legal and ethical guidelines.
48
+ * Securing appropriate rights and permissions for your specific use case.
49
+ * Compliance with the permissive [MIT license](./LICENSE).
50
 
51
+ While the source code and model weights are MIT licensed, use of the official Applio version (as provided in this repository, without significant modification) also requires compliance with our [Terms of Use](./TERMS_OF_USE.md). These terms ensure responsible and ethical usage without limiting the project's utility.
52
 
53
+ For commercial inquiries or to ensure alignment with ethical standards, please contact us at [support@applio.org](mailto:support@applio.org). All audio generated with Applio must comply with applicable copyright laws.
54
 
55
+ By using the official version of Applio, you accept full responsibility for complying with both the MIT license and our [Terms of Use](./TERMS_OF_USE.md). Applio and its contributors are not liable for misuse.
56
+
57
+ Consider supporting Applio's development [through a donation](https://ko-fi.com/iahispano) if you find it valuable.
58
 
59
  ## Getting Started
60
 
61
  ### 1. Installation
62
 
63
+ Run the appropriate installation script for your operating system:
64
 
65
+ * **Windows:** Double-click `run-install.bat`
66
+ * **Linux/macOS:** Execute `run-install.sh`
67
 
68
  ### 2. Running Applio
69
 
70
+ Launch Applio using the script for your operating system:
71
 
72
+ * **Windows:** Double-click `run-applio.bat`
73
+ * **Linux/macOS:** Run `run-applio.sh`
74
 
75
+ This will automatically open the Gradio user interface in your default web browser.
76
 
77
  ### 3. Optional: TensorBoard Monitoring
78
 
79
+ To monitor training progress or visualize data:
80
+
81
+ * **Windows:** Run `run-tensorboard.bat`
82
+ * **Linux/macOS:** Run `run-tensorboard.sh`
83
 
84
+ For more comprehensive instructions and troubleshooting, please refer to the [official documentation](https://docs.applio.org).
 
85
 
86
+ ## My Awesome Space
87
+
88
+ * **Emoji:** ✨
89
+ * **Color From:** blue
90
+ * **Color To:** purple
91
+ * **SDK:** gradio
92
+ * **App File:** `app.py`
93
+ * **Pinned:** false
94
 
 
 
 
 
 
 
 
 
 
95
  ## References
96
 
97
+ Applio is built upon the contributions of these excellent projects:
98
 
99
+ * [gradio-screen-recorder](https://huggingface.co/spaces/gstaff/gradio-screen-recorder) by gstaff
100
+ * [rvc-cli](https://github.com/blaisewf/rvc-cli) by blaisewf
101
 
102
  ### Contributors
103
 
104
+ A huge thank you to all the contributors who have made Applio possible!
105
+
106
  <a href="https://github.com/IAHispano/Applio/graphs/contributors" target="_blank">
107
  <img src="https://contrib.rocks/image?repo=IAHispano/Applio" />
108
+ </a>