Skip to content

feat: download_models.py script for automating model downloads#1817

Open
gagewillette wants to merge 1 commit into
hacksider:mainfrom
gagewillette:feature-download-models-script
Open

feat: download_models.py script for automating model downloads#1817
gagewillette wants to merge 1 commit into
hacksider:mainfrom
gagewillette:feature-download-models-script

Conversation

@gagewillette

@gagewillette gagewillette commented May 11, 2026

Copy link
Copy Markdown

This pull request adds a new script, download_models.py, to automate downloading required model files into the models/ directory. The script checks if the files already exist, downloads them if needed, and provides progress feedback and error handling.

Model management automation:

  • Added download_models.py script to automate downloading specified .onnx model files (GFPGANv1.4.onnx and inswapper_128_fp16.onnx) into the models/ directory, including progress reporting and error handling.

Summary by Sourcery

New Features:

  • Introduce download_models.py script to fetch specific ONNX model artifacts if missing, with progress reporting and basic error handling.

@sourcery-ai

sourcery-ai Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds a standalone download_models.py script that ensures required ONNX models are present in a local models/ directory by creating the directory if needed, skipping existing files, and downloading missing ones with progress reporting and error handling.

Flow diagram for download_models.py model download process

flowchart TD
    A[start download_models.py] --> B[main]
    B --> C[os.makedirs MODELS_DIR]
    C --> D[for each model in MODELS]
    D --> E{dest file exists?}
    E -- yes --> F[print Skipping]
    F --> D
    E -- no --> G[download]
    G --> H[urllib.request.urlretrieve]
    H --> I[print Saved to dest]
    G --> J{Exception during download?}
    J -- yes --> K[print ERROR]
    K --> L{dest exists?}
    L -- yes --> M[os.remove dest]
    M --> N[sys.exit 1]
    L -- no --> N
    J -- no --> D
    D --> O[print All models ready]
    O --> P[end]
Loading

File-Level Changes

Change Details Files
Introduce a CLI-style script to download required ONNX models into a models directory with progress and robust error handling.
  • Define MODELS_DIR relative to the script location and a MODELS list describing filenames and URLs to download
  • Implement a download() helper that uses urllib.request.urlretrieve with a custom reporthook to display percentage and MB progress
  • In main(), create the models directory, skip downloads for already-present files while reporting their sizes, download missing models, and on errors print to stderr, clean up partial files, and exit with a non-zero status
download_models.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider adding basic CLI arguments (e.g., to select specific models, override the models directory, or force re-download) so the script can be reused in more flexible ways rather than being fully hard-coded.
  • You may want to add a lightweight validation step (such as checking for non-zero file size or an expected minimum size) before skipping existing files, so corrupt or partial downloads don’t get silently reused.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider adding basic CLI arguments (e.g., to select specific models, override the models directory, or force re-download) so the script can be reused in more flexible ways rather than being fully hard-coded.
- You may want to add a lightweight validation step (such as checking for non-zero file size or an expected minimum size) before skipping existing files, so corrupt or partial downloads don’t get silently reused.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant