Skip to content

Commit 5cd827e

Browse files
mohnjilesclaude
andcommitted
docs: fix factual errors, typos, and dead links
Fact-checked the docs against the current codebase and fixed: - installation.md: VC++ Redistributable is auto-installed by SM during package install (WindowsPrerequisiteHelper); manual install reframed as a troubleshooting fallback - environment-variables.md: MIOPEN_SEARCH_CUTOFF auto-applied value is 1 (not 2); added MIOPEN_FIND_ENFORCE=1 to the auto-applied list; clarified RDNA3/RDNA3.5/RDNA4 gating incl. gfx1152/gfx1153 AOTriton exclusion; noted ComfyUI-Zluda's own auto-set vars and that the env-var editor overrides auto-applied defaults - inference/overview.md: video generation is three independent tabs (Wan T2V, Wan I2V, SVD I2V), not one mode; removed self-referential breadcrumb - supported-packages.md: ComfyUI-Zluda manual-setup cutoff is RX 6800 (matches the package's own disclaimer) - terminology.md: removed incorrect "Variable Auto Encoder" alternate name; corrected the "most SDXL checkpoints are VAE-baked" overclaim; framed CFG ranges as community rules of thumb; reduced repetitive phrasing throughout (wording only, no content changes) - overview.md: softened VRAM figures as dated rules of thumb - Converted links to not-yet-written pages into plain text with (planned) markers so nothing 404s; fixed typos (documentation, explanation, packages, Integration) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 796cdde commit 5cd827e

9 files changed

Lines changed: 116 additions & 107 deletions

File tree

docs/README.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Stability Matrix is a multi-platform package manager for Stable Diffusion and related AI image/video generation tools. This documentation covers all major features and sections of the application.
44

5-
This docuemtation is intended to provide a detailed guide and explaination of the many functions of Stability Matrix, its installation and use for both new and current users, and also more detailed and technical material for advanced users.
6-
While it contains information on a vast majority of application specific functions, It also contains information that applies to AI image, video, and related generation aspects that can be useful both inside and outside of Stability Matrix.
5+
This documentation is intended to provide a detailed guide and explanation of the many functions of Stability Matrix, its installation and use for both new and current users, and also more detailed and technical material for advanced users.
6+
While it contains information on a vast majority of application specific functions, it also contains information that applies to AI image, video, and related generation aspects that can be useful both inside and outside of Stability Matrix.
77
While not all encompassing on every minute detail, it is intended to be updated as new features and changes are released to the project as well as new ecosystem/model/usage information as-needed.
88

99
Current Status: In-progress - Structure is in-place and planned docs are currently being progressively created and added.
@@ -20,57 +20,58 @@ Current Status: In-progress - Structure is in-place and planned docs are current
2020
- [Overview](package-manager/overview.md) — Managing AI packages in Stability Matrix
2121
- [Supported Packages](package-manager/supported-packages.md) — Full list of supported inference and training packages
2222
- [Installing Packages](package-manager/installing-packages.md) — One-click install, hardware selection, GPU backends
23-
- [Managing Packages](package-manager/managing-packages.md) — Launching, monitoring, updating, and deleting installed packages
24-
- [Launch Arguments](package-manager/launch-arguments.md) — Configuring launch arguments per package
25-
- [Extensions](package-manager/extensions.md) — Browsing and managing package plugins and extensions
23+
- Managing Packages *(planned)* — Launching, monitoring, updating, and deleting installed packages
24+
- Launch Arguments *(planned)* — Configuring launch arguments per package
25+
- Extensions *(planned)* — Browsing and managing package plugins and extensions
2626

2727
### Inference
2828
- [Overview](inference/overview.md) — The Inference UI, panel layout, and project files
29-
- [Text to Image](inference/text-to-image.md) — Generating images from text prompts
30-
- [Image to Image](inference/image-to-image.md) — Using an image as a generation starting point
31-
- [Image Upscale](inference/image-upscale.md) — Upscaling images with AI upscaler models
32-
- [Video Generation](inference/video-generation.md) — Generating video with WAN and SVD models
33-
- [Advanced Controls](inference/advanced-controls.md) — ControlNet, FaceDetailer, FreeU, LayerDiffuse, and more
29+
- Text to Image *(planned)* — Generating images from text prompts
30+
- Image to Image *(planned)* — Using an image as a generation starting point
31+
- Image Upscale *(planned)* — Upscaling images with AI upscaler models
32+
- Video Generation *(planned)* — Generating video with WAN and SVD models
33+
- Advanced Controls *(planned)* — ControlNet, FaceDetailer, FreeU, LayerDiffuse, and more
3434

