documentation and environment file fixes

- Have clarified the relationship between the @tildebyte and @cmdr2 installers;
  However, @tildebyte installer merge is still a WIP due to conflicts over
  such things as `invoke.sh`.
- Rechristened 1click installer as "source" installer. @tildebyte installer will be
  "the" installer. (We'll see which one generates the least support requests and
  maintenance work.)
- Sync'd `environment-mac.yml` with `development`. The former was failing with a
  taming-transformers error as per https://discord.com/channels/@me/1037201214154231899/1040060947378749460
This commit is contained in:
Lincoln Stein 2022-11-10 14:46:36 +00:00
parent a23b031895
commit 18a947c503
7 changed files with 71 additions and 64 deletions

View File

@ -7,28 +7,27 @@ title: Installation 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. experience and preferences.
1. [1-click installer](INSTALL_1CLICK.md) 1. [InvokeAI installer](INSTALL_INVOKE.md)
This is an automated shell script that will handle installation of This is a an installer script that installs InvokeAI and all its
all dependencies for you, and is recommended for those who have the essential third party libraries. When a new version of
limited or no experience with the Python programming language, are InvokeAI is released, you will run another script to upgrade to
not currently interested in contributing to the project, and just want the new version.
the thing to install and run. In this version, you interact with the
web server and command-line clients through a shell script named
`invoke.sh` (Linux/Mac) or `invoke.bat` (Windows), and perform
updates using `update.sh` and `update.bat`.
2. [Pre-compiled PIP installer](INSTALL_PCP.md) This installer is designed for people who want the system to "just
work", and have no interest in exploring how it works or
contributing enhancements to the code or documentation.
This is a series of installer files for which all the requirements 2. [Source code installer](INSTALL_SOURCE.md)
for InvokeAI have been precompiled, thereby preventing the conflicts
that sometimes occur when an external library is changed unexpectedly.
It will leave you with an environment in which you interact directly
with the scripts for running the web and command line clients, and
you will update to new versions using standard developer commands.
This method is recommended for users with a bit of experience using This is a script that will install InvokeAI and all its essential
the `git` and `pip` tools. third party libraries. In contrast to the previous installer, it
includes access to a "developer console" which will allow you to
access experimental features on the development branch.
This method is recommended for individuals who are wish to stay
on the cutting edge of InvokeAI development and are not afraid
of occasional breakage.
3. [Manual Installation](INSTALL_MANUAL.md) 3. [Manual Installation](INSTALL_MANUAL.md)

View File

@ -1,10 +1,10 @@
--- ---
title: The "One-Click" Installer title: The InvokeAI Source Installer
--- ---
## Introduction ## Introduction
The one-click installer is a shell script that attempts to automate The source installer is a shell script that attempts to automate
every step needed to install and run InvokeAI on a stock computer every step needed to install and run InvokeAI on a stock computer
running recent versions of Linux, MacOSX or Windows. running recent versions of Linux, MacOSX or Windows.
@ -22,7 +22,7 @@ libraries and recommended model weights files.
Though there are multiple steps, there really is only one click Though there are multiple steps, there really is only one click
involved to kick off the process. involved to kick off the process.
1. The 1-click installer is distributed in ZIP files. Download the one 1. The source installer is distributed in ZIP files. Download the one
that is appropriate for your operating system: that is appropriate for your operating system:
!!! todo "Change the URLs after release" !!! todo "Change the URLs after release"

View File

