diff --git a/comfy/cli_args.py b/comfy/cli_args.py index 7f1c642d9..e7031336a 100644 --- a/comfy/cli_args.py +++ b/comfy/cli_args.py @@ -9,7 +9,6 @@ class EnumAction(argparse.Action): """ Argparse action for handling Enums """ - def __init__(self, **kwargs): # Pop off the type value enum_type = kwargs.pop("type", None) @@ -37,170 +36,53 @@ class EnumAction(argparse.Action): parser = argparse.ArgumentParser() -parser.add_argument( - "--listen", - type=str, - default="127.0.0.1", - metavar="IP", - nargs="?", - const="0.0.0.0,::", - help="Specify the IP address to listen on (default: 127.0.0.1). You can give a list of ip addresses by separating them with a comma like: 127.2.2.2,127.3.3.3 If --listen is provided without an argument, it defaults to 0.0.0.0,:: (listens on all ipv4 and ipv6)", -) +parser.add_argument("--listen", type=str, default="127.0.0.1", metavar="IP", nargs="?", const="0.0.0.0,::", help="Specify the IP address to listen on (default: 127.0.0.1). You can give a list of ip addresses by separating them with a comma like: 127.2.2.2,127.3.3.3 If --listen is provided without an argument, it defaults to 0.0.0.0,:: (listens on all ipv4 and ipv6)") parser.add_argument("--port", type=int, default=8188, help="Set the listen port.") -parser.add_argument( - "--tls-keyfile", - type=str, - help="Path to TLS (SSL) key file. Enables TLS, makes app accessible at https://... requires --tls-certfile to function", -) -parser.add_argument( - "--tls-certfile", - type=str, - help="Path to TLS (SSL) certificate file. Enables TLS, makes app accessible at https://... requires --tls-keyfile to function", -) -parser.add_argument( - "--enable-cors-header", - type=str, - default=None, - metavar="ORIGIN", - nargs="?", - const="*", - help="Enable CORS (Cross-Origin Resource Sharing) with optional origin or allow all with default '*'.", -) -parser.add_argument( - "--max-upload-size", - type=float, - default=100, - help="Set the maximum upload size in MB.", -) +parser.add_argument("--tls-keyfile", type=str, help="Path to TLS (SSL) key file. Enables TLS, makes app accessible at https://... requires --tls-certfile to function") +parser.add_argument("--tls-certfile", type=str, help="Path to TLS (SSL) certificate file. Enables TLS, makes app accessible at https://... requires --tls-keyfile to function") +parser.add_argument("--enable-cors-header", type=str, default=None, metavar="ORIGIN", nargs="?", const="*", help="Enable CORS (Cross-Origin Resource Sharing) with optional origin or allow all with default '*'.") +parser.add_argument("--max-upload-size", type=float, default=100, help="Set the maximum upload size in MB.") -parser.add_argument( - "--extra-model-paths-config", - type=str, - default=None, - metavar="PATH", - nargs="+", - action="append", - help="Load one or more extra_model_paths.yaml files.", -) -parser.add_argument( - "--output-directory", - type=str, - default=None, - help="Set the ComfyUI output directory.", -) -parser.add_argument( - "--temp-directory", - type=str, - default=None, - help="Set the ComfyUI temp directory (default is in the ComfyUI directory).", -) -parser.add_argument( - "--input-directory", type=str, default=None, help="Set the ComfyUI input directory." -) -parser.add_argument( - "--auto-launch", - action="store_true", - help="Automatically launch ComfyUI in the default browser.", -) -parser.add_argument( - "--disable-auto-launch", - action="store_true", - help="Disable auto launching the browser.", -) -parser.add_argument( - "--cuda-device", - type=int, - default=None, - metavar="DEVICE_ID", - help="Set the id of the cuda device this instance will use.", -) +parser.add_argument("--extra-model-paths-config", type=str, default=None, metavar="PATH", nargs='+', action='append', help="Load one or more extra_model_paths.yaml files.") +parser.add_argument("--output-directory", type=str, default=None, help="Set the ComfyUI output directory.") +parser.add_argument("--temp-directory", type=str, default=None, help="Set the ComfyUI temp directory (default is in the ComfyUI directory).") +parser.add_argument("--input-directory", type=str, default=None, help="Set the ComfyUI input directory.") +parser.add_argument("--auto-launch", action="store_true", help="Automatically launch ComfyUI in the default browser.") +parser.add_argument("--disable-auto-launch", action="store_true", help="Disable auto launching the browser.") +parser.add_argument("--cuda-device", type=int, default=None, metavar="DEVICE_ID", help="Set the id of the cuda device this instance will use.") cm_group = parser.add_mutually_exclusive_group() -cm_group.add_argument( - "--cuda-malloc", - action="store_true", - help="Enable cudaMallocAsync (enabled by default for torch 2.0 and up).", -) -cm_group.add_argument( - "--disable-cuda-malloc", action="store_true", help="Disable cudaMallocAsync." -) +cm_group.add_argument("--cuda-malloc", action="store_true", help="Enable cudaMallocAsync (enabled by default for torch 2.0 and up).") +cm_group.add_argument("--disable-cuda-malloc", action="store_true", help="Disable cudaMallocAsync.") fp_group = parser.add_mutually_exclusive_group() -fp_group.add_argument( - "--force-fp32", - action="store_true", - help="Force fp32 (If this makes your GPU work better please report it).", -) +fp_group.add_argument("--force-fp32", action="store_true", help="Force fp32 (If this makes your GPU work better please report it).") fp_group.add_argument("--force-fp16", action="store_true", help="Force fp16.") fpunet_group = parser.add_mutually_exclusive_group() -fpunet_group.add_argument( - "--bf16-unet", - action="store_true", - help="Run the UNET in bf16. This should only be used for testing stuff.", -) -fpunet_group.add_argument( - "--fp16-unet", action="store_true", help="Store unet weights in fp16." -) -fpunet_group.add_argument( - "--fp8_e4m3fn-unet", action="store_true", help="Store unet weights in fp8_e4m3fn." -) -fpunet_group.add_argument( - "--fp8_e5m2-unet", action="store_true", help="Store unet weights in fp8_e5m2." -) +fpunet_group.add_argument("--bf16-unet", action="store_true", help="Run the UNET in bf16. This should only be used for testing stuff.") +fpunet_group.add_argument("--fp16-unet", action="store_true", help="Store unet weights in fp16.") +fpunet_group.add_argument("--fp8_e4m3fn-unet", action="store_true", help="Store unet weights in fp8_e4m3fn.") +fpunet_group.add_argument("--fp8_e5m2-unet", action="store_true", help="Store unet weights in fp8_e5m2.") fpvae_group = parser.add_mutually_exclusive_group() -fpvae_group.add_argument( - "--fp16-vae", - action="store_true", - help="Run the VAE in fp16, might cause black images.", -) -fpvae_group.add_argument( - "--fp32-vae", action="store_true", help="Run the VAE in full precision fp32." -) +fpvae_group.add_argument("--fp16-vae", action="store_true", help="Run the VAE in fp16, might cause black images.") +fpvae_group.add_argument("--fp32-vae", action="store_true", help="Run the VAE in full precision fp32.") fpvae_group.add_argument("--bf16-vae", action="store_true", help="Run the VAE in bf16.") parser.add_argument("--cpu-vae", action="store_true", help="Run the VAE on the CPU.") fpte_group = parser.add_mutually_exclusive_group() -fpte_group.add_argument( - "--fp8_e4m3fn-text-enc", - action="store_true", - help="Store text encoder weights in fp8 (e4m3fn variant).", -) -fpte_group.add_argument( - "--fp8_e5m2-text-enc", - action="store_true", - help="Store text encoder weights in fp8 (e5m2 variant).", -) -fpte_group.add_argument( - "--fp16-text-enc", action="store_true", help="Store text encoder weights in fp16." -) -fpte_group.add_argument( - "--fp32-text-enc", action="store_true", help="Store text encoder weights in fp32." -) +fpte_group.add_argument("--fp8_e4m3fn-text-enc", action="store_true", help="Store text encoder weights in fp8 (e4m3fn variant).") +fpte_group.add_argument("--fp8_e5m2-text-enc", action="store_true", help="Store text encoder weights in fp8 (e5m2 variant).") +fpte_group.add_argument("--fp16-text-enc", action="store_true", help="Store text encoder weights in fp16.") +fpte_group.add_argument("--fp32-text-enc", action="store_true", help="Store text encoder weights in fp32.") -parser.add_argument( - "--force-channels-last", - action="store_true", - help="Force channels last format when inferencing the models.", -) +parser.add_argument("--force-channels-last", action="store_true", help="Force channels last format when inferencing the models.") -parser.add_argument( - "--directml", - type=int, - nargs="?", - metavar="DIRECTML_DEVICE", - const=-1, - help="Use torch-directml.", -) - -parser.add_argument( - "--disable-ipex-optimize", - action="store_true", - help="Disables ipex.optimize when loading models with Intel GPUs.", -) +parser.add_argument("--directml", type=int, nargs="?", metavar="DIRECTML_DEVICE", const=-1, help="Use torch-directml.") +parser.add_argument("--disable-ipex-optimize", action="store_true", help="Disables ipex.optimize when loading models with Intel GPUs.") class LatentPreviewMethod(enum.Enum): NoPreviews = "none" @@ -208,164 +90,56 @@ class LatentPreviewMethod(enum.Enum): Latent2RGB = "latent2rgb" TAESD = "taesd" +parser.add_argument("--preview-method", type=LatentPreviewMethod, default=LatentPreviewMethod.NoPreviews, help="Default preview method for sampler nodes.", action=EnumAction) -parser.add_argument( - "--preview-method", - type=LatentPreviewMethod, - default=LatentPreviewMethod.NoPreviews, - help="Default preview method for sampler nodes.", - action=EnumAction, -) - -parser.add_argument( - "--preview-size", - type=int, - default=512, - help="Sets the maximum preview size for sampler nodes.", -) +parser.add_argument("--preview-size", type=int, default=512, help="Sets the maximum preview size for sampler nodes.") cache_group = parser.add_mutually_exclusive_group() -cache_group.add_argument( - "--cache-classic", - action="store_true", - help="Use the old style (aggressive) caching.", -) -cache_group.add_argument( - "--cache-lru", - type=int, - default=0, - help="Use LRU caching with a maximum of N node results cached. May use more RAM/VRAM.", -) +cache_group.add_argument("--cache-classic", action="store_true", help="Use the old style (aggressive) caching.") +cache_group.add_argument("--cache-lru", type=int, default=0, help="Use LRU caching with a maximum of N node results cached. May use more RAM/VRAM.") attn_group = parser.add_mutually_exclusive_group() -attn_group.add_argument( - "--use-split-cross-attention", - action="store_true", - help="Use the split cross attention optimization. Ignored when xformers is used.", -) -attn_group.add_argument( - "--use-quad-cross-attention", - action="store_true", - help="Use the sub-quadratic cross attention optimization . Ignored when xformers is used.", -) -attn_group.add_argument( - "--use-pytorch-cross-attention", - action="store_true", - help="Use the new pytorch 2.0 cross attention function.", -) +attn_group.add_argument("--use-split-cross-attention", action="store_true", help="Use the split cross attention optimization. Ignored when xformers is used.") +attn_group.add_argument("--use-quad-cross-attention", action="store_true", help="Use the sub-quadratic cross attention optimization . Ignored when xformers is used.") +attn_group.add_argument("--use-pytorch-cross-attention", action="store_true", help="Use the new pytorch 2.0 cross attention function.") parser.add_argument("--disable-xformers", action="store_true", help="Disable xformers.") upcast = parser.add_mutually_exclusive_group() -upcast.add_argument( - "--force-upcast-attention", - action="store_true", - help="Force enable attention upcasting, please report if it fixes black images.", -) -upcast.add_argument( - "--dont-upcast-attention", - action="store_true", - help="Disable all upcasting of attention. Should be unnecessary except for debugging.", -) +upcast.add_argument("--force-upcast-attention", action="store_true", help="Force enable attention upcasting, please report if it fixes black images.") +upcast.add_argument("--dont-upcast-attention", action="store_true", help="Disable all upcasting of attention. Should be unnecessary except for debugging.") vram_group = parser.add_mutually_exclusive_group() -vram_group.add_argument( - "--gpu-only", - action="store_true", - help="Store and run everything (text encoders/CLIP models, etc... on the GPU).", -) -vram_group.add_argument( - "--highvram", - action="store_true", - help="By default models will be unloaded to CPU memory after being used. This option keeps them in GPU memory.", -) -vram_group.add_argument( - "--normalvram", - action="store_true", - help="Used to force normal vram use if lowvram gets automatically enabled.", -) -vram_group.add_argument( - "--lowvram", action="store_true", help="Split the unet in parts to use less vram." -) -vram_group.add_argument( - "--novram", action="store_true", help="When lowvram isn't enough." -) -vram_group.add_argument( - "--cpu", action="store_true", help="To use the CPU for everything (slow)." -) +vram_group.add_argument("--gpu-only", action="store_true", help="Store and run everything (text encoders/CLIP models, etc... on the GPU).") +vram_group.add_argument("--highvram", action="store_true", help="By default models will be unloaded to CPU memory after being used. This option keeps them in GPU memory.") +vram_group.add_argument("--normalvram", action="store_true", help="Used to force normal vram use if lowvram gets automatically enabled.") +vram_group.add_argument("--lowvram", action="store_true", help="Split the unet in parts to use less vram.") +vram_group.add_argument("--novram", action="store_true", help="When lowvram isn't enough.") +vram_group.add_argument("--cpu", action="store_true", help="To use the CPU for everything (slow).") -parser.add_argument( - "--reserve-vram", - type=float, - default=None, - help="Set the amount of vram in GB you want to reserve for use by your OS/other software. By default some amount is reverved depending on your OS.", -) +parser.add_argument("--reserve-vram", type=float, default=None, help="Set the amount of vram in GB you want to reserve for use by your OS/other software. By default some amount is reverved depending on your OS.") -parser.add_argument( - "--default-hashing-function", - type=str, - choices=["md5", "sha1", "sha256", "sha512"], - default="sha256", - help="Allows you to choose the hash function to use for duplicate filename / contents comparison. Default is sha256.", -) +parser.add_argument("--default-hashing-function", type=str, choices=['md5', 'sha1', 'sha256', 'sha512'], default='sha256', help="Allows you to choose the hash function to use for duplicate filename / contents comparison. Default is sha256.") -parser.add_argument( - "--disable-smart-memory", - action="store_true", - help="Force ComfyUI to agressively offload to regular ram instead of keeping models in vram when it can.", -) -parser.add_argument( - "--deterministic", - action="store_true", - help="Make pytorch use slower deterministic algorithms when it can. Note that this might not make images deterministic in all cases.", -) -parser.add_argument( - "--fast", - action="store_true", - help="Enable some untested and potentially quality deteriorating optimizations.", -) +parser.add_argument("--disable-smart-memory", action="store_true", help="Force ComfyUI to agressively offload to regular ram instead of keeping models in vram when it can.") +parser.add_argument("--deterministic", action="store_true", help="Make pytorch use slower deterministic algorithms when it can. Note that this might not make images deterministic in all cases.") +parser.add_argument("--fast", action="store_true", help="Enable some untested and potentially quality deteriorating optimizations.") -parser.add_argument( - "--dont-print-server", action="store_true", help="Don't print server output." -) -parser.add_argument( - "--quick-test-for-ci", action="store_true", help="Quick test for CI." -) -parser.add_argument( - "--windows-standalone-build", - action="store_true", - help="Windows standalone build: Enable convenient things that most people using the standalone windows build will probably enjoy (like auto opening the page on startup).", -) +parser.add_argument("--dont-print-server", action="store_true", help="Don't print server output.") +parser.add_argument("--quick-test-for-ci", action="store_true", help="Quick test for CI.") +parser.add_argument("--windows-standalone-build", action="store_true", help="Windows standalone build: Enable convenient things that most people using the standalone windows build will probably enjoy (like auto opening the page on startup).") -parser.add_argument( - "--disable-metadata", - action="store_true", - help="Disable saving prompt metadata in files.", -) -parser.add_argument( - "--disable-all-custom-nodes", - action="store_true", - help="Disable loading all custom nodes.", -) +parser.add_argument("--disable-metadata", action="store_true", help="Disable saving prompt metadata in files.") +parser.add_argument("--disable-all-custom-nodes", action="store_true", help="Disable loading all custom nodes.") -parser.add_argument( - "--multi-user", action="store_true", help="Enables per-user storage." -) +parser.add_argument("--multi-user", action="store_true", help="Enables per-user storage.") -parser.add_argument( - "--verbose", - default="INFO", - const="DEBUG", - nargs="?", - choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], - help="Set the logging level", -) +parser.add_argument("--verbose", default='INFO', const='DEBUG', nargs="?", choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], help='Set the logging level') + +parser.add_argument("--xla", action="store_true", help="To use the XLA devices for everything.") -parser.add_argument( - "--xla", action="store_true", help="To use the XLA devices for everything." -) # The default built-in provider hosted under web/ DEFAULT_VERSION_STRING = "comfyanonymous/ComfyUI@latest" @@ -384,7 +158,6 @@ parser.add_argument( """, ) - def is_valid_directory(path: Optional[str]) -> Optional[str]: """Validate if the given path is a directory.""" if path is None: @@ -394,7 +167,6 @@ def is_valid_directory(path: Optional[str]) -> Optional[str]: raise argparse.ArgumentTypeError(f"{path} is not a valid directory.") return path - parser.add_argument( "--front-end-root", type=is_valid_directory, @@ -402,12 +174,7 @@ parser.add_argument( help="The local filesystem path to the directory where the frontend is located. Overrides --front-end-version.", ) -parser.add_argument( - "--user-directory", - type=is_valid_directory, - default=None, - help="Set the ComfyUI user directory with an absolute path.", -) +parser.add_argument("--user-directory", type=is_valid_directory, default=None, help="Set the ComfyUI user directory with an absolute path.") if comfy.options.args_parsing: args = parser.parse_args()