Skip to content

Commit b6ed5ea

Browse files
committed
update installation docs for 2.3.1 installer screens
1 parent 694d5aa commit b6ed5ea

4 files changed

Lines changed: 145 additions & 46 deletions

File tree

64.1 KB
Loading
128 KB
Loading
114 KB
Loading

docs/installation/010_INSTALL_AUTOMATED.md

Lines changed: 145 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ experimental versions later.
4040
this, open up a command-line window ("Terminal" on Linux and
4141
Macintosh, "Command" or "Powershell" on Windows) and type `python
4242
--version`. If Python is installed, it will print out the version
43-
number. If it is version `3.9.1` or `3.10.x`, you meet
44-
requirements.
45-
43+
number. If it is version `3.9.*` or `3.10.*`, you meet
44+
requirements. We do not recommend using Python 3.11 or higher,
45+
as not all the libraries that InvokeAI depends on work properly
46+
with this version.
4647

4748
!!! warning "What to do if you have an unsupported version"
4849

4950
Go to [Python Downloads](https://www.python.org/downloads/)
5051
and download the appropriate installer package for your
5152
platform. We recommend [Version
5253
3.10.9](https://www.python.org/downloads/release/python-3109/),
53-
which has been extensively tested with InvokeAI. At this time
54-
we do not recommend Python 3.11.
54+
which has been extensively tested with InvokeAI.
5555

5656
_Please select your platform in the section below for platform-specific
5757
setup requirements._
@@ -150,7 +150,7 @@ experimental versions later.
150150

151151
```cmd
152152
C:\Documents\Linco> cd InvokeAI-Installer
153-
C:\Documents\Linco\invokeAI> install.bat
153+
C:\Documents\Linco\invokeAI> .\install.bat
154154
```
155155
156156
7. **Select the location to install InvokeAI**: The script will ask you to choose where to install InvokeAI. Select a
@@ -167,6 +167,11 @@ experimental versions later.
167167
`/home/YourName/invokeai` on Linux systems, and `/Users/YourName/invokeai`
168168
on Macintoshes, where "YourName" is your login name.
169169
170+
-If you have previously installed InvokeAI, you will be asked to
171+
confirm whether you want to reinstall into this directory. You
172+
may choose to reinstall, in which case your version will be upgraded,
173+
or choose a different directory.
174+
170175
- The script uses tab autocompletion to suggest directory path completions.
171176
Type part of the path (e.g. "C:\Users") and press ++tab++ repeatedly
172177
to suggest completions.
@@ -181,11 +186,6 @@ experimental versions later.
181186
are unsure what GPU you are using, you can ask the installer to
182187
guess.
183188
184-
<figure markdown>
185-
![choose-gpu-screenshot](../assets/installer-walkthrough/choose-gpu.png)
186-
</figure>
187-
188-
189189
9. **Watch it go!**: Sit back and let the install script work. It will install the third-party
190190
libraries needed by InvokeAI and the application itself.
191191
@@ -197,25 +197,138 @@ experimental versions later.
197197
minutes and nothing is happening, you can interrupt the script with ^C. You
198198
may restart it and it will pick up where it left off.
199199
200-
10. **Post-install Configuration**: After installation completes, the installer will launch the
201-
configuration script, which will guide you through the first-time
202-
process of selecting one or more Stable Diffusion model weights
203-
files, downloading and configuring them. We provide a list of
204-
popular models that InvokeAI performs well with. However, you can
205-
add more weight files later on using the command-line client or
206-
the Web UI. See [Installing Models](050_INSTALLING_MODELS.md) for
207-
details.
208-
209200
<figure markdown>
210-
![downloading-models-screenshot](../assets/installer-walkthrough/downloading-models.png)
201+
![initial-settings-screenshot](../assets/installer-walkthrough/settings-form.png)
211202
</figure>
212203
213-
If you have already downloaded the weights file(s) for another Stable
214-
Diffusion distribution, you may skip this step (by selecting "skip" when
215-
prompted) and configure InvokeAI to use the previously-downloaded files. The
216-
process for this is described in [Installing Models](050_INSTALLING_MODELS.md).
204+
10. **Post-install Configuration**: After installation completes, the
205+
installer will launch the configuration form, which will guide you
206+
through the first-time process of adjusting some of InvokeAI's
207+
startup settings. To move around this form use ctrl-N for
208+
&lt;N&gt;ext and ctrl-P for &lt;P&gt;revious, or use &lt;tab&gt;
209+
and shift-&lt;tab&gt; to move forward and back. Once you are in a
210+
multi-checkbox field use the up and down cursor keys to select the
211+
item you want, and &lt;space&gt; to toggle it on and off. Within
212+
a directory field, pressing &lt;tab&gt; will provide autocomplete
213+
options.
214+
215+
Generally the defaults are fine, and you can come back to this screen at
216+
any time to tweak your system. Here are the options you can adjust:
217+
218+
- ***Output directory for images***
219+
This is the path to a directory in which InvokeAI will store all its
220+
generated images.
221+
222+
- ***NSFW checker***
223+
If checked, InvokeAI will test images for potential sexual content
224+
and blur them out if found.
225+
226+
- ***HuggingFace Access Token***
227+
InvokeAI has the ability to download embedded styles and subjects
228+
from the HuggingFace Concept Library on-demand. However, some of
229+
the concept library files are password protected. To make download
230+
smoother, you can set up an account at huggingface.co, obtain an
231+
access token, and paste it into this field. Note that you paste
232+
to this screen using ctrl-shift-V
233+
234+
- ***Free GPU memory after each generation***
235+
This is useful for low-memory machines and helps minimize the
236+
amount of GPU VRAM used by InvokeAI.
237+
238+
- ***Enable xformers support if available***
239+
If the xformers library was successfully installed, this will activate
240+
it to reduce memory consumption and increase rendering speed noticeably.
241+
Note that xformers has the side effect of generating slightly different
242+
images even when presented with the same seed and other settings.
243+
244+
- ***Force CPU to be used on GPU systems***
245+
This will use the (slow) CPU rather than the accelerated GPU. This
246+
can be used to generate images on systems that don't have a compatible
247+
GPU.
248+
249+
- ***Precision***
250+
This controls whether to use float32 or float16 arithmetic.
251+
float16 uses less memory but is also slightly less accurate.
252+
Ordinarily the right arithmetic is picked automatically ("auto"),
253+
but you may have to use float32 to get images on certain systems
254+
and graphics cards. The "autocast" option is deprecated and
255+
shouldn't be used unless you are asked to by a member of the team.
256+
257+
- ***Number of models to cache in CPU memory***
258+
This allows you to keep models in memory and switch rapidly among
259+
them rather than having them load from disk each time. This slider
260+
controls how many models to keep loaded at once. Each
261+
model will use 2-4 GB of RAM, so use this cautiously
262+
263+
- ***Directory containing embedding/textual inversion files***
264+
This is the directory in which you can place custom embedding
265+
files (.pt or .bin). During startup, this directory will be
266+
scanned and InvokeAI will print out the text terms that
267+
are available to trigger the embeddings.
268+
269+
At the bottom of the screen you will see a checkbox for accepting
270+
the CreativeML Responsible AI License. You need to accept the license
271+
in order to download Stable Diffusion models from the next screen.
272+
273+
_You can come back to the startup options form_ as many times as you like.
274+
From the `invoke.sh` or `invoke.bat` launcher, select option (6) to relaunch
275+
this script. On the command line, it is named `invokeai-configure`.
276+
277+
11. **Downloading Models**: After you press `[NEXT]` on the screen, you will be taken
278+
to another screen that prompts you to download a series of starter models. The ones
279+
we recommend are preselected for you, but you are encouraged to use the checkboxes to
280+
pick and choose.
281+
You will probably wish to download `autoencoder-840000` for use with models that
282+
were trained with an older version of the Stability VAE.
217283
218-
11. **Running InvokeAI for the first time**: The script will now exit and you'll be ready to generate some images. Look
284+
<figure markdown>
285+
![select-models-screenshot](../assets/installer-walkthrough/installing-models.png)
286+
</figure>
287+
288+
Below the preselected list of starter models is a large text field which you can use
289+
to specify a series of models to import. You can specify models in a variety of formats,
290+
each separated by a space or newline. The formats accepted are:
291+
292+
- The path to a .ckpt or .safetensors file. On most systems, you can drag a file from
293+
the file browser to the textfield to automatically paste the path. Be sure to remove
294+
extraneous quotation marks and other things that come along for the ride.
295+
296+
- The path to a directory containing a combination of `.ckpt` and `.safetensors` files.
297+
The directory will be scanned from top to bottom (including subfolders) and any
298+
file that can be imported will be.
299+
300+
- A URL pointing to a `.ckpt` or `.safetensors` file. You can cut
301+
and paste directly from a web page, or simply drag the link from the web page
302+
or navigation bar. (You can also use ctrl-shift-V to paste into this field)
303+
The file will be downloaded and installed.
304+
305+
- The HuggingFace repository ID (repo_id) for a `diffusers` model. These IDs have
306+
the format _author_name/model_name_, as in `andite/anything-v4.0`
307+
308+
- The path to a local directory containing a `diffusers`
309+
model. These directories always have the file `model_index.json`
310+
at their top level.
311+
312+
_Select a directory for models to import_ You may select a local
313+
directory for autoimporting at startup time. If you select this
314+
option, the directory you choose will be scanned for new
315+
.ckpt/.safetensors files each time InvokeAI starts up, and any new
316+
files will be automatically imported and made available for your
317+
use.
318+
319+
_Convert imported models into diffusers_ When legacy checkpoint
320+
files are imported, you may select to use them unmodified (the
321+
default) or to convert them into `diffusers` models. The latter
322+
load much faster and have slightly better rendering performance,
323+
but not all checkpoint files can be converted. Note that Stable Diffusion
324+
Version 2.X files are **only** supported in `diffusers` format and will
325+
be converted regardless.
326+
327+
_You can come back to the model install form_ as many times as you like.
328+
From the `invoke.sh` or `invoke.bat` launcher, select option (5) to relaunch
329+
this script. On the command line, it is named `invokeai-model-install`.
330+
331+
12. **Running InvokeAI for the first time**: The script will now exit and you'll be ready to generate some images. Look
219332
for the directory `invokeai` installed in the location you chose at the
220333
beginning of the install session. Look for a shell script named `invoke.sh`
221334
(Linux/Mac) or `invoke.bat` (Windows). Launch the script by double-clicking
@@ -348,25 +461,11 @@ version (recommended), follow these steps:
348461
1. Start the `invoke.sh`/`invoke.bat` launch script from within the
349462
`invokeai` root directory.
350463

351-
2. Choose menu item (6) "Developer's Console". This will launch a new
352-
command line.
353-
354-
3. Type the following command:
355-
356-
```bash
357-
pip install InvokeAI --upgrade
358-
```
359-
4. Watch the installation run. Once it is complete, you may exit the
360-
command line by typing `exit`, and then start InvokeAI from the
361-
launch script as per usual.
362-
363-
364-
Alternatively, if you wish to get the most recent unreleased
365-
development version, perform the same steps to enter the developer's
366-
console, and then type:
367-
368-
```bash
369-
pip install https://github.com/invoke-ai/InvokeAI/archive/refs/heads/main.zip
370-
```
464+
2. Choose menu item (10) "Update InvokeAI".
371465

466+
3. This will launch a menu that gives you the option of:
372467

468+
1. Updating to the latest official release;
469+
2. Updating to the bleeding-edge development version; or
470+
3. Manually entering the tag or branch name of a version of
471+
InvokeAI you wish to try out.

0 commit comments

Comments
 (0)