@ -2,54 +2,62 @@ name: invokeai
channels: channels:
- pytorch - pytorch
- conda-forge - conda-forge
- defaults
dependencies: dependencies:
- python=3.9.13 - python=3.10
- pip=22.2.2 - pip>=22.2
- pytorch=1.12.1 - pytorch=1.12
- torchvision=0.13.1 - pytorch-lightning=1.7
- torchvision=0.13
- torchmetrics=0.10
- torch-fidelity=0.3
- albumentations=1.2.1 # I suggest to keep the other deps sorted for convenience.
- coloredlogs=15.0.1 # To determine what the latest versions should be, run:
- diffusers=0.6.0 #
- einops=0.4.1 # ```shell
- grpcio=1.46.4 # sed -E 's/invokeai/invokeai-updated/;20,99s/- ([^=]+)==.+/- \1/' environment-mac.yml > environment-mac-updated.yml
# CONDA_SUBDIR=osx-arm64 conda env create -f environment-mac-updated.yml && conda list -n invokeai-updated | awk ' {print " - " $1 "==" $2;} '
# ```
- albumentations=1.2
- coloredlogs=15.0
- diffusers=0.6
- einops=0.3
- eventlet
- grpcio=1.46
- flask=2.1
- flask-socketio=5.3
- flask-cors=3.0
- humanfriendly=10.0 - humanfriendly=10.0
- imageio=2.21.2 - imageio=2.21
- imageio-ffmpeg=0.4.7 - imageio-ffmpeg=0.4
- imgaug=0.4.0 - imgaug=0.4
- kornia=0.6.7 - kornia=0.6
- mpmath=1.2.1 - mpmath=1.2
- nomkl # arm64 has only 1.0 while x64 needs 3.0 - nomkl=3
- numpy=1.23.4 - numpy=1.23
- omegaconf=2.1.1 - omegaconf=2.1
- openh264=2.3.0 - openh264=2.3
- onnx=1.12.0 - onnx=1.12
- onnxruntime=1.12.1 - onnxruntime=1.12
- pudb=2022.1 - pudb=2019.2
- pytorch-lightning=1.7.7 - protobuf=3.20
- scipy=1.9.3 - py-opencv=4.6
- streamlit=1.12.2 - scipy=1.9
- sympy=1.10.1 - streamlit=1.12
- tensorboard=2.10.0 - sympy=1.10
- torchmetrics=0.10.1 - send2trash=1.8
- py-opencv=4.6.0 - tensorboard=2.10
- flask=2.1.3 - transformers=4.23
- flask-socketio=5.3.0
- flask-cors=3.0.10
- eventlet=0.33.1
- protobuf=3.20.1
- send2trash=1.8.0
- transformers=4.23.1
- torch-fidelity=0.3.0
- pip: - pip:
- getpass_asterisk - getpass_asterisk
- dependency_injector==4.40.0
- realesrgan==0.2.5.0
- taming-transformers-rom1504 - taming-transformers-rom1504
- test-tube==0.7.5 - test-tube==0.7.5
- git+https://github.com/openai/CLIP.git@main#egg=clip - git+https://github.com/openai/CLIP.git@main#egg=clip
- git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k_diffusion - git+https://github.com/invoke-ai/k-diffusion.git@mps#egg=k_diffusion
- git+https://github.com/TencentARC/GFPGAN.git#egg=gfpgan - git+https://github.com/invoke-ai/Real-ESRGAN.git#egg=realesrgan
- git+https://github.com/invoke-ai/GFPGAN.git#egg=gfpgan
- git+https://github.com/invoke-ai/clipseg.git@models-rename#egg=clipseg - git+https://github.com/invoke-ai/clipseg.git@models-rename#egg=clipseg
- -e . - -e .
variables: variables:

View File

@ -8,8 +8,8 @@ mkdir -p invokeAI
cp install.sh invokeAI cp install.sh invokeAI
cp readme.txt invokeAI cp readme.txt invokeAI
zip -r invokeAI-linux.zip invokeAI zip -r invokeAI-src-linux.zip invokeAI
zip -r invokeAI-mac.zip invokeAI zip -r invokeAI-src-mac.zip invokeAI
# make the installer zip for windows # make the installer zip for windows
rm -rf invokeAI rm -rf invokeAI
@ -17,6 +17,6 @@ mkdir -p invokeAI
cp install.bat invokeAI cp install.bat invokeAI
cp readme.txt invokeAI cp readme.txt invokeAI
zip -r invokeAI-windows.zip invokeAI zip -r invokeAI-src-windows.zip invokeAI
echo "The installer zips are ready to be distributed.." echo "The installer zips are ready to be distributed.."