Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove requirements step from install manual (#2442)

Browse Source 
removing the step to link the requirements file from the docs for manual
Installation after commenting about it in #2431
This commit is contained in:
Lincoln Stein 2023-02-02 16:50:29 -05:00 committed by GitHub
commit 0642728484
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 74 additions and 462 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

536
docs/installation/020_INSTALL_MANUAL.md
View File

@ -3,37 +3,38 @@ title: Installing Manually
--- ---
<figure markdown> <figure markdown>
# :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS | :fontawesome-brands-windows: Windows # :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS | :fontawesome-brands-windows: Windows
</figure> </figure>
!!! warning "This is for advanced Users" !!! warning "This is for advanced Users"
who are already experienced with using conda or pip **python experience is mandatory**
## Introduction ## Introduction
You have two choices for manual installation. You have two choices for manual installation. The [first one](#pip-Install) uses
The [first one](#pip-Install) uses basic Python virtual environment (`venv`) basic Python virtual environment (`venv`) command and `pip` package manager. The
command and `pip` package manager. [second one](#Conda-method) uses Anaconda3 package manager (`conda`). Both
The [second one](#Conda-method) uses Anaconda3 package manager (`conda`). methods require you to enter commands on the terminal, also known as the
Both methods require you to enter commands on the terminal, also known as the
"console". "console".
Note that the `conda` installation method is currently deprecated and will Note that the `conda` installation method is currently deprecated and will not
not be supported at some point in the future. be supported at some point in the future.
On Windows systems, you are encouraged to install and use the On Windows systems, you are encouraged to install and use the
[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3), [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3),
which provides compatibility with Linux and Mac shells and nice which provides compatibility with Linux and Mac shells and nice features such as
features such as command-line completion. command-line completion.
## pip Install ## pip Install
To install InvokeAI with virtual environments and the PIP package To install InvokeAI with virtual environments and the PIP package manager,
manager, please follow these steps: please follow these steps:
1. Make sure you are using Python 3.9 or 3.10. The rest of the install 1. Please make sure you are using Python 3.9 or 3.10. The rest of the install
procedure depends on this: procedure depends on this and will not work with other versions:
```bash ```bash
python -V python -V
@ -50,89 +51,40 @@ manager, please follow these steps:
steps. steps.
3. From within the InvokeAI top-level directory, create and activate a virtual 3. From within the InvokeAI top-level directory, create and activate a virtual
environment named `invokeai`: environment named `.venv` and prompt displaying `InvokeAI`:
```bash ```bash
python -m venv invokeai python -m venv .venv \
source invokeai/bin/activate --prompt InvokeAI \
``` --upgrade-deps
source .venv/bin/activate
```
4. Make sure that pip is installed in your virtual environment an up to date: 4. Make sure that pip is installed in your virtual environment an up to date:
```bash ```bash
python -m ensurepip --upgrade python -m ensurepip \
python -m pip install --upgrade pip --upgrade
``` python -m pip install \
--upgrade pip
```
5. Pick the correct `requirements*.txt` file for your hardware and operating 5. Install Package
system.
We have created a series of environment files suited for different operating ```bash
systems and GPU hardware. They are located in the pip install --use-pep517 .
`environments-and-requirements` directory: ```
<figure markdown> 6. Set up the runtime directory
| filename | OS | In this step you will initialize a runtime directory that will contain the
| :---------------------------------: | :-------------------------------------------------------------: | models, model config files, directory for textual inversion embeddings, and
| requirements-lin-amd.txt | Linux with an AMD (ROCm) GPU | your outputs. This keeps the runtime directory separate from the source code
| requirements-lin-arm64.txt | Linux running on arm64 systems | and aids in updating.
| requirements-lin-cuda.txt | Linux with an NVIDIA (CUDA) GPU |
| requirements-mac-mps-cpu.txt | Macintoshes with MPS acceleration |
| requirements-lin-win-colab-cuda.txt | Windows with an NVIDA (CUDA) GPU<br>(supports Google Colab too) |
</figure> You may pick any location for this directory using the `--root_dir` option
(abbreviated --root). If you don't pass this option, it will default to
Select the appropriate requirements file, and make a link to it from `~/invokeai`.
`requirements.txt` in the top-level InvokeAI directory. The command to do
this from the top-level directory is:
!!! example ""
=== "Macintosh and Linux"
!!! info "Replace `xxx` and `yyy` with the appropriate OS and GPU codes."
```bash
ln -sf environments-and-requirements/requirements-xxx-yyy.txt requirements.txt
```
=== "Windows"
!!! info "on Windows, admin privileges are required to make links, so we use the copy command instead"
```cmd
copy environments-and-requirements\requirements-lin-win-colab-cuda.txt requirements.txt
```
!!! warning
Please do not link or copy `environments-and-requirements/requirements-base.txt`.
This is a base requirements file that does not have the platform-specific
libraries. Also, be sure to link or copy the platform-specific file to
a top-level file named `requirements.txt` as shown here. Running pip on
a requirements file in a subdirectory will not work as expected.
When this is done, confirm that a file named `requirements.txt` has been
created in the InvokeAI root directory and that it points to the correct
file in `environments-and-requirements`.
6. Run PIP
```bash
pip --python invokeai install --use-pep517 .
```
7. Set up the runtime directory
In this step you will initialize a runtime directory that will
contain the models, model config files, directory for textual
inversion embeddings, and your outputs. This keeps the runtime
directory separate from the source code and aids in updating.
You may pick any location for this directory using the `--root_dir`
option (abbreviated --root). If you don't pass this option, it will
default to `invokeai` in your home directory.
```bash ```bash
invokeai-configure --root_dir ~/Programs/invokeai invokeai-configure --root_dir ~/Programs/invokeai
@ -149,11 +101,10 @@ manager, please follow these steps:
If you get an error message about a module not being installed, check that If you get an error message about a module not being installed, check that
the `invokeai` environment is active and if not, repeat step 5. the `invokeai` environment is active and if not, repeat step 5.
Note that `invokeai-configure` and `invoke.py` should be installed Note that `invokeai-configure` and `invokeai` should be installed under your
under your virtual environment directory and the system should find them virtual environment directory and the system should find them on the PATH.
on the PATH. If this isn't working on your system, you can call the If this isn't working on your system, you can call the scripts directory
scripts directory using `python scripts/invokeai-configure` and using `python scripts/configure_invokeai.py` and `python scripts/invoke.py`.
`python scripts/invoke.py`.
!!! tip !!! tip
@ -162,12 +113,12 @@ manager, please follow these steps:
prompted) and configure InvokeAI to use the previously-downloaded files. The prompted) and configure InvokeAI to use the previously-downloaded files. The
process for this is described in [here](050_INSTALLING_MODELS.md). process for this is described in [here](050_INSTALLING_MODELS.md).
8. Run the command-line- or the web- interface: 7. Run the command-line- or the web- interface:
Activate the environment (with `source invokeai/bin/activate`), and then Activate the environment (with `source .venv/bin/activate`), and then run
run the script `invoke.py`. If you selected a non-default location the script `invokeai`. If you selected a non-default location for the
for the runtime directory, please specify the path with the `--root_dir` runtime directory, please specify the path with the `--root_dir` option
option (abbreviated below as `--root`): (abbreviated below as `--root`):
!!! example "" !!! example ""
@ -198,391 +149,52 @@ manager, please follow these steps:
You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of the directory. You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of the directory.
9. Render away! 8. Render away!
Browse the [features](../features/CLI.md) section to learn about all the things you Browse the [features](../features/CLI.md) section to learn about all the
can do with InvokeAI. things you can do with InvokeAI.
Note that some GPUs are slow to warm up. In particular, when using an AMD Note that some GPUs are slow to warm up. In particular, when using an AMD
card with the ROCm driver, you may have to wait for over a minute the first card with the ROCm driver, you may have to wait for over a minute the first
time you try to generate an image. Fortunately, after the warm-up period time you try to generate an image. Fortunately, after the warm-up period
rendering will be fast. rendering will be fast.
10. Subsequently, to relaunch the script, be sure to enter `InvokeAI` directory, 9. Subsequently, to relaunch the script, activate the virtual environment, and
activate the virtual environment, and then launch `invoke.py` script. then launch `invokeai` command. If you forget to activate the virtual
If you forget to activate the virtual environment, environment you will most likeley receive a `command not found` error.
the script will fail with multiple `ModuleNotFound` errors.
!!! tip !!! tip
Do not move the source code repository after installation. The virtual environment directory has absolute paths in it that get confused if the directory is moved. Do not move the source code repository after installation. The virtual environment directory has absolute paths in it that get confused if the directory is moved.
---
### Conda method
1. Check that your system meets the
[hardware requirements](index.md#Hardware_Requirements) and has the
appropriate GPU drivers installed. In particular, if you are a Linux user
with an AMD GPU installed, you may need to install the
[ROCm driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
InvokeAI does not yet support Windows machines with AMD GPUs due to the lack
of ROCm driver support on this platform.
To confirm that the appropriate drivers are installed, run `nvidia-smi` on
NVIDIA/CUDA systems, and `rocm-smi` on AMD systems. These should return
information about the installed video card.
Macintosh users with MPS acceleration, or anybody with a CPU-only system,
can skip this step.
2. You will need to install Anaconda3 and Git if they are not already
available. Use your operating system's preferred package manager, or
download the installers manually. You can find them here:
- [Anaconda3](https://www.anaconda.com/)
- [git](https://git-scm.com/downloads)
3. Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from
GitHub:
```bash
git clone https://github.com/invoke-ai/InvokeAI.git
```
This will create InvokeAI folder where you will follow the rest of the
steps.
4. Enter the newly-created InvokeAI folder:
```bash
cd InvokeAI
```
From this step forward make sure that you are working in the InvokeAI
directory!
5. Select the appropriate environment file:
We have created a series of environment files suited for different operating
systems and GPU hardware. They are located in the
`environments-and-requirements` directory:
<figure markdown>
| filename | OS |
| :----------------------: | :----------------------------: |
| environment-lin-amd.yml | Linux with an AMD (ROCm) GPU |
| environment-lin-cuda.yml | Linux with an NVIDIA CUDA GPU |
| environment-mac.yml | Macintosh |
| environment-win-cuda.yml | Windows with an NVIDA CUDA GPU |
</figure>
Choose the appropriate environment file for your system and link or copy it
to `environment.yml` in InvokeAI's top-level directory. To do so, run
following command from the repository-root:
!!! Example ""
=== "Macintosh and Linux"
!!! todo "Replace `xxx` and `yyy` with the appropriate OS and GPU codes as seen in the table above"
```bash
ln -sf environments-and-requirements/environment-xxx-yyy.yml environment.yml
```
When this is done, confirm that a file `environment.yml` has been linked in
the InvokeAI root directory and that it points to the correct file in the
`environments-and-requirements`.
```bash
ls -la
```
=== "Windows"
!!! todo " Since it requires admin privileges to create links, we will use the copy command to create your `environment.yml`"
```cmd
copy environments-and-requirements\environment-win-cuda.yml environment.yml
```
Afterwards verify that the file `environment.yml` has been created, either via the
explorer or by using the command `dir` from the terminal
```cmd
dir
```
!!! warning "Do not try to run conda on directly on the subdirectory environments file. This won't work. Instead, copy or link it to the top-level directory as shown."
6. Create the conda environment:
```bash
conda env update
```
This will create a new environment named `invokeai` and install all InvokeAI
dependencies into it. If something goes wrong you should take a look at
[troubleshooting](#troubleshooting).
7. Activate the `invokeai` environment:
In order to use the newly created environment you will first need to
activate it
```bash
conda activate invokeai
```
Your command-line prompt should change to indicate that `invokeai` is active
by prepending `(invokeai)`.
8. Set up the runtime directory
In this step you will initialize a runtime directory that will
contain the models, model config files, directory for textual
inversion embeddings, and your outputs. This keeps the runtime
directory separate from the source code and aids in updating.
You may pick any location for this directory using the `--root_dir`
option (abbreviated --root). If you don't pass this option, it will
default to `invokeai` in your home directory.
```bash
python scripts/invokeai-configure --root_dir ~/Programs/invokeai
```
The script `invokeai-configure` will interactively guide you through the
process of downloading and installing the weights files needed for InvokeAI.
Note that the main Stable Diffusion weights file is protected by a license
agreement that you have to agree to. The script will list the steps you need
to take to create an account on the site that hosts the weights files,
accept the agreement, and provide an access token that allows InvokeAI to
legally download and install the weights files.
If you get an error message about a module not being installed, check that
the `invokeai` environment is active and if not, repeat step 5.
Note that `invokeai-configure` and `invoke.py` should be
installed under your conda directory and the system should find
them automatically on the PATH. If this isn't working on your
system, you can call the scripts directory using `python
scripts/configure_invoke.py` and `python scripts/invoke.py`.
!!! tip
If you have already downloaded the weights file(s) for another Stable
Diffusion distribution, you may skip this step (by selecting "skip" when
prompted) and configure InvokeAI to use the previously-downloaded files. The
process for this is described in [here](050_INSTALLING_MODELS.md).
9. Run the command-line- or the web- interface:
Activate the environment (with `source invokeai/bin/activate`), and then
run the script `invoke.py`. If you selected a non-default location
for the runtime directory, please specify the path with the `--root_dir`
option (abbreviated below as `--root`):
!!! example ""
!!! warning "Make sure that the conda environment is activated, which should create `(invokeai)` in front of your prompt!"
=== "CLI"
```bash
invoke.py --root ~/Programs/invokeai
```
=== "local Webserver"
```bash
invoke.py --web --root ~/Programs/invokeai
```
=== "Public Webserver"
```bash
invoke.py --web --host 0.0.0.0 --root ~/Programs/invokeai
```
If you choose the run the web interface, point your browser at
http://localhost:9090 in order to load the GUI.
!!! tip
You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of your choice.
10. Render away!
Browse the [features](../features/CLI.md) section to learn about all the things you
can do with InvokeAI.
Note that some GPUs are slow to warm up. In particular, when using an AMD
card with the ROCm driver, you may have to wait for over a minute the first
time you try to generate an image. Fortunately, after the warm up period
rendering will be fast.
11. Subsequently, to relaunch the script, be sure to run "conda activate
invokeai", enter the `InvokeAI` directory, and then launch the invoke
script. If you forget to activate the 'invokeai' environment, the script
will fail with multiple `ModuleNotFound` errors.
## Creating an "install" version of InvokeAI ## Creating an "install" version of InvokeAI
If you wish you can install InvokeAI and all its dependencies in the If you wish you can install InvokeAI and all its dependencies in the runtime
runtime directory. This allows you to delete the source code directory. This allows you to delete the source code repository and eliminates
repository and eliminates the need to provide `--root_dir` at startup the need to provide `--root_dir` at startup time. Note that this method only
time. Note that this method only works with the PIP method. works with the PIP method.
1. Follow the instructions for the PIP install, but in step #2 put the 1. Follow the instructions for the PIP install, but in step #2 put the virtual
virtual environment into the runtime directory. For example, assuming the environment into the runtime directory. For example, assuming the runtime
runtime directory lives in `~/Programs/invokeai`, you'd run: directory lives in `~/Programs/invokeai`, you'd run:
```bash ```bash
python -menv ~/Programs/invokeai python -m venv ~/Programs/invokeai
``` ```
2. Now follow steps 3 to 5 in the PIP recipe, ending with the `pip install` 2. Now follow steps 3 to 5 in the PIP recipe, ending with the `pip install`
step. step.
3. Run one additional step while you are in the source code repository 3. Run one additional step while you are in the source code repository directory
directory `pip install --use-pep517 .` (note the dot at the end).
4. That's all! Now, whenever you activate the virtual environment, ```
`invoke.py` will know where to look for the runtime directory without pip install --use-pep517 . # note the dot in the end!!!
needing a `--root_dir` argument. In addition, you can now move or ```
delete the source code repository entirely.
4. That's all! Now, whenever you activate the virtual environment, `invokeai`
will know where to look for the runtime directory without needing a
`--root_dir` argument. In addition, you can now move or delete the source
code repository entirely.
(Don't move the runtime directory!) (Don't move the runtime directory!)
## Updating to newer versions of the script
This distribution is changing rapidly. If you used the `git clone` method
(step 5) to download the InvokeAI directory, then to update to the latest and
greatest version, launch the Anaconda window, enter `InvokeAI` and type:
```bash
git pull
conda env update
python scripts/invokeai-configure --skip-sd-weights #optional
```
This will bring your local copy into sync with the remote one. The last step may
be needed to take advantage of new features or released models. The
`--skip-sd-weights` flag will prevent the script from prompting you to download
the big Stable Diffusion weights files.
## Troubleshooting
Here are some common issues and their suggested solutions.
### Conda
#### Conda fails before completing `conda update`
The usual source of these errors is a package incompatibility. While we have
tried to minimize these, over time packages get updated and sometimes introduce
incompatibilities.
We suggest that you search
[Issues](https://github.com/invoke-ai/InvokeAI/issues) or the "bugs-and-support"
channel of the [InvokeAI Discord](https://discord.gg/ZmtBAhwWhy).
You may also try to install the broken packages manually using PIP. To do this,
activate the `invokeai` environment, and run `pip install` with the name and
version of the package that is causing the incompatibility. For example:
```bash
pip install test-tube==0.7.5
```
You can keep doing this until all requirements are satisfied and the `invoke.py`
script runs without errors. Please report to
[Issues](https://github.com/invoke-ai/InvokeAI/issues) what you were able to do
to work around the problem so that others can benefit from your investigation.
### Create Conda Environment fails on MacOS
If conda create environment fails with lmdb error, this is most likely caused by Clang.
Run brew config to see which Clang is installed on your Mac. If Clang isn't installed, that's causing the error.
Start by installing additional XCode command line tools, followed by brew install llvm.
```bash
xcode-select --install
brew install llvm
```
If brew config has Clang installed, update to the latest llvm and try creating the environment again.
#### `invokeai-configure` or `invoke.py` crashes at an early stage
This is usually due to an incomplete or corrupted Conda install. Make sure you
have linked to the correct environment file and run `conda update` again.
If the problem persists, a more extreme measure is to clear Conda's caches and
remove the `invokeai` environment:
```bash
conda deactivate
conda env remove -n invokeai
conda clean -a
conda update
```
This removes all cached library files, including ones that may have been
corrupted somehow. (This is not supposed to happen, but does anyway).
#### `invoke.py` crashes at a later stage
If the CLI or web site had been working ok, but something unexpected happens
later on during the session, you've encountered a code bug that is probably
unrelated to an install issue. Please search
[Issues](https://github.com/invoke-ai/InvokeAI/issues), file a bug report, or
ask for help on [Discord](https://discord.gg/ZmtBAhwWhy)
#### My renders are running very slowly
You may have installed the wrong torch (machine learning) package, and the
system is running on CPU rather than the GPU. To check, look at the log messages
that appear when `invoke.py` is first starting up. One of the earlier lines
should say `Using device type cuda`. On AMD systems, it will also say "cuda",
and on Macintoshes, it should say "mps". If instead the message says it is
running on "cpu", then you may need to install the correct torch library.
You may be able to fix this by installing a different torch library. Here are
the magic incantations for Conda and PIP.
!!! todo "For CUDA systems"
- conda
```bash
conda install pytorch torchvision torchaudio pytorch-cuda=11.6 -c pytorch -c nvidia
```
- pip
```bash
pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu116
```
!!! todo "For AMD systems"
- conda
```bash
conda activate invokeai
pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/rocm5.2/
```
- pip
```bash
pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/rocm5.2/
```
More information and troubleshooting tips can be found at https://pytorch.org.