edenartlab/sdxl-lora-trainer:95542d9a – Run with an API on Replicate

Version

You're looking at a specific version of this model. Jump to the model overview.

edenartlab /sdxl-lora-trainer:95542d9a

Playground API

Input

name

string

Shift + Return to add a new line

Name of new LORA concept

lora_training_urls

string

Shift + Return to add a new line

Training images for new LORA concept (can be images or a .zip file of images)

mode

string

Shift + Return to add a new line

face / style or concept (default)

Default: "concept"

seed

integer

Random seed for reproducible training. Leave empty to use a random seed

resolution

integer

Square pixel resolution which your images will be resized to for training

Default: 896

train_batch_size

integer

Batch size (per device) for training

Default: 2

num_train_epochs

integer

Number of epochs to loop through your training dataset

Default: 10000

max_train_steps

integer

Number of individual training steps. Takes precedence over num_train_epochs

Default: 600

checkpointing_steps

integer

Number of steps between saving checkpoints. Set to very very high number to disable checkpointing, because you don't need one.

Default: 10000

is_lora

boolean

Whether to use LoRA training. If set to False, will use Full fine tuning

Default: true

unet_learning_rate

number

Learning rate for the U-Net. We recommend this value to be somewhere between `1e-6` to `1e-5`.

Default: 0.000001

ti_lr

number

Scaling of learning rate for training textual inversion embeddings. Don't alter unless you know what you're doing.

Default: 0.0003

lora_lr

number

Scaling of learning rate for training LoRA embeddings. Don't alter unless you know what you're doing.

Default: 0.0001

ti_weight_decay

number

weight decay for textual inversion embeddings. Don't alter unless you know what you're doing.

Default: 0.00001

lora_weight_decay

number

weight decay for LoRa. Don't alter unless you know what you're doing.

Default: 0.0001

lora_rank

integer

Rank of LoRA embeddings. For faces 4 is good, for complex objects you might try 6 or 8

Default: 4

lr_scheduler

string

Learning rate scheduler to use for training

Default: "constant"

lr_warmup_steps

integer

Number of warmup steps for lr schedulers with warmups.

Default: 50

token_string

string

Shift + Return to add a new line

A unique string that will be trained to refer to the concept in the input images. Can be anything, but TOK works well

Default: "TOK"

caption_prefix

string

Shift + Return to add a new line

Text which will be used as prefix during automatic captioning. Must contain the `token_string`. For example, if caption text is 'a photo of TOK', automatic captioning will expand to 'a photo of TOK under a bridge', 'a photo of TOK holding a cup', etc.

Default: "a photo of TOK, "

mask_target_prompts

string

Shift + Return to add a new line

Prompt that describes part of the image that you will find important. For example, if you are fine-tuning your pet, `photo of a dog` will be a good prompt. Prompt-based masking is used to focus the fine-tuning process on the important/salient parts of the image

crop_based_on_salience

boolean

If you want to crop the image to `target_size` based on the important parts of the image, set this to True. If you want to crop the image based on face detection, set this to False

Default: true

use_face_detection_instead

boolean

If you want to use face detection instead of CLIPSeg for masking. For face applications, we recommend using this option.

Default: false

clipseg_temperature

number

How blurry you want the CLIPSeg mask to be. We recommend this value be something between `0.5` to `1.0`. If you want to have more sharp mask (but thus more errorful), you can decrease this value.

Default: 1

left_right_flip_augmentation

boolean

Add left-right flipped version of each img to the training data, recommended for most cases. If you are learning a face, you prob want to disable this

Default: true

verbose

boolean

verbose output

Default: true

run_name

string

Shift + Return to add a new line

Subdirectory where all files will be saved

Default: "1693687184"

run_local

boolean

for debugging locally

Default: false

Run this model in Node.js with one line of code:

npx create-replicate --model=edenartlab/sdxl-lora-trainer

or set up a project from scratch

Install Replicate’s Node.js client library:

npm install replicate

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Import and set up the client:

import Replicate from "replicate";

const replicate = new Replicate({
  auth: process.env.REPLICATE_API_TOKEN,
});

Run edenartlab/sdxl-lora-trainer using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

const output = await replicate.run(
  "edenartlab/sdxl-lora-trainer:95542d9ab063abffa83832169c9dac259dad789cda0c2b8b897d108bb706faae",
  {
    input: {
      mode: "concept",
      ti_lr: 0.0003,
      is_lora: true,
      lora_lr: 0.0001,
      verbose: true,
      run_name: "1693687184",
      lora_rank: 4,
      run_local: false,
      resolution: 896,
      lr_scheduler: "constant",
      token_string: "TOK",
      caption_prefix: "a photo of TOK, ",
      lr_warmup_steps: 50,
      max_train_steps: 600,
      ti_weight_decay: 0.00001,
      num_train_epochs: 10000,
      train_batch_size: 2,
      lora_weight_decay: 0.0001,
      unet_learning_rate: 0.000001,
      checkpointing_steps: 10000,
      clipseg_temperature: 1,
      crop_based_on_salience: true,
      use_face_detection_instead: false,
      left_right_flip_augmentation: true
    }
  }
);

console.log(output);

To learn more, take a look at the guide on getting started with Node.js.

Install Replicate’s Python client library:

pip install replicate

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Import the client:

import replicate

Run edenartlab/sdxl-lora-trainer using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

output = replicate.run(
    "edenartlab/sdxl-lora-trainer:95542d9ab063abffa83832169c9dac259dad789cda0c2b8b897d108bb706faae",
    input={
        "mode": "concept",
        "ti_lr": 0.0003,
        "is_lora": True,
        "lora_lr": 0.0001,
        "verbose": True,
        "run_name": "1693687184",
        "lora_rank": 4,
        "run_local": False,
        "resolution": 896,
        "lr_scheduler": "constant",
        "token_string": "TOK",
        "caption_prefix": "a photo of TOK, ",
        "lr_warmup_steps": 50,
        "max_train_steps": 600,
        "ti_weight_decay": 0.00001,
        "num_train_epochs": 10000,
        "train_batch_size": 2,
        "lora_weight_decay": 0.0001,
        "unet_learning_rate": 0.000001,
        "checkpointing_steps": 10000,
        "clipseg_temperature": 1,
        "crop_based_on_salience": True,
        "use_face_detection_instead": False,
        "left_right_flip_augmentation": True
    }
)

# The edenartlab/sdxl-lora-trainer model can stream output as it's running.
# The predict method returns an iterator, and you can iterate over that output.
for item in output:
    # https://replicate.com/edenartlab/sdxl-lora-trainer/api#output-schema
    print(item)

To learn more, take a look at the guide on getting started with Python.

Set the REPLICATE_API_TOKEN environment variable:

export REPLICATE_API_TOKEN=<paste-your-token-here>

Find your API token in your account settings.

Run edenartlab/sdxl-lora-trainer using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

curl -s -X POST \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Prefer: wait" \
  -d $'{
    "version": "95542d9ab063abffa83832169c9dac259dad789cda0c2b8b897d108bb706faae",
    "input": {
      "mode": "concept",
      "ti_lr": 0.0003,
      "is_lora": true,
      "lora_lr": 0.0001,
      "verbose": true,
      "run_name": "1693687184",
      "lora_rank": 4,
      "run_local": false,
      "resolution": 896,
      "lr_scheduler": "constant",
      "token_string": "TOK",
      "caption_prefix": "a photo of TOK, ",
      "lr_warmup_steps": 50,
      "max_train_steps": 600,
      "ti_weight_decay": 0.00001,
      "num_train_epochs": 10000,
      "train_batch_size": 2,
      "lora_weight_decay": 0.0001,
      "unet_learning_rate": 0.000001,
      "checkpointing_steps": 10000,
      "clipseg_temperature": 1,
      "crop_based_on_salience": true,
      "use_face_detection_instead": false,
      "left_right_flip_augmentation": true
    }
  }' \
  https://api.replicate.com/v1/predictions

To learn more, take a look at Replicate’s HTTP API reference docs.

You can run this model locally using Cog. First, install Cog:

brew install cog

If you don’t have Homebrew, there are other installation options available.

Run this to download the model and run it in your local environment:

cog predict r8.im/abraham-ai/sdxl-lora-trainer@sha256:95542d9ab063abffa83832169c9dac259dad789cda0c2b8b897d108bb706faae \
  -i 'mode="concept"' \
  -i 'ti_lr=0.0003' \
  -i 'is_lora=true' \
  -i 'lora_lr=0.0001' \
  -i 'verbose=true' \
  -i 'run_name="1693687184"' \
  -i 'lora_rank=4' \
  -i 'run_local=false' \
  -i 'resolution=896' \
  -i 'lr_scheduler="constant"' \
  -i 'token_string="TOK"' \
  -i 'caption_prefix="a photo of TOK, "' \
  -i 'lr_warmup_steps=50' \
  -i 'max_train_steps=600' \
  -i 'ti_weight_decay=0.00001' \
  -i 'num_train_epochs=10000' \
  -i 'train_batch_size=2' \
  -i 'lora_weight_decay=0.0001' \
  -i 'unet_learning_rate=0.000001' \
  -i 'checkpointing_steps=10000' \
  -i 'clipseg_temperature=1' \
  -i 'crop_based_on_salience=true' \
  -i 'use_face_detection_instead=false' \
  -i 'left_right_flip_augmentation=true'

To learn more, take a look at the Cog documentation.

Run this to download the model and run it in your local environment:

docker run -d -p 5000:5000 --gpus=all r8.im/abraham-ai/sdxl-lora-trainer@sha256:95542d9ab063abffa83832169c9dac259dad789cda0c2b8b897d108bb706faae
curl -s -X POST \
  -H "Content-Type: application/json" \
  -d $'{
    "input": {
      "mode": "concept",
      "ti_lr": 0.0003,
      "is_lora": true,
      "lora_lr": 0.0001,
      "verbose": true,
      "run_name": "1693687184",
      "lora_rank": 4,
      "run_local": false,
      "resolution": 896,
      "lr_scheduler": "constant",
      "token_string": "TOK",
      "caption_prefix": "a photo of TOK, ",
      "lr_warmup_steps": 50,
      "max_train_steps": 600,
      "ti_weight_decay": 0.00001,
      "num_train_epochs": 10000,
      "train_batch_size": 2,
      "lora_weight_decay": 0.0001,
      "unet_learning_rate": 0.000001,
      "checkpointing_steps": 10000,
      "clipseg_temperature": 1,
      "crop_based_on_salience": true,
      "use_face_detection_instead": false,
      "left_right_flip_augmentation": true
    }
  }' \
  http://localhost:5000/predictions

To learn more, take a look at the Cog documentation.

Output

No output yet! Press "Submit" to start a prediction.