ComfyUI Node: Model Downloader 🐑

Model Downloader 🐑| Model Downloader 🐑:

The ModelDownloader| Model Downloader 🐑 node is designed to facilitate the seamless downloading of models from various online sources, including Hugging Face repositories. This node is particularly beneficial for AI artists who need to access and utilize different models without delving into the complexities of manual downloads and file management. By automating the download process, it ensures that models are stored in the correct directories, making them readily available for use in your projects. The node supports features such as handling authorization tokens for secure downloads, using mirrors for faster access, and managing file overwrites to prevent data loss. Its primary goal is to streamline the workflow of acquiring models, thus enhancing productivity and allowing you to focus more on creative tasks.

Model Downloader 🐑| Model Downloader 🐑 Input Parameters:

url

The url parameter specifies the web address from which the model will be downloaded. It is crucial as it directs the node to the exact location of the model file. This parameter must be a valid URL, and it can include links to Hugging Face repositories or other supported sources. There are no specific minimum or maximum values, but it must be a properly formatted URL.

save_path

The save_path parameter determines the directory path where the downloaded model will be saved. This path is relative to the base models directory configured in your system. It allows you to organize downloaded models into specific folders for better management. There are no strict constraints on this parameter, but it should be a valid directory path.

override

The override parameter is a boolean flag that dictates whether an existing file with the same name should be overwritten. If set to True, any existing file at the target location will be replaced by the new download. If False, the download will be skipped if the file already exists, preventing accidental data loss. The default value is typically False.

use_hf_mirror

The use_hf_mirror parameter is a boolean option that, when enabled, redirects the download to a mirror site for Hugging Face models. This can potentially speed up the download process by using alternative servers. The default value is False, meaning the original source is used unless specified otherwise.

rename_to

The rename_to parameter allows you to specify a new name for the downloaded file. This is useful if you want to standardize file names or avoid conflicts with existing files. If left empty, the node will use the original file name from the URL. There are no specific constraints, but it should be a valid file name.

hf_token

The hf_token parameter is used to provide an authorization token for downloading models from Hugging Face that require authentication. This ensures secure access to private or restricted models. The token must be a valid string obtained from your Hugging Face account.

chunk_size

The chunk_size parameter defines the size of data chunks to be downloaded at a time, measured in bytes. A larger chunk size can speed up the download but may require more memory, while a smaller size is more memory-efficient but slower. The default value is typically set to 1MB (1024 * 1024 bytes).

trigger_signal

The trigger_signal parameter is an optional callback function that can be used to trigger events or updates during the download process. This is useful for integrating the node with other systems or for providing real-time feedback to users. It is not required for basic operation.

Model Downloader 🐑| Model Downloader 🐑 Output Parameters:

download_status

The download_status output parameter provides feedback on the result of the download operation. It typically returns a message indicating whether the download was successful or if any issues were encountered. This output is crucial for confirming that the model has been correctly downloaded and is ready for use.

Model Downloader 🐑| Model Downloader 🐑 Usage Tips:

• Ensure that the url parameter is correctly formatted and points to a valid model file to avoid download errors.
• Use the override parameter with caution to prevent unintentional overwriting of important files.
• Consider enabling use_hf_mirror for faster downloads from Hugging Face, especially if you experience slow download speeds.
• Keep your hf_token secure and only use it for authorized downloads to protect your account and data.

Model Downloader 🐑| Model Downloader 🐑 Common Errors and Solutions:

File already exists and override is False: <file_path>

• Explanation: This error occurs when a file with the same name already exists at the target location, and the override parameter is set to False.
• Solution: Set the override parameter to True if you wish to replace the existing file, or change the rename_to parameter to save the new file with a different name.

Invalid URL or unable to connect: <url>

• Explanation: This error indicates that the provided URL is not valid or there is a connectivity issue preventing the download.
• Solution: Verify that the url is correct and accessible. Check your internet connection and ensure that the source is online.

Authorization failed for Hugging Face: <url>

• Explanation: This error occurs when the hf_token is missing or invalid, preventing access to a restricted Hugging Face model.
• Solution: Ensure that you have provided a valid hf_token and that it has the necessary permissions to access the model.