diff --git a/README.md b/README.md index d01b89023f..e4f841641c 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,10 @@ [![latest release badge]][latest release link] [![github stars badge]][github stars link] [![github forks badge]][github forks link] -[![CI checks on main badge]][CI checks on main link] [![CI checks on dev badge]][CI checks on dev link] [![latest commit to dev badge]][latest commit to dev link] +[![CI checks on main badge]][CI checks on main link] [![latest commit to main badge]][latest commit to main 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 @@ -26,19 +24,13 @@ [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 commit to dev badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/development?icon=github&color=yellow&label=last%20dev%20commit&cache=900 -[latest commit to dev link]: https://github.com/invoke-ai/InvokeAI/commits/development +[latest commit to main badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/main?icon=github&color=yellow&label=last%20dev%20commit&cache=900 +[latest commit to main link]: https://github.com/invoke-ai/InvokeAI/commits/main [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 -This is a fork of -[CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion), -the open source text-to-image generator. It provides a streamlined -process with various new features and options to aid the image -generation process. It runs on Windows, macOS and Linux machines, with -GPU cards with as little as 4 GB of RAM. It provides both a polished -Web interface (see below), and an easy-to-use command-line interface. +InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface, interactive Command Line Interface, and also serves as the foundation for multiple commercial products. **Quick links**: [[How to Install](#installation)] [Discord Server] [Documentation and Tutorials] [Code and Downloads] [Bug Reports] [Discussion, Ideas & Q&A] @@ -46,6 +38,9 @@ _Note: InvokeAI is rapidly evolving. Please use the [Issues](https://github.com/invoke-ai/InvokeAI/issues) tab to report bugs and make feature requests. Be sure to use the provided templates. They will help us diagnose issues faster._ + +![canvas preview](docs/assets/canvas_preview.png) + # Getting Started with InvokeAI For full installation and upgrade instructions, please see: @@ -58,10 +53,7 @@ For full installation and upgrade instructions, please see: 5. Wait a while, until it is done. 6. The folder where you ran the installer from will now be filled with lots of files. If you are on Windows, double-click on the `invoke.bat` file. On macOS, open a Terminal window, drag `invoke.sh` from the folder into the Terminal, and press return. On Linux, run `invoke.sh` 7. Press 2 to open the "browser-based UI", press enter/return, wait a minute or two for Stable Diffusion to start up, then open your browser and go to http://localhost:9090. -8. Type `banana sushi` in the box on the top left and click `Invoke`: - -
- +8. Type `banana sushi` in the box on the top left and click `Invoke` ## Table of Contents @@ -76,7 +68,7 @@ For full installation and upgrade instructions, please see: 8. [Support](#support) 9. [Further Reading](#further-reading) -### Installation +## Installation This fork is supported across Linux, Windows and Macintosh. Linux users can use either an Nvidia-based card (with CUDA support) or an @@ -108,52 +100,41 @@ to render 512x512 images. - At least 12 GB of free disk space for the machine learning model, Python, and all its dependencies. -**Note** -If you have a Nvidia 10xx series card (e.g. the 1080ti), please -run the dream script in full-precision mode as shown below. +## Features -Similarly, specify full-precision mode on Apple M1 hardware. +Feature documentation can be reviewed by navigating to [the InvokeAI Documentation page](https://invoke-ai.github.io/InvokeAI/features/) -Precision is auto configured based on the device. If however you encounter -errors like 'expected type Float but found Half' or 'not implemented for Half' -you can try starting `invoke.py` with the `--precision=float32` flag to your initialization command +### *Web Server & UI* +InvokeAI offers a locally hosted Web Server & React Frontend, with an industry leading user experience. The Web-based UI allows for simple and intuitive workflows, and is responsive for use on mobile devices and tablets accessing the web server. -```bash -(invokeai) ~/InvokeAI$ python scripts/invoke.py --precision=float32 -``` -Or by updating your InvokeAI configuration file with this argument. +### *Unified Canvas* +The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/outpainting, brush tools, and more. This creative tool unlocks the capability for artists to create with AI as a creative collaborator, and can be used to augment AI-generated imagery, sketches, photography, renders, and more. -### Features +### *Advanced Prompt Syntax* +InvokeAI's advanced prompt syntax allows for token weighting, cross-attention control, and prompt blending, allowing for fine-tuned tweaking of your invocations and exploration of the latent space. -#### Major Features +### *Command Line Interface* +For users utilizing a terminal-based environment, or who want to take advantage of CLI features, InvokeAI offers an extensive and actively supported command-line interface that provides the full suite of generation functionality available in the tool. -- [Web Server](https://invoke-ai.github.io/InvokeAI/features/WEB/) -- [Interactive Command Line Interface](https://invoke-ai.github.io/InvokeAI/features/CLI/) -- [Image To Image](https://invoke-ai.github.io/InvokeAI/features/IMG2IMG/) -- [Inpainting Support](https://invoke-ai.github.io/InvokeAI/features/INPAINTING/) -- [Outpainting Support](https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/) -- [Upscaling, face-restoration and outpainting](https://invoke-ai.github.io/InvokeAI/features/POSTPROCESS/) -- [Reading Prompts From File](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#reading-prompts-from-a-file) -- [Prompt Blending](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#prompt-blending) -- [Thresholding and Perlin Noise Initialization Options](https://invoke-ai.github.io/InvokeAI/features/OTHER/#thresholding-and-perlin-noise-initialization-options) -- [Negative/Unconditioned Prompts](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#negative-and-unconditioned-prompts) -- [Variations](https://invoke-ai.github.io/InvokeAI/features/VARIATIONS/) -- [Personalizing Text-to-Image Generation](https://invoke-ai.github.io/InvokeAI/features/TEXTUAL_INVERSION/) -- [Simplified API for text to image generation](https://invoke-ai.github.io/InvokeAI/features/OTHER/#simplified-api) +### Other features +- *Noise Control & Tresholding* +- *Popular Sampler Support* +- *Upscaling & Face Restoration Tools* +- *Embedding Manager & Support* +- *Model Manager & Support* -#### Other Features - -- [Google Colab](https://invoke-ai.github.io/InvokeAI/features/OTHER/#google-colab) -- [Seamless Tiling](https://invoke-ai.github.io/InvokeAI/features/OTHER/#seamless-tiling) -- [Shortcut: Reusing Seeds](https://invoke-ai.github.io/InvokeAI/features/OTHER/#shortcuts-reusing-seeds) -- [Preload Models](https://invoke-ai.github.io/InvokeAI/features/OTHER/#preload-models) +### Coming Soon +- *2.0/2.1 Model Support* +- *Depth2Img Support* +- *Node-Based Architecture & UI* +- And more... ### Latest Changes For our latest changes, view our [Release Notes](https://github.com/invoke-ai/InvokeAI/releases) -### Troubleshooting +## Troubleshooting Please check out our **[Q&A](https://invoke-ai.github.io/InvokeAI/help/TROUBLESHOOT/#faq)** to get solutions for common installation problems and other issues. @@ -183,13 +164,7 @@ their time, hard work and effort. ### 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. +For support, please use this repository's GitHub Issues tracking service, or join the Discord. -Original portions of the software are Copyright (c) 2022 -[Lincoln D. Stein](https://github.com/lstein) +Original portions of the software are Copyright (c) 2023 by respective contributors. -### Further Reading - -Please see the original README for more information on this software and underlying algorithm, -located in the file [README-CompViz.md](https://invoke-ai.github.io/InvokeAI/other/README-CompViz/). diff --git a/docs/assets/canvas_preview.png b/docs/assets/canvas_preview.png new file mode 100644 index 0000000000..dba4ee2ca2 Binary files /dev/null and b/docs/assets/canvas_preview.png differ