audio-webui / readme.md
mrtroydev's picture
Upload folder using huggingface_hub
3883c60 verified
|
raw
history blame
7.34 kB

logo Audio Webui logo

https://github.com/gitmylo/audio-webui/assets/36931363/c285b4dc-63cf-4b1c-895d-9723a2cbf91e

GitHub commit activity (branch) GitHub contributors GitHub all releases GitHub Sponsors

Discord

❗❗ Please read ❗❗

This code works on python 3.10 (lower versions don't support "|" type annotations, and i believe 3.11 doesn't have support for the TTS library currently).

You also need to have Git installed, you might already have it, run git --version in a console/terminal to see if you already have it installed.

Some features require ffmpeg to be installed.

On Windows, you need to have visual studio C++ build tools installed.

Common issues

Latest big features

  • Extensions

πŸ‘ Automatic installers

Automatic installers! (Download)

  1. Put the installer in a folder
  2. Run the installer for your operating system.
  3. Now run the webui's install script. Follow the steps at πŸ“¦ Installing

πŸ“¦ Docker

Links to community audio-webui docker projects
Note: The docker repositories are not maintained by me. And docker related issues should go to the docker repositories. If an issue is related to audio-webui directly, create the issue here. Unless a fix has already been made.

πŸ’» Local install (Manual)

πŸ”½ Downloading

It is recommended to use git to download the webui, using git allows for easy updating.

To download using git, run git clone https://github.com/gitmylo/audio-webui in a console/terminal

πŸ“¦ Installing

Installation is done automatically in a venv when you run run.bat or run.sh (.bat on Windows, .sh on Linux/MacOS).

πŸ”Ό Updating

To update,
run update.bat on windows, update.sh on linux/macos
OR run git pull in the folder your webui is installed in.

πŸƒβ€ Running

Running should be as simple as running run.bat or run.sh depending on your OS. Everything should get installed automatically.

If there's an issue with running, please create an issue

πŸ’» Google colab notebook

Open in colab Open in github

πŸ’» Common command line flags

Name Args Short Usage Description
--skip-install [None] -si -si Skip installing packages
--skip-venv [None] -sv -sv Skip creating/activating venv, also skips install. (for advanced users)
--no-data-cache [None] [None] --no-data-cache Don't change the default dir for huggingface_hub models. (This might fix some models not loading)
--launch [None] [None] --launch Automatically open the webui in your browser once it launches.
--share [None] -s -s Share the gradio instance publicly
--username username (str) -u, --user -u username Set the username for gradio
--password password (str) -p, --pass -p password Set the password for gradio
--theme theme (str) [None] --theme "gradio/soft" Set the theme for gradio
--listen [None] -l -l Listen a server, allowing other devices within your local network to access the server. (or outside if port forwarded)
--port port (int) [None] --port 12345 Set a custom port to listen on, by default a port is picked automatically

✨ Current goals and features ✨

moved to a separate readme

More readme

Link