From 6bb102f8606aec2a22764dd82d67f0a696122afb Mon Sep 17 00:00:00 2001 From: Eugene Brodsky Date: Wed, 26 Mar 2025 12:07:34 -0400 Subject: [PATCH] modify docs for python 3.12 --- docs/contributing/dev-environment.md | 2 +- docs/installation/manual.md | 8 ++++---- docs/installation/requirements.md | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/contributing/dev-environment.md b/docs/contributing/dev-environment.md index 6b63851df3..72fc932c54 100644 --- a/docs/contributing/dev-environment.md +++ b/docs/contributing/dev-environment.md @@ -41,7 +41,7 @@ If you just want to use Invoke, you should use the [launcher][launcher link]. With the modifications made, the install command should look something like this: ```sh - uv pip install -e ".[dev,test,docs,xformers]" --python 3.11 --python-preference only-managed --index=https://download.pytorch.org/whl/cu124 --reinstall + uv pip install -e ".[dev,test,docs,xformers]" --python 3.12 --python-preference only-managed --index=https://download.pytorch.org/whl/cu124 --reinstall ``` 6. At this point, you should have Invoke installed, a venv set up and activated, and the server running. But you will see a warning in the terminal that no UI was found. If you go to the URL for the server, you won't get a UI. diff --git a/docs/installation/manual.md b/docs/installation/manual.md index 620e193b5d..5feb791600 100644 --- a/docs/installation/manual.md +++ b/docs/installation/manual.md @@ -43,10 +43,10 @@ The following commands vary depending on the version of Invoke being installed a 3. Create a virtual environment in that directory: ```sh - uv venv --relocatable --prompt invoke --python 3.11 --python-preference only-managed .venv + uv venv --relocatable --prompt invoke --python 3.12 --python-preference only-managed .venv ``` - This command creates a portable virtual environment at `.venv` complete with a portable python 3.11. It doesn't matter if your system has no python installed, or has a different version - `uv` will handle everything. + This command creates a portable virtual environment at `.venv` complete with a portable python 3.12. It doesn't matter if your system has no python installed, or has a different version - `uv` will handle everything. 4. Activate the virtual environment: @@ -88,13 +88,13 @@ The following commands vary depending on the version of Invoke being installed a 8. Install the `invokeai` package. Substitute the package specifier and version. ```sh - uv pip install == --python 3.11 --python-preference only-managed --force-reinstall + uv pip install == --python 3.12 --python-preference only-managed --force-reinstall ``` If you determined you needed to use a `PyPI` index URL in the previous step, you'll need to add `--index=` like this: ```sh - uv pip install == --python 3.11 --python-preference only-managed --index= --force-reinstall + uv pip install == --python 3.12 --python-preference only-managed --index= --force-reinstall ``` 9. Deactivate and reactivate your venv so that the invokeai-specific commands become available in the environment: diff --git a/docs/installation/requirements.md b/docs/installation/requirements.md index dfb40f7e3b..5f27481109 100644 --- a/docs/installation/requirements.md +++ b/docs/installation/requirements.md @@ -41,7 +41,7 @@ The requirements below are rough guidelines for best performance. GPUs with less You don't need to do this if you are installing with the [Invoke Launcher](./quick_start.md). -Invoke requires python 3.10 or 3.11. If you don't already have one of these versions installed, we suggest installing 3.11, as it will be supported for longer. +Invoke requires python 3.10 through 3.12. If you don't already have one of these versions installed, we suggest installing 3.12, as it will be supported for longer. Check that your system has an up-to-date Python installed by running `python3 --version` in the terminal (Linux, macOS) or cmd/powershell (Windows). @@ -49,19 +49,19 @@ Check that your system has an up-to-date Python installed by running `python3 -- === "Windows" - - Install python 3.11 with [an official installer]. + - Install python with [an official installer]. - The installer includes an option to add python to your PATH. Be sure to enable this. If you missed it, re-run the installer, choose to modify an existing installation, and tick that checkbox. - You may need to install [Microsoft Visual C++ Redistributable]. === "macOS" - - Install python 3.11 with [an official installer]. + - Install python with [an official installer]. - If model installs fail with a certificate error, you may need to run this command (changing the python version to match what you have installed): `/Applications/Python\ 3.10/Install\ Certificates.command` - If you haven't already, you will need to install the XCode CLI Tools by running `xcode-select --install` in a terminal. === "Linux" - - Installing python varies depending on your system. On Ubuntu, you can use the [deadsnakes PPA](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa). + - Installing python varies depending on your system. We recommend [using `uv` to manage your python installation](https://docs.astral.sh/uv/concepts/python-versions/#installing-a-python-version). - You'll need to install `libglib2.0-0` and `libgl1-mesa-glx` for OpenCV to work. For example, on a Debian system: `sudo apt update && sudo apt install -y libglib2.0-0 libgl1-mesa-glx` ## Drivers