|
|
--- |
|
|
title: Invoke |
|
|
--- |
|
|
|
|
|
<!-- |
|
|
The docs are generated with using mkdocs: https://www.mkdocs.org/ |
|
|
|
|
|
To preview the docs locally, first install the requirements: |
|
|
```sh |
|
|
pip install -e ".[docs]" |
|
|
``` |
|
|
|
|
|
Then run the mkdocs server with `mkdocs serve`, or, on Unix systems, `make docs`. |
|
|
--> |
|
|
|
|
|
<!-- CSS styling --> |
|
|
|
|
|
<div align="center" markdown> |
|
|
|
|
|
[](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] |
|
|
[![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] |
|
|
|
|
|
[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 commit to main badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/main?icon=github&color=yellow&label=last%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 |
|
|
|
|
|
</div> |
|
|
|
|
|
<a href="https://github.com/invoke-ai/InvokeAI">Invoke</a> 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. |
|
|
|
|
|
<div align="center"><img src="assets/invoke-web-server-1.png" width=640></div> |
|
|
|
|
|
## Installation |
|
|
|
|
|
The [installer script](installation/installer.md) is the easiest way to install and update the application. |
|
|
|
|
|
You can also install Invoke as python package [via PyPI](installation/manual.md) or [docker](installation/docker.md). |
|
|
|
|
|
See the [installation section](./installation/index.md) for more information. |
|
|
|
|
|
## Help |
|
|
|
|
|
Please first check the [FAQ](./faq.md) to see if there is a fix for your issue or answer to your question. |
|
|
|
|
|
If you still have a problem, [create an issue](https://github.com/invoke-ai/InvokeAI/issues) or ask for help on [Discord](https://discord.gg/ZmtBAhwWhy). |
|
|
|
|
|
## Training |
|
|
|
|
|
Invoke Training has moved to its own repository, with a dedicated UI for accessing common scripts like Textual Inversion and LoRA training. |
|
|
|
|
|
You can find more by visiting the repo at <https://github.com/invoke-ai/invoke-training>. |
|
|
|
|
|
## Contributing |
|
|
|
|
|
We welcome contributions, big and small. Please review our [contributing guide](contributing/index.md) if you'd like make a contribution. |
|
|
|
|
|
This software is a combined effort of [people across the world](contributing/contributors.md). We thank them for their time, hard work and effort! |
|
|
|
