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

docs: update CONFIGURATION.md

Browse Source
This commit is contained in:
psychedelicious 2024-03-19 17:16:23 +11:00
parent 96ef7e3889
commit 13c72206d8
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/features/CONFIGURATION.md
View File

@ -18,9 +18,6 @@ Settings sources are used in this order:
- `invokeai.yaml` settings - `invokeai.yaml` settings
- Fallback: defaults - Fallback: defaults
The most commonly changed settings are also accessible
graphically via the `invokeai-configure` script.
### InvokeAI Root Directory ### InvokeAI Root Directory
On startup, InvokeAI searches for its "root" directory. This is the directory On startup, InvokeAI searches for its "root" directory. This is the directory
@ -42,10 +39,9 @@ It has two sections - one for internal use and one for user settings:
```yaml ```yaml
# Internal metadata - do not edit: # Internal metadata - do not edit:
meta: schema_version: 4
schema_version: 4
# Put user settings here: # Put user settings here - see https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/:
host: 0.0.0.0 # serve the app on your local network host: 0.0.0.0 # serve the app on your local network
models_dir: D:\invokeai\models # store models on an external drive models_dir: D:\invokeai\models # store models on an external drive
precision: float16 # always use fp16 precision precision: float16 # always use fp16 precision
@ -62,6 +58,12 @@ You can fix a broken `invokeai.yaml` by deleting it and running the
configuration script again -- option [6] in the launcher, "Re-run the configuration script again -- option [6] in the launcher, "Re-run the
configure script". configure script".
#### Custom Config File Location
You can use any config file with the `--config` CLI arg. Pass in the path to the `invokeai.yaml` file you want to use.
Note that environment variables will trump any settings in the config file.
### Environment Variables ### Environment Variables
All settings may be set via environment variables by prefixing `INVOKEAI_` All settings may be set via environment variables by prefixing `INVOKEAI_`
@ -81,13 +83,10 @@ We suggest using `invokeai.yaml`, as it is more user-friendly.
A subset of settings may be specified using CLI args: A subset of settings may be specified using CLI args:
- `--root`: specify the root directory - `--root`: specify the root directory
- `--ignore_missing_core-models`: if set, do not check for models needed - `--config`: override the default `invokeai.yaml` file location
to convert checkpoint/safetensor models to diffusers
### All Settings ### All Settings
The config is managed by the `InvokeAIAppConfig` class. The below docs are autogenerated from the class.
Following the table are additional explanations for certain settings. Following the table are additional explanations for certain settings.
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->