mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
Updated new user flow
This commit is contained in:
Millun Atluri
parent
5300e353d8
commit
562c937a14
@ -16,7 +16,7 @@ If you don't feel ready to make a code contribution yet, no problem! You can als
|
|||||||
There are two paths to making a development contribution:
|
There are two paths to making a development contribution:
|
||||||
|
|
||||||
1. Choosing an open issue to address. Open issues can be found in the [Issues](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen) section of the InvokeAI repository. These are tagged by the issue type (bug, enhancement, etc.) along with the “good first issues” tag denoting if they are suitable for first time contributors.
|
1. Choosing an open issue to address. Open issues can be found in the [Issues](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen) section of the InvokeAI repository. These are tagged by the issue type (bug, enhancement, etc.) along with the “good first issues” tag denoting if they are suitable for first time contributors.
|
||||||
1. Additional items can be found on our roadmap <******************************link to roadmap>******************************. The roadmap is organized in terms of priority, and contains features of varying size and complexity. If there is an inflight item you’d like to help with, reach out to the contributor assigned to the item to see how you can help.
|
1. Additional items can be found on our [roadmap](https://github.com/orgs/invoke-ai/projects/7). The roadmap is organized in terms of priority, and contains features of varying size and complexity. If there is an inflight item you’d like to help with, reach out to the contributor assigned to the item to see how you can help.
|
||||||
2. Opening a new issue or feature to add. **Please make sure you have searched through existing issues before creating new ones.**
|
2. Opening a new issue or feature to add. **Please make sure you have searched through existing issues before creating new ones.**
|
||||||
|
|
||||||
*Regardless of what you choose, please post in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord before you start development in order to confirm that the issue or feature is aligned with the current direction of the project. We value our contributors time and effort and want to ensure that no one’s time is being misspent.*
|
*Regardless of what you choose, please post in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord before you start development in order to confirm that the issue or feature is aligned with the current direction of the project. We value our contributors time and effort and want to ensure that no one’s time is being misspent.*
|
||||||
|
|||||||
@ -11,6 +11,33 @@ title: Home
|
|||||||
```
|
```
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
<!-- CSS styling -->
|
||||||
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.2.1/css/fontawesome.min.css">
|
||||||
|
<style>
|
||||||
|
.button {
|
||||||
|
width: 300px;
|
||||||
|
height: 50px;
|
||||||
|
background-color: #448AFF;
|
||||||
|
color: #fff;
|
||||||
|
font-size: 16px;
|
||||||
|
border: none;
|
||||||
|
cursor: pointer;
|
||||||
|
border-radius: 0.2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.button-container {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(3, 300px);
|
||||||
|
gap: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.button:hover {
|
||||||
|
background-color: #526CFE;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<div align="center" markdown>
|
<div align="center" markdown>
|
||||||
|
|
||||||
|
|
||||||
@ -70,61 +97,23 @@ 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,
|
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.
|
Mac and Linux machines, and runs on GPU cards with as little as 4 GB of RAM.
|
||||||
|
|
||||||
**Quick links**: [<a href="https://discord.gg/ZmtBAhwWhy">Discord Server</a>]
|
|
||||||
[<a href="https://github.com/invoke-ai/InvokeAI/">Code and Downloads</a>] [<a
|
|
||||||
href="https://github.com/invoke-ai/InvokeAI/issues">Bug Reports</a>] [<a
|
|
||||||
href="https://github.com/invoke-ai/InvokeAI/discussions">Discussion, Ideas &
|
|
||||||
Q&A</a>]
|
|
||||||
|
|
||||||
<div align="center"><img src="assets/invoke-web-server-1.png" width=640></div>
|
<div align="center"><img src="assets/invoke-web-server-1.png" width=640></div>
|
||||||
|
|
||||||
!!! note
|
!!! Note
|
||||||
|
|
||||||
This fork is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster.
|
This project is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates as it will help aid response time.
|
||||||
|
|
||||||
## :octicons-package-dependencies-24: Installation
|
## :octicons-link-24: Quick Links
|
||||||
|
|
||||||
This fork is supported across Linux, Windows and Macintosh. Linux users can use
|
<div class="button-container">
|
||||||
either an Nvidia-based card (with CUDA support) or an AMD card (using the ROCm
|
<a href="installation/INSTALLATION"> <button class="button">Installation</button> </a>
|
||||||
driver).
|
<a href="features/"> <button class="button">Features</button> </a>
|
||||||
|
<a href="help/gettingStartedWithAI/"> <button class="button">Getting Started</button> </a>
|
||||||
### [Installation Getting Started Guide](installation)
|
<a href="contributing/CONTRIBUTING/"> <button class="button">Contributing</button> </a>
|
||||||
#### **[Automated Installer](installation/010_INSTALL_AUTOMATED.md)**
|
<a href="https://github.com/invoke-ai/InvokeAI/"> <button class="button">Code and Downloads</button> </a>
|
||||||
✅ This is the recommended installation method for first-time users.
|
<a href="https://github.com/invoke-ai/InvokeAI/issues"> <button class="button">Bug Reports </button> </a>
|
||||||
#### [Manual Installation](installation/020_INSTALL_MANUAL.md)
|
<a href="https://discord.gg/ZmtBAhwWhy"> <button class="button"> Join the Discord Server!</button> </a>
|
||||||
This method is recommended for experienced users and developers
|
</div>
|
||||||
#### [Docker Installation](installation/040_INSTALL_DOCKER.md)
|
|
||||||
This method is recommended for those familiar with running Docker containers
|
|
||||||
### Other Installation Guides
|
|
||||||
- [PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md)
|
|
||||||
- [XFormers](installation/070_INSTALL_XFORMERS.md)
|
|
||||||
- [CUDA and ROCm Drivers](installation/030_INSTALL_CUDA_AND_ROCM.md)
|
|
||||||
- [Installing New Models](installation/050_INSTALLING_MODELS.md)
|
|
||||||
|
|
||||||
## :fontawesome-solid-computer: Hardware Requirements
|
|
||||||
|
|
||||||
### :octicons-cpu-24: System
|
|
||||||
|
|
||||||
You wil need one of the following:
|
|
||||||
|
|
||||||
- :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory.
|
|
||||||
- :simple-amd: An AMD-based graphics card with 4 GB or more VRAM memory (Linux
|
|
||||||
only)
|
|
||||||
- :fontawesome-brands-apple: An Apple computer with an M1 chip.
|
|
||||||
|
|
||||||
We do **not recommend** the following video cards due to issues with their
|
|
||||||
running in half-precision mode and having insufficient VRAM to render 512x512
|
|
||||||
images in full-precision mode:
|
|
||||||
|
|
||||||
- NVIDIA 10xx series cards such as the 1080ti
|
|
||||||
- GTX 1650 series cards
|
|
||||||
- GTX 1660 series cards
|
|
||||||
|
|
||||||
### :fontawesome-solid-memory: Memory and Disk
|
|
||||||
|
|
||||||
- At least 12 GB Main Memory RAM.
|
|
||||||
- At least 18 GB of free disk space for the machine learning model, Python, and
|
|
||||||
all its dependencies.
|
|
||||||
|
|
||||||
|
|
||||||
## :octicons-gift-24: InvokeAI Features
|
## :octicons-gift-24: InvokeAI Features
|
||||||
|
|||||||
@ -1,6 +1,4 @@
|
|||||||
---
|
# Overview
|
||||||
title: Overview
|
|
||||||
---
|
|
||||||
|
|
||||||
We offer several ways to install InvokeAI, each one suited to your
|
We offer several ways to install InvokeAI, each one suited to your
|
||||||
experience and preferences. We suggest that everyone start by
|
experience and preferences. We suggest that everyone start by
|
||||||
@ -15,6 +13,48 @@ See the [troubleshooting
|
|||||||
section](010_INSTALL_AUTOMATED.md#troubleshooting) of the automated
|
section](010_INSTALL_AUTOMATED.md#troubleshooting) of the automated
|
||||||
install guide for frequently-encountered installation issues.
|
install guide for frequently-encountered installation issues.
|
||||||
|
|
||||||
|
This fork is supported across Linux, Windows and Macintosh. Linux users can use
|
||||||
|
either an Nvidia-based card (with CUDA support) or an AMD card (using the ROCm
|
||||||
|
driver).
|
||||||
|
|
||||||
|
### [Installation Getting Started Guide](installation)
|
||||||
|
#### **[Automated Installer](010_INSTALL_AUTOMATED.md)**
|
||||||
|
✅ This is the recommended installation method for first-time users.
|
||||||
|
#### [Manual Installation](020_INSTALL_MANUAL.md)
|
||||||
|
This method is recommended for experienced users and developers
|
||||||
|
#### [Docker Installation](040_INSTALL_DOCKER.md)
|
||||||
|
This method is recommended for those familiar with running Docker containers
|
||||||
|
### Other Installation Guides
|
||||||
|
- [PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md)
|
||||||
|
- [XFormers](installation/070_INSTALL_XFORMERS.md)
|
||||||
|
- [CUDA and ROCm Drivers](installation/030_INSTALL_CUDA_AND_ROCM.md)
|
||||||
|
- [Installing New Models](installation/050_INSTALLING_MODELS.md)
|
||||||
|
|
||||||
|
## :fontawesome-solid-computer: Hardware Requirements
|
||||||
|
|
||||||
|
### :octicons-cpu-24: System
|
||||||
|
|
||||||
|
You wil need one of the following:
|
||||||
|
|
||||||
|
- :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory.
|
||||||
|
- :simple-amd: An AMD-based graphics card with 4 GB or more VRAM memory (Linux
|
||||||
|
only)
|
||||||
|
- :fontawesome-brands-apple: An Apple computer with an M1 chip.
|
||||||
|
|
||||||
|
### :fontawesome-solid-memory: Memory and Disk
|
||||||
|
|
||||||
|
- At least 12 GB Main Memory RAM.
|
||||||
|
- At least 18 GB of free disk space for the machine learning model, Python, and
|
||||||
|
all its dependencies.
|
||||||
|
|
||||||
|
We do **not recommend** the following video cards due to issues with their
|
||||||
|
running in half-precision mode and having insufficient VRAM to render 512x512
|
||||||
|
images in full-precision mode:
|
||||||
|
|
||||||
|
- NVIDIA 10xx series cards such as the 1080ti
|
||||||
|
- GTX 1650 series cards
|
||||||
|
- GTX 1660 series cards
|
||||||
|
|
||||||
## Installation options
|
## Installation options
|
||||||
|
|
||||||
1. [Automated Installer](010_INSTALL_AUTOMATED.md)
|
1. [Automated Installer](010_INSTALL_AUTOMATED.md)
|
||||||
@ -36,7 +36,6 @@ theme:
|
|||||||
- navigation.instant
|
- navigation.instant
|
||||||
- navigation.tabs
|
- navigation.tabs
|
||||||
- navigation.tabs.sticky
|
- navigation.tabs.sticky
|
||||||
- navigation.top
|
|
||||||
- navigation.tracking
|
- navigation.tracking
|
||||||
- navigation.indexes
|
- navigation.indexes
|
||||||
- navigation.path
|
- navigation.path
|
||||||
@ -102,9 +101,9 @@ plugins:
|
|||||||
nav:
|
nav:
|
||||||
- Home: 'index.md'
|
- Home: 'index.md'
|
||||||
- Installation:
|
- Installation:
|
||||||
- Overview: 'installation/index.md'
|
- Overview: 'installation/INSTALLATION.md'
|
||||||
- Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md'
|
- Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md'
|
||||||
- Installing manually: 'installation/020_INSTALL_MANUAL.md'
|
- Installing Manually: 'installation/020_INSTALL_MANUAL.md'
|
||||||
- NVIDIA Cuda / AMD ROCm: 'installation/030_INSTALL_CUDA_AND_ROCM.md'
|
- NVIDIA Cuda / AMD ROCm: 'installation/030_INSTALL_CUDA_AND_ROCM.md'
|
||||||
- Installing with Docker: 'installation/040_INSTALL_DOCKER.md'
|
- Installing with Docker: 'installation/040_INSTALL_DOCKER.md'
|
||||||
- Installing Models: 'installation/050_INSTALLING_MODELS.md'
|
- Installing Models: 'installation/050_INSTALLING_MODELS.md'
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user