3535
### Checkpoint Manager
36-
- [Overview](checkpoint-manager/overview.md) — Centralized model storage shared across all packages
37-
- [Model Categories](checkpoint-manager/model-categories.md) — All supported model folder types explained
38-
- [Metadata Editing](checkpoint-manager/metadata-editing.md) — Importing CivitAI metadata and editing model info
36+
- Overview *(planned)* — Centralized model storage shared across all packages
37+
- Model Categories *(planned)* — All supported model folder types explained
38+
- Metadata Editing *(planned)* — Importing CivitAI metadata and editing model info
3939

4040
### Model Browser
41-
- [Overview](model-browser/overview.md) — Multi-source model browser and download queue
42-
- [CivitAI](model-browser/civitai.md) — Browsing and downloading from CivitAI
43-
- [HuggingFace](model-browser/huggingface.md) — Browsing and downloading from HuggingFace
44-
- [OpenModelDB](model-browser/openmodeldb.md) — Browsing upscaler models from OpenModelDB
41+
- Overview *(planned)* — Multi-source model browser and download queue
42+
- CivitAI *(planned)* — Browsing and downloading from CivitAI
43+
- HuggingFace *(planned)* — Browsing and downloading from HuggingFace
44+
- OpenModelDB *(planned)* — Browsing upscaler models from OpenModelDB
4545

4646
### Outputs
47-
- [Overview](outputs/overview.md) — Image gallery, sorting, filtering, and batch operations
48-
- [Image Metadata](outputs/image-metadata.md) — Reading embedded generation parameters and ComfyUI node data
47+
- Overview *(planned)* — Image gallery, sorting, filtering, and batch operations
48+
- Image Metadata *(planned)* — Reading embedded generation parameters and ComfyUI node data
4949

5050
### Workflows
51-
- [Overview](workflows/overview.md) — Browsing and managing ComfyUI workflows
52-
- [Community Workflows](workflows/community-workflows.md) — Browsing community workflows via OpenArt
51+
- Overview *(planned)* — Browsing and managing ComfyUI workflows
52+
- Community Workflows *(planned)* — Browsing community workflows via OpenArt
5353

5454
### Settings
55-
- [Overview](settings/overview.md) — Navigating the settings hub
56-
- [General](settings/general.md) — Theme, language, data directory, and shared folder settings
57-
- [Accounts](settings/accounts.md) — Lykos account, OAuth login, and API tokens
58-
- [Inference Settings](settings/inference-settings.md) — Inference UI behavior and defaults
59-
- [Updates](settings/updates.md) — Auto-update channel and frequency settings
55+
- Overview *(planned)* — Navigating the settings hub
56+
- General *(planned)* — Theme, language, data directory, and shared folder settings
57+
- Accounts *(planned)* — Lykos account, OAuth login, and API tokens
58+
- Inference Settings *(planned)* — Inference UI behavior and defaults
59+
- Updates *(planned)* — Auto-update channel and frequency settings
6060

6161
### Advanced
62-
- [Building from Source and Contributing](advanced/building-from-source.md) — Local builds, runtime targets, and where to start for code or docs contributions
63-
- [Shared Folders](advanced/shared-folders.md) — Folder structure, symlinks, and cross-package model sharing
64-
- [Hardware Support](advanced/hardware-support.md) — CUDA, ROCm, DirectML, MPS, ZLUDA, IPEX, and CPU backends
65-
- [Python Environment](advanced/python-environment.md) — Virtual environments, uv, pip, and Python version management
62+
- [Overview](advanced/overview.md) — Advanced configuration and technical reference
63+
- Building from Source and Contributing *(planned)* — Local builds, runtime targets, and where to start for code or docs contributions
64+
- Shared Folders *(planned)* — Folder structure, symlinks, and cross-package model sharing
65+
- Hardware Support *(planned)* — CUDA, ROCm, DirectML, MPS, ZLUDA, IPEX, and CPU backends
66+
- Python Environment *(planned)* — Virtual environments, uv, pip, and Python version management
6667
- [ComfyUI Integration](advanced/comfyui-integration.md) — ComfyUI node API, WebSocket protocol, and custom nodes
6768
- [Environment Variables](advanced/environment-variables.md) — Per-package environment variable configuration
6869

