mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
update installation instructions
This commit is contained in:
@ -119,10 +119,8 @@ manager, please follow these steps:
|
|||||||
|
|
||||||
6. Run PIP
|
6. Run PIP
|
||||||
|
|
||||||
Be sure that the `invokeai` environment is active before doing this:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install --prefer-binary -r requirements.txt
|
pip --python invokeai install --use-pep517 .
|
||||||
```
|
```
|
||||||
|
|
||||||
7. Set up the runtime directory
|
7. Set up the runtime directory
|
||||||
@ -137,7 +135,7 @@ manager, please follow these steps:
|
|||||||
default to `invokeai` in your home directory.
|
default to `invokeai` in your home directory.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
configure_invokeai.py --root_dir ~/Programs/invokeai
|
configure_invokeai --root_dir ~/Programs/invokeai
|
||||||
```
|
```
|
||||||
|
|
||||||
The script `configure_invokeai.py` will interactively guide you through the
|
The script `configure_invokeai.py` will interactively guide you through the
|
||||||
@ -452,7 +450,7 @@ time. Note that this method only works with the PIP method.
|
|||||||
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 `pip install .` (note the dot at the end).
|
directory `pip install --use-pep517 .` (note the dot at the end).
|
||||||
|
|
||||||
4. That's all! Now, whenever you activate the virtual environment,
|
4. That's all! Now, whenever you activate the virtual environment,
|
||||||
`invoke.py` will know where to look for the runtime directory without
|
`invoke.py` will know where to look for the runtime directory without
|
||||||
|
@ -18,7 +18,13 @@ Windows systems with no extra intervention.
|
|||||||
|
|
||||||
## Macintosh
|
## Macintosh
|
||||||
|
|
||||||
PyPatchMatch is not currently supported, but the team is working on it.
|
You need to have opencv installed so that pypatchmatch can be built:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
brew install opencv
|
||||||
|
```
|
||||||
|
|
||||||
|
The next time you start `invoke`, after sucesfully installing opencv, pypatchmatch will be built.
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
|
|
||||||
@ -39,23 +45,16 @@ Prior to installing PyPatchMatch, you need to take the following steps:
|
|||||||
sudo apt install python3-opencv libopencv-dev
|
sudo apt install python3-opencv libopencv-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Fix the naming of the `opencv` package configuration file:
|
3. Activate the environment you use for invokeai, either with `conda` or with a
|
||||||
|
|
||||||
```sh
|
|
||||||
cd /usr/lib/x86_64-linux-gnu/pkgconfig/
|
|
||||||
ln -sf opencv4.pc opencv.pc
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Activate the environment you use for invokeai, either with `conda` or with a
|
|
||||||
virtual environment.
|
virtual environment.
|
||||||
|
|
||||||
5. Install pypatchmatch:
|
4. Install pypatchmatch:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pip install "git+https://github.com/invoke-ai/PyPatchMatch@0.1.3#egg=pypatchmatch"
|
pip install pypatchmatch
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Confirm that pypatchmatch is installed. At the command-line prompt enter
|
5. Confirm that pypatchmatch is installed. At the command-line prompt enter
|
||||||
`python`, and then at the `>>>` line type
|
`python`, and then at the `>>>` line type
|
||||||
`from patchmatch import patch_match`: It should look like the follwing:
|
`from patchmatch import patch_match`: It should look like the follwing:
|
||||||
|
|
||||||
|
@ -254,65 +254,10 @@ steps:
|
|||||||
source invokeai/bin/activate
|
source invokeai/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Pick the correct `requirements*.txt` file for your hardware and operating
|
4. Run PIP
|
||||||
system.
|
|
||||||
|
|
||||||
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 |
|
|
||||||
| :---------------------------------: | :-------------------------------------------------------------: |
|
|
||||||
| requirements-lin-amd.txt | Linux with an AMD (ROCm) GPU |
|
|
||||||
| requirements-lin-arm64.txt | Linux running on arm64 systems |
|
|
||||||
| 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>
|
|
||||||
|
|
||||||
Select the appropriate requirements file, and make a link to it from
|
|
||||||
`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
|
```bash
|
||||||
ln -sf environments-and-requirements/requirements-xxx-yyy.txt requirements.txt
|
pip --python invokeai install --use-pep517 .
|
||||||
```
|
|
||||||
|
|
||||||
=== "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`.
|
|
||||||
|
|
||||||
5. Run PIP
|
|
||||||
|
|
||||||
Be sure that the `invokeai` environment is active before doing this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install --prefer-binary -r requirements.txt
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
Reference in New Issue
Block a user