Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 5.91 KB

README.md

File metadata and controls

96 lines (64 loc) · 5.91 KB
Raw

AIGC-webui

en | 中文 | हिंदी | español | العربية | português | 日本語

AIGC-webui is a universal interface for AIGC (AI Generated Content). For example, you can use it to make chatGPT work the way you like, to generate images / musics, or you can use it to reading pdf files, processing excel tables with prompts.

Screenshot:

screenshot

screenshot2

Features

  • A variety of AIGC models to choose from, such as ChatGPT, LLaMA, Stable Diffusion，Riffusion, or some cool models you make by yourself.
  • Multimodal generation ability, such as images, musics, code blocks, and so on.
  • Multimodal inputs are supported, including text, file, and voice inputs.
  • chatPDF, you can import pdf files, and chat with the file in analysis mode.
  • chatExcel, you can import Excel files and then process these tables through prompts or voice instructions.
  • Comes with an addon, named gpt3-5-enhanced, that enrich ChatGPT with the ability to generate images and musics.
  • Comes with an addin, named translate, that can translates user input automatically, and another plugin beautify than can optimize user's prompt for image generation.
  • An extendable framework, easy to make your own extension. （Guidelines）
  • Conversation and Message management.
  • predefined prompt shortcuts
  • etc.

TODO

  • images input
  • audio/video input
  • etc.

Installation and Running

video tutorial

For Windows User

You can automatically install and run this project by simply double-clicking the webui.bat after downloading this project, or you may choose to install it manually by yourself:

  1. Install nodejs
  2. Install git.
  3. Download this project: open the terminal (Windows + R, type "cmd" and press Enter), and execute git clone https://github.com/hku/aigc-webui.git
  4. Install dependencies: Navigate into the project folder(cd aigc-webui), and execute npm install
  5. Customize the environment: make a copy of the example environment variables file .env.local.example, name it .env.local, Fill in the keys or tokens in the .env.local file. The meanings of the keys and the application links for them are listed in the table below.
environment variables Free application links Usage
OPENAI_API_KEY openai For calling OpenAI's official API, required for the model GPT-3.5 and GPT-3.5-enhanced shipped with this repository.
REPLICATE_API_TOKEN replicate For calling replicate APIs，required for gpt3-5-enhanced,replicate-* models
BAIDU_TRANSLATE_APPID, BAIDU_TRANSLATE_SECRET baidu翻译 For calling Baidu translation API，required for the prompt modifiers translate and beautify shipped with this repository
  1. deploy the web service, by execute npm run dev

Open the address in your browser: http://localhost:3000, enjoy!

For Mac User

You can automatically install and run this project by excuting sh webui_for_mac.sh after downloading this project, or you may choose to install it manually by yourself:

  1. Install nodejs
  2. Install git.
  3. Download this project: open the terminal, and execute：git clone https://github.com/hku/aigc-webui.git
  4. Install dependencies: Navigate into the project folder(cd aigc-webui), and execute npm install
  5. Customize the environment: make a copy of the example environment variables file .env.local.example, name it .env.local, Fill in the keys or tokens in the .env.local file. The meanings of the keys and the application links for them are listed in the table below.
environment variables Free application links Usage
OPENAI_API_KEY openai For calling OpenAI's official API, required for the model GPT-3.5 and GPT-3.5-enhanced shipped with this repository.
REPLICATE_API_TOKEN replicate For calling replicate APIs，required for gpt3-5-enhanced,replicate-* models
BAIDU_TRANSLATE_APPID, BAIDU_TRANSLATE_SECRET Baidu Translate For calling Baidu translation API，required for the prompt modifiers translate and beautify shipped with this repository
  1. deploy the web service, by execute npm run dev

Open the address in your browser: http://localhost:3000, enjoy!

Develop Your Own Extensions

aigc-webui has a simple pluggable structure. You can develop your own extensions easily，Check guidelines

Credits

Contact

If you have any questions, feel free to reach out to me on Twitter.