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

Improve readability of the manual installation documentation (#2296)

Browse Source 
* docs: Fix links to pip and Conda installation methods

* docs: Improve installation script readability

This commit adds a space between `-m` option and the module name.

* docs: Fix alignments of step 4 & 9 in `pip` installation method

* docs: Rewrite step 10 of the ` pip` installation method

Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
This commit is contained in:
Daya Adianto 2023-01-16 05:37:02 +07:00 committed by GitHub
parent 4486169a83
commit 5b35fa53a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/installation/020_INSTALL_MANUAL.md
View File

@ -12,17 +12,18 @@ title: Installing Manually
## Introduction ## Introduction
You have two choices for manual installation, the [first You have two choices for manual installation.
one](#PIP_method) uses basic Python virtual environment (`venv`) The [first one](#pip-Install) uses basic Python virtual environment (`venv`)
commands and the PIP package manager. The [second one](#Conda_method) command and `pip` package manager.
based on the Anaconda3 package manager (`conda`). Both methods require The [second one](#Conda-method) uses Anaconda3 package manager (`conda`).
you to enter commands on the terminal, also known as the "console". Both methods require you to enter commands on the terminal, also known as the
"console".
Note that the conda install method is currently deprecated and will not Note that the `conda` installation method is currently deprecated and will
be supported at some point in the future. not 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 command-line completion. features such as command-line completion.
@ -37,7 +38,7 @@ manager, please follow these steps:
```bash ```bash
python -V python -V
``` ```
2. Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from 2. Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from
GitHub: GitHub:
@ -52,15 +53,15 @@ manager, please follow these steps:
environment named `invokeai`: environment named `invokeai`:
```bash ```bash
python -mvenv invokeai python -m venv invokeai
source invokeai/bin/activate source invokeai/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 -mensurepip --upgrade python -m ensurepip --upgrade
python -mpip install --upgrade pip python -m pip install --upgrade pip
``` ```
5. Pick the correct `requirements*.txt` file for your hardware and operating 5. Pick the correct `requirements*.txt` file for your hardware and operating
@ -199,20 +200,20 @@ 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! 9. 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 things you
can do with InvokeAI. 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 run "conda activate 10. Subsequently, to relaunch the script, be sure to enter `InvokeAI` directory,
invokeai", enter the `InvokeAI` directory, and then launch the invoke activate the virtual environment, and then launch `invoke.py` script.
script. If you forget to activate the 'invokeai' environment, the script If you forget to activate the virtual environment,
will fail with multiple `ModuleNotFound` errors. the script will fail with multiple `ModuleNotFound` errors.
!!! tip !!! tip