InvokeAI/invokeai/frontend/cli/app_arg_parser.py

from argparse import ArgumentParser, RawTextHelpFormatter

from invokeai.version import __version__

root_help = r"""Sets a root directory for the app. If omitted, the app will search for the root directory in the following order:
- The `$INVOKEAI_ROOT` environment variable
- The currently active virtual environment's parent directory
- `$HOME/invokeai`"""

app_arg_parser = ArgumentParser(description="Invoke Studio", formatter_class=RawTextHelpFormatter)
app_arg_parser.add_argument("--root", type=str, help=root_help)
app_arg_parser.add_argument(
    "--version", action="version", version=__version__, help="Displays the version and exits."
)
refactor(config): simplified config - Remove OmegaConf. It functioned as an intermediary data format, between YAML/argparse and pydantic. It's not necessary - we can parse YAML or CLI args directly with pydantic. - Remove dynamic CLI args. Only `root` is explicitly supported. This greatly simplifies config handling. Configuration is done by editing the YAML file. Frequently-used args can be added if there is a demand. - A separate arg parser is created to handle the slimmed-down CLI args. It's run immediately in the `invokeai-web` script to handle `--version` and `--help`. It is also used inside the singleton config getter (see below). - Remove categories from the config. Our settings model is mostly flat. Handling categories adds complexity for both us and users - we have to handle transforming a flat config to categorized config (and vice-versa), while users have to be careful with indentation in their YAML file. - Add a `meta` key to the config file. Currently, this holds the config schema version only. It is not a part of the config object itself. - Remove legacy settings that are no longer referenced, or were effectively no-op settings when referenced in code. - Implement simple migration logic to for v3 configs. If migration is successful, the v3 config file is backed up to `invokeai.yaml.bak` and the new config written to `invokeai.yaml`. - Previously, the singleton config was accessed by calling `InvokeAIAppConfig.get_config()`. This returned an instance of `InvokeAIAppConfig`, which _also_ has the `get_config` function. This created to a confusing situation where you weren't sure if you needed to call `get_config` or just use the config object. This method is replaced by a standalone `get_config` function which returns a singleton config object. - Wrap CLI arg parsing (for `root`) and loading/migrating `invokeai.yaml` into the new `get_config()` function. - Move `generate_config_docstrings` into standalone utility function. - Make `root` a private attr (`_root`). This reduces the temptation to directly modify and or use this sensitive field and ensures it is neither serialized nor read from input data. Use `root_path` to access the resolved root path, or `set_root` to set the root to something. 2024-03-11 11:45:24 +00:00			`from argparse import ArgumentParser, RawTextHelpFormatter`

			`from invokeai.version import __version__`

			`root_help = r"""Sets a root directory for the app. If omitted, the app will search for the root directory in the following order:`
			- The `$INVOKEAI_ROOT` environment variable
			`- The currently active virtual environment's parent directory`
			- `$HOME/invokeai`"""

			`app_arg_parser = ArgumentParser(description="Invoke Studio", formatter_class=RawTextHelpFormatter)`
			`app_arg_parser.add_argument("--root", type=str, help=root_help)`
			`app_arg_parser.add_argument(`
			`"--version", action="version", version=__version__, help="Displays the version and exits."`
			`)`