invokeAI-docs

[](https://github.com/invoke-ai/InvokeAI) [![discord badge]][discord link] [![latest release badge]][latest release link] [![github stars badge]][github stars link] [![github forks badge]][github forks link] [![github open issues badge]][github open issues link] [![github open prs badge]][github open prs link] [ci checks on dev badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/development?label=CI%20status%20on%20dev&cache=900&icon=github [ci checks on dev link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Adevelopment [ci checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github [ci checks on main link]: https://github.com/invoke-ai/InvokeAI/actions/workflows/test-invoke-conda.yml [discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?icon=discord [discord link]: https://discord.gg/ZmtBAhwWhy [github forks badge]: https://flat.badgen.net/github/forks/invoke-ai/InvokeAI?icon=github [github forks link]: https://useful-forks.github.io/?repo=lstein%2Fstable-diffusion [github open issues badge]: https://flat.badgen.net/github/open-issues/invoke-ai/InvokeAI?icon=github [github open issues link]: https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen [github open prs badge]: https://flat.badgen.net/github/open-prs/invoke-ai/InvokeAI?icon=github [github open prs link]: https://github.com/invoke-ai/InvokeAI/pulls?q=is%3Apr+is%3Aopen [github stars badge]: https://flat.badgen.net/github/stars/invoke-ai/InvokeAI?icon=github [github stars link]: https://github.com/invoke-ai/InvokeAI/stargazers [latest release badge]: https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github [latest release link]: https://github.com/invoke-ai/InvokeAI/releases

InvokeAI is an implementation of Stable Diffusion, the open source text-to-image and image-to-image generator. It provides a streamlined process with various new features and options to aid the image generation process. It runs on Windows, Mac and Linux machines, and runs on GPU cards with as little as 4 GB of RAM.

:octicons-link-24: Quick Links

:octicons-gift-24: InvokeAI Features

Installation

• Automated Installer
• Manual Installation
• Docker Installation

The InvokeAI Web Interface

• WebUI overview
• WebUI hotkey reference guide
• WebUI Unified Canvas for Img2Img, inpainting and outpainting

Image Management

• Image2Image
• Adding custom styles and subjects
• Upscaling and Face Reconstruction
• Other Features

Model Management

• Installing
• Model Merging
• ControlNet Models
• Style/Subject Concepts and Embeddings
• Watermarking and the Not Safe for Work (NSFW) Checker

  Prompt Engineering

• Prompt Syntax

InvokeAI Configuration

• Guide to InvokeAI Runtime Settings
• Database Maintenance and other Command Line Utilities

:material-target: Troubleshooting

Please check out our :material-frequently-asked-questions: FAQ to get solutions for common installation problems and other issues.

:octicons-repo-push-24: Contributing

Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so.

Please take a look at our Contribution documentation to learn more about contributing to InvokeAI.

:octicons-person-24: Contributors

This software is a combined effort of various people from across the world. Check out the list of all these amazing people. We thank them for their time, hard work and effort.

:octicons-question-24: Support

For support, please use this repository’s GitHub Issues tracking service. Feel free to send me an email if you use and like the script.

Original portions of the software are Copyright (c) 2022-23 by The InvokeAI Team.

This site is open source. Improve this page.