Comfy Model Download

Description

This package provides a simple way to download pre-trained models from the internet to use in your Comfy projects.

Installation

To install the package, you can use pip:

Testing version:

pip install -i https://test.pypi.org/simple/ comfy-model-download

Add next two lines to your requirements.txt file for the testing version:

--index-url https://test.pypi.org/simple/
comfy_model_download

Usage

It needed to provide a yaml file with the models to download and the path to save them. The package will download the models in parallel using the number of workers specified.

If the model must be download from GCS it is needed to provide a key file.

from comfy_model_download import ModelDownload

download = ModelDownload(
    config_file="models_config.yaml",
    max_workers=2,
    model_path="path/to/save/models",
    key_file="path/to/key/file",
)
download.start()

models.yaml

The models.yaml file should be in the root of the project and should have the following structure:

models:
  checkpoints:
    - name: JuggernautXL.safetensors
      url: gs://example_gcs_bucket/JuggernautXL.safetensors
      #force_download: true
    - name: AnimateLCM_sd15_t2v_lora.safetensors
      url: gs://example_gcs_bucket/AnimateLCM_sd15_t2v_lora.safetensors
      
  ipadapter:
    - name: ip-adapter-plus_sd15.safetensors
      url: gs://example_gcs_bucket/ip-adapter-plus_sd15.safetensors

  animatediff_models:
    - name: AnimateLCM_sd15_t2v.ckpt
      url: gs://example_gcs_bucket/AnimateLCM_sd15_t2v.ckpt

  ...

If the model is already downloaded and you want to force the download, you can use the force_download key.

The models can be downloaded from GCS or from the internet via HTTP.

License

MIT License

Copyright (c) 2024 Freepik Company, Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.