Skip to content

Resource Lists Guide

Jump to bottom
ffxvs edited this page Mar 6, 2024 · 2 revisions

This guide is for sd15_resource_lists.ipynb and sdxl_resource_lists.ipynb.

Because Jupyterlab doesn't have an input form like Google Colab, to change value of the options we have to change them directly in the code. It looks complicated, but it's not difficult at all.

🔴 DO NOT CHANGE ANY CODE BELOW THE ####### LINE

Table of Contents

  1. Requirements
  2. ControlNet
  3. Models
  4. LoRA, Embedding, Upscaler and VAE

Tips

  • Use the triangle arrow button to the left of the cell title to show/hide the cell contents to make scrolling easier.
  • Use the Table of Contents in the left sidebar for easier navigation.
  • You can open the links provided for each model name, loRA, and others to see more details.
  • Run cell with the play button in the toolbar or hotkey shift+enter.
  • Wait for the cell to finish executing until the Completed message in green box appears in the output.
  • Clear the output with Clear Cell Outputs or Clear Outputs of All Cells in the right click context menu.

Change the value of options

When using this notebook you will often encounter several types of options whose values can be changed.

  • option = boolean[*]
    Boolean contains two values, False and True
    False : boolean[0]
    True : boolean[1]
    Example :
lcmLora = boolean[1]
# Download LCM LoRA
  • option = []
    Fill the bracket with strings enclosed in single quotation marks ', separated by commas ,
    Example :
otherModels = [  
     'https://huggingface.co/Lykon/dreamshaper-xl-lightning/resolve/main/DreamShaperXL_Lightning.safetensors',  
     'https://huggingface.co/RunDiffusion/Juggernaut-XL-v9/resolve/main/Juggernaut-XL_v9_RunDiffusionPhoto_v2.safetensors'
]
# Download DreamShaper and Juggernaut models
  • option = ''
    Write string inside the single quotation marks ' '
    Example :
civitaiToken= 'your_civitai_token'
# User civitAI token
  • modelName = modelNameVersions[0]
    Fill in the value based on the model versions provided in modelNameVersions, ordered from left to right, starting from 0
    Example :
dreamShaperVersions = ['Select version...', 'v8', 'v7']
dreamShaper = dreamShaperVersions[2]  
# Download version v7 of DreamShaper

Check for Updates

Check the latest version of the notebook. If a new version is found, a download button will appear. Check the root directory to see the download.


1. Requirements

Variables and Functions

Contains variables and functions needed to run all cells in the notebook. Required every time you want to use the notebook or more precisely when the kernel starts running. If the kernel is shut down or restarted, then this cell must be executed again.

  • civitaiToken
    Some models hosted by Civitai require you to login to download. Sign up to civitai.com, then go to account settings. Scroll to API Keys then add API key. Save your API key somewhere. Then paste it to civitaiToken inside this cell.
    Example :
civitaiToken = 'your_civitai_api_key'

2. ControlNet

You can choose what controlNet models you want to download by simply changing boolean[0] to boolean[1]. There are also T2I-Adapter models for SD v1.5.

Example :

controlNet = {
    'canny': boolean[0],
    'depth': boolean[1],
    'inpaint': boolean[0],
    'openpose': boolean[1],
    'tile': boolean[0]
}
# Download only depth and openpose models

Install from URLs

If you want to download other models, copy and paste the direct link of the model into bracket of otherControlNet. URLs are enclosed in single quotation marks ' and separated by commas ,.
Example :

otherControlNet = ['https://huggingface.co/lllyasviel/sd_control_collection/resolve/main/t2i-adapter_diffusers_xl_canny.safetensors']

3. Models

You can download several popular models from the notebooks. Divided into 4 categories, Anime/Cartoon/3D, General Purpose, Realistic, Woman. To download a model, select one of the provided model versions. Model versions are provided in modelNameVersions, ordered from left to right, starting from 0. Example :

dreamShaperVersions = ['Select version...', 'v8', 'v8-inpainting']
dreamShaper = dreamShaperVersions[0]

🔴 DO NOT MODIFY THE AVAILABLE VERSIONS INSIDE THE BRACKET

Select version... : 0 or not downloaded
v8 : 1
v8-inpainting : 2

If we want to download the Dreamshaper version v8, change the value of dreamShaper to

dreamShaper = dreamShaperVersions[1]

Install from URLs

If you want to download other models, copy and paste the direct link of the model into bracket of otherModels. URLs are enclosed in single quotation marks ' and separated by commas ,.
Example :

otherModels = ['https://huggingface.co/Lykon/DreamShaper/resolve/main/DreamShaper_8_pruned.safetensors']
# or
otherModels = [
    'https://huggingface.co/Lykon/DreamShaper/resolve/main/DreamShaper_8_pruned.safetensors',
    'https://civitai.com/api/download/models/201259?type=Model&format=SafeTensor&size=pruned&fp=fp16'
]

4. LoRA, Embedding, Upscaler and VAE

There are several built-in resource lists that will be downloaded automatically. There are also several loRA, embedding, upscaler, and VAE available that might be useful for you. To download them, just change their value from boolean[0] to boolean[1].

Install from URLs

To download other resources, copy and paste the direct link into otherLora for Lora, otherEmbeddings for embedding, otherUpscaler for upscaler, and otherVAE for VAE. URLs are enclosed in single quotation marks ' and separated by commas ,.
Example :

otherLora = ['https://huggingface.co/ffxvs/lora-effects/resolve/main/background_details.safetensors']
# or
otherLora = [
    'https://huggingface.co/ffxvs/lora-effects/resolve/main/background_details.safetensors',
    'https://huggingface.co/ffxvs/lora-effects/resolve/main/depth_of_field_slider.safetensors'
]
Clone this wiki locally