The current structure of the documentation might lead users to overlook the critical update that occurred on January 23, 2023 - where we transitioned from a user-built wheel to an official wheel. This transition means that users no longer need to manually build the library - a key piece of information that can easily be missed in its current location in the third paragraph.

Stephen Biele 2023-05-24 18:55:31 -06:00
parent 2c224442e2
commit d4072f4590

@ -1,10 +1,11 @@
Xformers library is an optional way to speedup your image generation.
# Xformers Library (Optional)
The Xformers library provides an optional method to accelerate image generation. This enhancement is exclusively available for NVIDIA GPUs, optimizing image generation and reducing VRAM usage at the expense of producing [non-deterministic](https://github.com/AUTOMATIC1111/stable-diffusion-webui/discussions/2705#discussioncomment-4024378) results.
This optimization is only available for nvidia gpus, it speeds up image generation and lowers vram usage at the cost of producing [non-deterministic](https://github.com/AUTOMATIC1111/stable-diffusion-webui/discussions/2705#discussioncomment-4024378) results.
## Important Notice - No Need for Manual Installation
As of January 23, 2023, neither Windows nor Linux users are required to manually build the Xformers library. This change was implemented when WebUI transitioned from a user-built wheel to an [official wheel](https://pypi.org/project/xformers/0.0.16rc425/#history). You can view the package upgrades and other details of this update in [this PR](https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/5939/commits/c091cf1b4acd2047644d3571bcbfd81c81b4c3af).
Note: Both Windows and linux should no longer need to build. On 1/23/23 webui shifted from a user-built wheel to an [official wheel](https://pypi.org/project/xformers/0.0.16rc425/#history) along with other package upgrades, shown in [this PR](https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/5939/commits/c091cf1b4acd2047644d3571bcbfd81c81b4c3af)
If you use a Pascal, Turing, Ampere, Lovelace or Hopper card with Python 3.10, launch the repo with `--xformers` and a compatible wheel will be installed.
## Usage
If you are using a Pascal, Turing, Ampere, Lovelace, or Hopper card with Python 3.10, simply launch the repository using the --xformers flag. The compatible wheel will be automatically installed.
## Building xformers on Windows by [@duckness](https://github.com/duckness)