6970
### Tips and Tricks
7071
- [Overview](tips/overview.md) — Tips and Tricks index
7172
- [Terminology](tips/terminology.md) — Common image generation terms and what they mean
72-
- [Inference UI Tips](tips/inference-ui.md) — Effective use of the built-in Inference UI
73-
- [Per-Package Tips](tips/per-package.md) — Package-specific tips and links to upstream documentation
74-
- [AMD GPU Workflow](tips/amd-gpu-workflow.md) — Getting image and video generation working on AMD hardware
75-
- [Model Dependencies](tips/model-dependencies.md) — Required secondary files for modern models (text encoders, VAEs, etc.)
76-
- [VRAM Optimization](tips/vram-optimization.md) — Reducing VRAM usage without sacrificing too much quality or speed
73+
- Inference UI Tips *(planned)* — Effective use of the built-in Inference UI
74+
- Per-Package Tips *(planned)* — Package-specific tips and links to upstream documentation
75+
- AMD GPU Workflow *(planned)* — Getting image and video generation working on AMD hardware
76+
- Model Dependencies *(planned)* — Required secondary files for modern models (text encoders, VAEs, etc.)
77+
- VRAM Optimization *(planned)* — Reducing VRAM usage without sacrificing too much quality or speed

docs/advanced/environment-variables.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ For ordinary Stability Matrix usage, the most practical variables here are `PYTO
100100

101101
## HuggingFace Cache Variables
102102

103-
These variables are useful when a package downloads models, tokenizers, datasets, or other assets from the Hugging Face ecosystem. In Stability Matrix, the most common reasons to set them are moving caches off the system drive, forcing offline operation, or making Hub requests more reliable on slow connections. These are mainly to modify HuggingFace operations within Packages themselves (HF features built into WebUI's, HF download capable extensions/custom nodes)
103+
These variables are useful when a package downloads models, tokenizers, datasets, or other assets from the Hugging Face ecosystem. In Stability Matrix, the most common reasons to set them are moving caches off the system drive, forcing offline operation, or making Hub requests more reliable on slow connections. These mainly modify HuggingFace operations within packages themselves, such as HF features built into WebUIs or HF-download-capable extensions and custom nodes.
104104

105105
Because Stability Matrix injects environment variables globally, remember that authentication or offline-mode settings here will affect every launched package that uses `huggingface_hub`, `transformers`, `datasets`, or a library built on top of them.
106106

@@ -140,26 +140,32 @@ Most users should leave these alone unless they are troubleshooting a specific R
140140
| `MIOPEN_LOG_LEVEL` | `5` | Sets MIOpen log verbosity. Higher values provide more detailed internal logging and are useful when debugging solver selection, kernel compilation, or runtime failures. |
141141
| `MIOPEN_CHECK_NUMERICS` | `0x02` or `0x04` | Checks tensors for NaNs, infinities, and related numerical problems. This is useful when a ROCm workflow produces corrupted outputs or starts failing only on certain models or resolutions. |
142142
| `MIOPEN_GEMM_ENFORCE_BACKEND` | `5` | Overrides MIOpen's GEMM backend selection. This is an advanced tuning variable that can be useful when comparing rocBLAS and hipBLASLt behavior or isolating backend-specific regressions. |
143-
| `COMFYUI_ENABLE_MIOPEN` | `1` | Tells ComfyUI to keep the MIOpen-backed path enabled on ROCm builds where it may otherwise be disabled by default. Without this enabled, ComfyUI disables the `cudnn` backend path in its backend calls for RDNA 3, RDNA 4, and newer AMD GPUs, which in turn disables the MIOpen-backed functions that rely on that path. This variable is needed for MIOpen to function properly in those setups. |
143+
| `COMFYUI_ENABLE_MIOPEN` | `1` | Tells ComfyUI to keep the MIOpen-backed path enabled on ROCm builds where it may otherwise be disabled by default. Without this enabled, ComfyUI disables the `cudnn` backend path in its backend calls for RDNA3, RDNA3.5, and RDNA4 AMD GPUs, which in turn disables the MIOpen-backed functions that rely on that path. This variable is needed for MIOpen to function properly in those setups. |
144144
| `TORCH_ROCM_AOTRITON_ENABLE_EXPERIMENTAL` | `1` | Enables the experimental ROCm AOTriton path in compatible PyTorch builds. In Stability Matrix's Windows ROCm ComfyUI integration, this is used for TheRock technical-preview PyTorch builds to enable AOTriton-provided built-in Flash Attention and PyTorch SDPA memory-efficient attention paths. |
145145

146146
For some Windows ROCm-based ComfyUI launches, Stability Matrix already applies several of these optimizations automatically in package code, including:
147147

148148
`MIOPEN_FIND_MODE=2`
149149

150-
`MIOPEN_SEARCH_CUTOFF=2`
150+
`MIOPEN_SEARCH_CUTOFF=1`
151151

152-
`TORCH_ROCM_AOTRITON_ENABLE_EXPERIMENTAL=1` (RDNA3 and newer only)
152+
`MIOPEN_FIND_ENFORCE=1`
153+
154+
`TORCH_ROCM_AOTRITON_ENABLE_EXPERIMENTAL=1` (RDNA3 / RDNA3.5 / RDNA4 only, and additionally excluded on the gfx1152/gfx1153 APU architectures where AOTriton isn't yet supported)
153155

154156
`FLASH_ATTENTION_TRITON_AMD_ENABLE=TRUE`
155157

156-
`COMFYUI_ENABLE_MIOPEN=1` (RDNA3 and newer only)
158+
`COMFYUI_ENABLE_MIOPEN=1` (RDNA3 / RDNA3.5 / RDNA4 only, no gfx1152/gfx1153 exclusion)
157159

158160
`PYTORCH_ALLOC_CONF=max_split_size_mb:512,garbage_collection_threshold:0.8`
159161

160162

161163
Linux installs do not currently get the same automatic overrides, so they will need to be enabled by the user.
162164

165+
If you're using the ComfyUI-Zluda package specifically, it also sets its own environment variables at launch on top of the above: `FLASH_ATTENTION_TRITON_AMD_ENABLE=TRUE`, `MIOPEN_FIND_MODE=2`, `MIOPEN_LOG_LEVEL=3`, and `ZLUDA_COMGR_LOG_LEVEL=1`. If you're wondering why those already appear to be set for a ZLUDA install, this is why.
166+
167+
Whatever you set in Stability Matrix's own environment-variable editor is applied last, so it always overrides these auto-applied defaults if the same variable name is used.
168+
163169
For a broader reference, see the [official ROCm environment variable documentation](https://rocm.docs.amd.com/en/latest/reference/env-variables.html) and the [official MIOpen environment variable documentation](https://rocm.docs.amd.com/projects/MIOpen/en/latest/reference/env_variables.html).
164170

165171

docs/getting-started/first-launch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,5 @@ Once the license agreement is accepted and the data directory is configured, Sta
6868
From there, the usual next steps are:
6969

7070
- [Install your first package](../package-manager/installing-packages.md)
71-
- [Browse or import models](../model-browser/overview.md)
71+
- Browse or import models with the Model Browser *(planned)*
7272
- If the user installed ComfyUI and downloaded a starter model during setup, they can [go straight to generating with the built-in Inference UI](../inference/overview.md)

docs/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Windows releases are distributed as a `.zip` archive rather than a traditional i
3636
2. Extract the archive to a folder where Stability Matrix should live.
3737
3. Open the extracted folder and run `StabilityMatrix.exe`.
3838

39-
The Microsoft Visual C++ Redistributable for x64 is required on Windows. On many systems it is already present, but if a package fails to start because the required Microsoft C/C++ runtime is missing (e.g. missing c10.dll error loading PyTorch), install the latest [Visual C++ Redistributable x64 package](https://aka.ms/vc14/vc_redist.x64.exe) or see Microsoft's [Visual C++ Redistributable downloads page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
39+
The Microsoft Visual C++ Redistributable for x64 is required on Windows. Stability Matrix checks for it automatically during package installation and silently installs the required version as part of the normal prerequisite setup, so most users never need to do anything here. If a package still fails to start because the required Microsoft C/C++ runtime is missing (e.g. missing c10.dll error loading PyTorch), that's a sign the automatic install didn't complete successfully — as a fallback, install the latest [Visual C++ Redistributable x64 package](https://aka.ms/vc14/vc_redist.x64.exe) manually, or see Microsoft's [Visual C++ Redistributable downloads page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
4040

4141
On first launch, Windows may show a SmartScreen warning because the app was downloaded from the internet. If that happens, select **More info** and then **Run anyway** to continue, provided the download came from the official Downloads page or the project's GitHub Releases page.
4242

@@ -53,7 +53,7 @@ Official macOS releases are published for Apple Silicon as a `.dmg`.
5353

5454
If Gatekeeper blocks the first launch, open the app once with **Open** from the context menu, or allow it from **System Settings > Privacy & Security** if macOS shows an override prompt there.
5555

56-
For platform support details and hardware expectations on Apple Silicon, see [Apple Silicon (MPS)](../advanced/hardware-support.md#apple-silicon-mps).
56+
Platform support details and hardware expectations on Apple Silicon (MPS) will be covered in a planned Hardware Support page.
5757

5858
## Linux
5959

0 commit comments

Comments
 (0)