zoomaker 0.5.0

Zoomaker - Friendly house keeping for your AI model zoo and related resources.

Zoomaker - Friendly house keeping for your AI model zoo and related resources.

Zoomaker is a command-line tool that helps install AI models, git repositories and run scripts.

• single source of truth: all resources are neatly definied in the zoo.yaml file
• freeze versions: know exactly which revision of a resources is installed at any time
• only download once: optimize bandwidth and cache your models locally
• optimize disk usage: downloaded models are symlinked to the installation folder (small files <5MB are duplicate)

😻 TL;DR

1. Install Zoomaker pip install zoomaker
2. Define your resources in the zoo.yaml file
3. Run zoomaker install to install them

📦 Installation

pip install zoomaker

🦁 zoo.yaml Examples

Example of the zoo.yaml of a Stable Diffusion project with the Automatic1111 image generator:

name: my-automatic1111-model-zoo
version: 1.0
description: Lorem ipsum
author: your name

resources:
  image_generator:
    - name: automatic1111
      src: https://github.com/AUTOMATIC1111/stable-diffusion-webui.git
      type: git
      revision: 22bcc7be428c94e9408f589966c2040187245d81
      install_to: ./

  models:
    - name: v2-1_768-ema-pruned
      src: stabilityai/stable-diffusion-2-1/v2-1_768-ema-pruned.safetensors
      type: huggingface
      install_to: ./stable-diffusion-webui/models/Stable-diffusion/

`zoo.yaml` example long

name: my-automatic1111-model-zoo
version: 1.0
description: Lorem ipsum
author: your name

aliases:
  image_generator: &image_generator ./
  models: &models ./stable-diffusion-webui/models/Stable-diffusion/
  controlnet: &controlnet ./stable-diffusion-webui/models/ControlNet/
  embeddings: &embeddings ./stable-diffusion-webui/embeddings/
  extensions: &extensions ./stable-diffusion-webui/extensions/

resources:
  image_generator:
    - name: automatic1111
      src: https://github.com/AUTOMATIC1111/stable-diffusion-webui.git
      type: git
      revision: 22bcc7be428c94e9408f589966c2040187245d81
      install_to: *image_generator

  models:
    - name: v1-5-pruned-emaonly
      src: runwayml/stable-diffusion-v1-5/v1-5-pruned-emaonly.safetensors
      type: huggingface
      install_to: *models

  controlnet:
    - name: control_sd15_canny
      src: lllyasviel/ControlNet/models/control_sd15_canny.pth
      type: huggingface
      install_to: *controlnet

  embeddings:
    - name: midjourney-style
      src: sd-concepts-library/midjourney-style/learned_embeds.bin
      type: huggingface
      install_to: *embeddings
      rename_to: midjourney-style.bin
    - name: moebius
      src: sd-concepts-library/moebius/learned_embeds.bin
      type: huggingface
      install_to: *embeddings
      rename_to: moebius.bin

  extensions:
    - name: sd-webui-tunnels
      src: https://github.com/Bing-su/sd-webui-tunnels.git
      type: git
      install_to: *extensions

scripts:
  start: |
    cd /home/$(whoami)/stable-diffusion-webui/
    ./webui.sh

`zoo.yaml` with web download

models:
  resources:
    - name: analog-diffusion-v1
      src: https://civitai.com/api/download/models/1344
      type: download
      install_to: ./stable-diffusion-webui/models/Stable-diffusion/
      rename_to: analog-diffusion-v1.safetensors

Please note: The resource type: download can be seen as the last resort. Currently there is no caching or symlinking of web downloads. Recommended to avoid it.

🧮 zoo.yaml Structure

Top level:

• name (mandatory)
• version, description, author, aliases (optional)
• resources (mandatory) : <group-name> : [] (array of resources)
• scripts (optional) : <script-name>

Resource:

• name, src, type, install_to (mandatory)
• rename_to (optional)
• revision (optional), if none is defined the latest version from the main branch is downloaded
• type can either be git, huggingface or download

🧞 Zoomaker Commands

All commands are run from the root of the project, where also your zoo.yaml file is located.

Command	Action
zoomaker install	Installs resources as defined in zoo.yaml
zoomaker run <script_name>	Run CLI scripts as defined in zoo.yaml
zoomaker --help	Get help using the Zoomaker CLI
zoomaker --version	Show current Zoomaker version
zoomaker --no-symlinks	Do not use symlinks for installing resources

⚠️ Limitations on Windows

Symlinks are not widely supported on Windows, which limits the caching mechanism used by Zoomaker. To work around this limitation, you can disable symlinks by using the --no-symlinks flag with the install command:

zoomaker install --no-symlinks

This will still use the cache directory for checking if files are already cached, but if not, they will be downloaded and duplicated directly to the installation directory, saving bandwidth but increasing disk usage. Alternatively, you can use the Windows Subsystem for Linux "WSL" (don't forget to enable developer mode) or run Zoomaker as an administrator to enable symlink support on Windows.

🤗 Hugging Face Access Token

You might be asked for a Hugging Face Access Token during zoomaker install. Some resources on Hugging Face require accepting the terms of use of the model. You can set your access token by running this command in a terminal. The command huggingface-cli is automatically shipped alongside zoomaker.

huggingface-cli login

🙏 Acknowledgements

• Most of the internal heavy lifting is done be the huggingface_hub library by Hugging Face. Thanks!