InvokeAI/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

107 lines
6.9 KiB
Markdown
Raw Normal View History

<div align="center">
2024-01-04 23:49:53 +08:00
![project hero](https://github.com/invoke-ai/InvokeAI/assets/31807370/6e3728c7-e90e-4711-905c-3b55844ff5be)
2023-06-17 05:27:02 +08:00
2024-04-25 21:29:26 +08:00
# Invoke - Professional Creative AI Tools for Visual Media
2024-04-25 21:29:26 +08:00
## To learn more about Invoke, or implement our Business solutions, visit [invoke.com](https://www.invoke.com/about)
[![discord badge]][discord link] [![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] [![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] [![translation status badge]][translation status link]
</div>
2024-04-25 21:29:26 +08:00
Invoke is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. Invoke offers an industry leading web-based UI, and serves as the foundation for multiple commercial products.
2024-04-25 21:29:26 +08:00
**Quick links**: [Installation](https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/) - [Discord](https://discord.gg/ZmtBAhwWhy) - [Documentation and Tutorials](https://invoke-ai.github.io/InvokeAI) - [Bug Reports](https://github.com/invoke-ai/InvokeAI/issues) - [Contributing](https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/)
2024-04-25 21:29:26 +08:00
<div align="center">
2024-01-04 23:49:53 +08:00
![Highlighted Features - Canvas and Workflows](https://github.com/invoke-ai/InvokeAI/assets/31807370/708f7a82-084f-4860-bfbe-e2588c53548d)
</div>
2023-06-17 05:27:02 +08:00
## Quick Start
2022-12-06 11:45:37 +08:00
2024-04-25 21:29:26 +08:00
1. Download and unzip the installer from the bottom of the [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest).
2. Run the installer script.
2024-04-25 21:29:26 +08:00
- **Windows**: Double-click on the `install.bat` script.
- **macOS**: Open a Terminal window, drag the file `install.sh` from Finder into the Terminal, and press enter.
- **Linux**: Run `install.sh`.
2024-04-25 21:29:26 +08:00
3. When prompted, enter a location for the install and select your GPU type.
4. Once the install finishes, find the directory you selected during install. The default location is `C:\Users\Username\invokeai` for Windows or `~/invokeai` for Linux/macOS.
6. Run the launcher script (`invoke.bat` for Windows, `invoke.sh` for macOS and Linux) - the same way you ran the installer script in step 2.
7. Select option 1 to start the application. Once it starts up, open your browser and go to <http://localhost:9090>.
8. Open the model manager tab to install a starter model and then you'll be ready to generate.
2024-04-25 21:29:26 +08:00
More detail, including hardware requirements and manual install instructions, are available in the [installation documentation](https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/).
2022-08-26 10:57:30 +08:00
## Features
2022-08-26 10:57:30 +08:00
2024-04-25 21:29:26 +08:00
Full details on features can be found in [our documentation](https://invoke-ai.github.io/InvokeAI/features/).
2024-04-25 21:29:26 +08:00
### Web Server & UI
2024-04-25 21:29:26 +08:00
Invoke runs a locally hosted web server & React UI with an industry-leading user experience.
2024-04-25 21:29:26 +08:00
### Unified Canvas
2024-04-25 21:29:26 +08:00
The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/out-painting, 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.
2024-04-25 21:29:26 +08:00
### Workflows & Nodes
2024-04-25 21:29:26 +08:00
Invoke offers a fully featured workflow management solution, enabling users to combine the power of node-based workflows with the easy of a UI. This allows for customizable generation pipelines to be developed and shared by users looking to create specific workflows to support their production use-cases.
2022-08-24 06:26:28 +08:00
2024-04-25 21:29:26 +08:00
### Board & Gallery Management
2024-04-25 21:29:26 +08:00
Invoke features an organized gallery system for easily storing, accessing, and remixing your content in the Invoke workspace. Images can be dragged/dropped onto any Image-base UI element in the application, and rich metadata within the Image allows for easy recall of key prompts or settings used in your workflow.
2022-08-24 06:26:28 +08:00
### Other features
2024-04-25 21:29:26 +08:00
- Support for both ckpt and diffusers models
- SD1.5, SD2.0, and SDXL support
- Upscaling Tools
- Embedding Manager & Support
- Model Manager & Support
- Workflow creation & management
- Node-Based Architecture
2022-08-22 07:57:48 +08:00
2024-04-25 21:29:26 +08:00
## Troubleshooting, FAQ and Support
2024-04-25 21:29:26 +08:00
Please review our **[FAQ](https://invoke-ai.github.io/InvokeAI/help/FAQ/)** for solutions to common installation problems and other issues.
2024-04-25 21:29:26 +08:00
For more help, please join our [Discord][discord link].
2022-08-30 11:08:04 +08:00
2023-07-06 04:53:37 +08:00
## Contributing
2024-04-25 21:29:26 +08:00
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.
2022-12-06 11:45:37 +08:00
2023-09-07 10:28:06 +08:00
Get started with contributing by reading our [Contribution documentation](https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/), joining the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) or the GitHub discussion board.
2023-02-19 16:13:38 +08:00
2024-04-25 21:29:26 +08:00
We hope you enjoy using Invoke as much as we enjoy creating it, and we hope you will elect to become part of our community.
2024-04-25 21:29:26 +08:00
## Thanks
2024-04-25 21:29:26 +08:00
Invoke is a combined effort of [passionate and talented people from across the world](https://invoke-ai.github.io/InvokeAI/other/CONTRIBUTORS/). We thank them for their time, hard work and effort.
2024-04-25 21:29:26 +08:00
Original portions of the software are Copyright © 2024 by respective contributors.
2022-08-24 21:31:17 +08:00
2024-04-25 21:29:26 +08:00
[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?query=branch%3Amain
[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=invoke-ai%2FInvokeAI
[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 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
[translation status badge]: https://hosted.weblate.org/widgets/invokeai/-/svg-badge.svg
[translation status link]: https://hosted.weblate.org/engage/invokeai/