diff --git a/docs/features/INPAINTING.md b/docs/features/INPAINTING.md index e22fbd08e7..f3a879b190 100644 --- a/docs/features/INPAINTING.md +++ b/docs/features/INPAINTING.md @@ -158,7 +158,7 @@ when filling in missing regions. It has an almost uncanny ability to blend the new regions with existing ones in a semantically coherent way. To install the inpainting model, follow the -[instructions](../installation/INSTALLING_MODELS.md) for installing a new model. +[instructions](../installation/050_INSTALLING_MODELS.md) for installing a new model. You may use either the CLI (`invoke.py` script) or directly edit the `configs/models.yaml` configuration file to do this. The main thing to watch out for is that the the model `config` option must be set up to use diff --git a/docs/index.md b/docs/index.md index 1ad2d2b66d..3c5bd3904b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -95,7 +95,7 @@ upgrade instructions, please see: Linux users who wish to make use of the PyPatchMatch inpainting functions will need to perform a bit of extra work to enable this module. Instructions can be -found at [Installing PyPatchMatch](installation/INSTALL_PATCHMATCH.md). +found at [Installing PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md). ## :fontawesome-solid-computer: Hardware Requirements @@ -137,25 +137,24 @@ images in full-precision mode: ## :octicons-gift-24: InvokeAI Features -- [The InvokeAI Web Interface](features/WEB.md) - - [WebGUI hotkey reference guide](features/WEBUIHOTKEYS.md) - - [WebGUI Unified Canvas for Img2Img, inpainting and outpainting](features/UNIFIED_CANVAS.md) +- [The InvokeAI Web Interface](features/WEB.md) - +[WebGUI hotkey reference guide](features/WEBUIHOTKEYS.md) - +[WebGUI Unified Canvas for Img2Img, inpainting and outpainting](features/UNIFIED_CANVAS.md) -- [The Command Line Interace](features/CLI.md) - - [Image2Image](features/IMG2IMG.md) - - [Inpainting](features/INPAINTING.md) - - [Outpainting](features/OUTPAINTING.md) - - [Adding custom styles and subjects](features/CONCEPTS.md) - - [Upscaling and Face Reconstruction](features/POSTPROCESS.md) +- [The Command Line Interace](features/CLI.md) - +[Image2Image](features/IMG2IMG.md) - [Inpainting](features/INPAINTING.md) - +[Outpainting](features/OUTPAINTING.md) - +[Adding custom styles and subjects](features/CONCEPTS.md) - +[Upscaling and Face Reconstruction](features/POSTPROCESS.md) - [Generating Variations](features/VARIATIONS.md) - [Prompt Engineering](features/PROMPTS.md) - Miscellaneous - - [NSFW Checker](features/NSFW.md) - - [Embiggen upscaling](features/EMBIGGEN.md) - - [Other](features/OTHER.md) + - [NSFW Checker](features/NSFW.md) + - [Embiggen upscaling](features/EMBIGGEN.md) + - [Other](features/OTHER.md) ## :octicons-log-16: Latest Changes diff --git a/docs/installation/010_INSTALL_AUTOMATED.md b/docs/installation/010_INSTALL_AUTOMATED.md index 503cf6a2b0..8b1bc97be7 100644 --- a/docs/installation/010_INSTALL_AUTOMATED.md +++ b/docs/installation/010_INSTALL_AUTOMATED.md @@ -30,8 +30,6 @@ version of InvokeAI with the option to upgrade to experimental versions later. installed, it will print out the version number. If it is version `3.9.1` or higher, you meet requirements. - - !!! warning "If you see an older version, or get a command not found error" Go to [Python Downloads](https://www.python.org/downloads/) and @@ -53,7 +51,7 @@ version of InvokeAI with the option to upgrade to experimental versions later. "Modify" existing installation. - Installation requires an up to date version of the Microsoft Visual C libraries. Please install the 2015-2022 libraries available here: https://learn.microsoft.com/en-us/cpp/windows/deploying-native-desktop-applications-visual-cpp?view=msvc-170 - + === "Mac users" - After installing Python, you may need to run the @@ -83,7 +81,7 @@ version of InvokeAI with the option to upgrade to experimental versions later. In particular, Ubuntu version 20.04 LTS comes with an old version of Python, does not come with the PIP package manager installed, and to make matters worse, the `python` command points to Python2, not Python3. Here is the quick recipe for bringing your system up to date: - + ``` sudo apt update sudo apt install python3.9 @@ -174,7 +172,7 @@ version of InvokeAI with the option to upgrade to experimental versions later. and configuring them. We provide a list of popular models that InvokeAI performs well with. However, you can add more weight files later on using the command-line client or the Web UI. See - [Installing Models](INSTALLING_MODELS.md) for details. + [Installing Models](050_INSTALLING_MODELS.md) for details. Note that the main Stable Diffusion weights file is protected by a license agreement that you must agree to in order to use. The script will list the @@ -185,7 +183,7 @@ version of InvokeAI with the option to upgrade to experimental versions later. 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 [Installing Models](INSTALLING_MODELS.md). + process for this is described in [Installing Models](050_INSTALLING_MODELS.md). 11. The script will now exit and you'll be ready to generate some images. Look for the directory `invokeai` installed in the location you chose at the diff --git a/docs/installation/020_INSTALL_MANUAL.md b/docs/installation/020_INSTALL_MANUAL.md index 2f22738303..94246652a2 100644 --- a/docs/installation/020_INSTALL_MANUAL.md +++ b/docs/installation/020_INSTALL_MANUAL.md @@ -151,7 +151,7 @@ manager, please follow these steps: 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](INSTALLING_MODELS.md). + process for this is described in [here](050_INSTALLING_MODELS.md). 7. Run the command-line- or the web- interface: @@ -308,8 +308,8 @@ manager, please follow these steps: 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." - + !!! 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 @@ -369,7 +369,7 @@ manager, please follow these steps: 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](INSTALLING_MODELS.md). + process for this is described in [here](050_INSTALLING_MODELS.md). 9. Run the command-line- or the web- interface: diff --git a/docs/installation/deprecated_documentation/INSTALL_BINARY.md b/docs/installation/deprecated_documentation/INSTALL_BINARY.md index 30d52daa18..bc12f3d848 100644 --- a/docs/installation/deprecated_documentation/INSTALL_BINARY.md +++ b/docs/installation/deprecated_documentation/INSTALL_BINARY.md @@ -10,7 +10,7 @@ InvokeAI is released, you will download and reinstall the new version. If you wish to tinker with unreleased versions of InvokeAI that introduce potentially unstable new features, you should consider using the [source installer](INSTALL_SOURCE.md) or one of the -[manual install](INSTALL_MANUAL.md) methods. +[manual install](../020_INSTALL_MANUAL.md) methods. **Important Caveats** - This script does not support AMD GPUs. For Linux AMD support, diff --git a/docs/installation/deprecated_documentation/INSTALL_SOURCE.md b/docs/installation/deprecated_documentation/INSTALL_SOURCE.md index 3629a8c8be..2b1b750fbf 100644 --- a/docs/installation/deprecated_documentation/INSTALL_SOURCE.md +++ b/docs/installation/deprecated_documentation/INSTALL_SOURCE.md @@ -12,7 +12,7 @@ of Linux, MacOS or Windows. It will leave you with a version that runs a stable version of InvokeAI with the option to upgrade to experimental versions later. Before you begin, make sure that you meet the -[hardware requirements](index.md#Hardware_Requirements) and has the appropriate +[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). @@ -50,15 +50,15 @@ off the process. inflating: invokeAI\readme.txt ``` -3. If you are a macOS user, you may need to install the Xcode command line tools. - These are a set of tools that are needed to run certain applications in a Terminal, +3. If you are a macOS user, you may need to install the Xcode command line tools. + These are a set of tools that are needed to run certain applications in a Terminal, including InvokeAI. This package is provided directly by Apple. - + To install, open a terminal window and run `xcode-select --install`. You will get a macOS system popup guiding you through the install. If you already have them - installed, you will instead see some output in the Terminal advising you that the + installed, you will instead see some output in the Terminal advising you that the tools are already installed. - + More information can be found here: https://www.freecodecamp.org/news/install-xcode-command-line-tools/ @@ -100,7 +100,7 @@ off the process. 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 [Installing Models](INSTALLING_MODELS.md). + process for this is described in [Installing Models](../050_INSTALLING_MODELS.md). 8. The script will now exit and you'll be ready to generate some images. The invokeAI directory will contain numerous files. Look for a shell script @@ -128,7 +128,7 @@ python scripts/invoke.py --web --max_load_models=3 \ ``` These options are described in detail in the -[Command-Line Interface](../features/CLI.md) documentation. +[Command-Line Interface](../../features/CLI.md) documentation. ## Troubleshooting diff --git a/docs/installation/index.md b/docs/installation/index.md index b523a1efad..ef50cbab5f 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -5,7 +5,7 @@ title: Overview We offer several ways to install InvokeAI, each one suited to your experience and preferences. -1. [Automated Installer](010_INSTALL_AUTOMATED.md) +1. [Automated Installer](010_INSTALL_AUTOMATED.md) This is a script that will install all of InvokeAI's essential third party libraries and InvokeAI itself. It includes access to a @@ -31,4 +31,3 @@ experience and preferences. InvokeAI and its dependencies. This method is recommended for individuals with experience with Docker containers and understand the pluses and minuses of a container-based install. - diff --git a/scripts/configure_invokeai.py b/scripts/configure_invokeai.py index 146dd01eaa..531b39fb94 100644 --- a/scripts/configure_invokeai.py +++ b/scripts/configure_invokeai.py @@ -71,7 +71,7 @@ def postscript(errors: None): You're all set! If you installed using one of the automated installation scripts, -execute 'invoke.sh' (Linux/macOS) or 'invoke.bat' (Windows) to +execute 'invoke.sh' (Linux/macOS) or 'invoke.bat' (Windows) to start InvokeAI. If you installed manually, activate the 'invokeai' environment @@ -113,7 +113,7 @@ def user_wants_to_download_weights()->str: print('''You can download and configure the weights files manually or let this script do it for you. Manual installation is described at: -https://github.com/invoke-ai/InvokeAI/blob/main/docs/installation/INSTALLING_MODELS.md +https://invoke-ai.github.io/InvokeAI/installation/020_INSTALL_MANUAL/ You may download the recommended models (about 10GB total), select a customized set, or completely skip this step.