justmalhar/flux-sketchnotes-v2 – Run with an API on Replicate

justmalhar / flux-sketchnotes-v2

Warm

Public
3 runs
H100

Run with an API

Playground API Examples README Versions

Input

prompt

*string

Shift + Return to add a new line

Prompt for generated image. If you include the `trigger_word` used in the training process you are more likely to activate the trained object, style, or concept in the resulting image.

image

file

Input image for image to image or inpainting mode. If provided, aspect_ratio, width, and height inputs are ignored.

mask

file

Image mask for image inpainting mode. If provided, aspect_ratio, width, and height inputs are ignored.

aspect_ratio

string

Aspect ratio for the generated image. If custom is selected, uses height and width below & will run in bf16 mode

Default: "1:1"

height

integer

(minimum: 256, maximum: 1440)

Height of generated image. Only works if `aspect_ratio` is set to custom. Will be rounded to nearest multiple of 16. Incompatible with fast generation

width

integer

(minimum: 256, maximum: 1440)

Width of generated image. Only works if `aspect_ratio` is set to custom. Will be rounded to nearest multiple of 16. Incompatible with fast generation

prompt_strength

number

(minimum: 0, maximum: 1)

Prompt strength when using img2img. 1.0 corresponds to full destruction of information in image

Default: 0.8

model

string

Which model to run inference with. The dev model performs best with around 28 inference steps but the schnell model only needs 4 steps.

Default: "dev"

num_outputs

integer

(minimum: 1, maximum: 4)

Number of outputs to generate

Default: 1

num_inference_steps

integer

(minimum: 1, maximum: 50)

Number of denoising steps. More steps can give more detailed images, but take longer.

Default: 28

guidance_scale

number

(minimum: 0, maximum: 10)

Guidance scale for the diffusion process. Lower values can give more realistic images. Good values to try are 2, 2.5, 3 and 3.5

Default: 3

seed

integer

Random seed. Set for reproducible generation

output_format

string

Format of the output images

Default: "webp"

output_quality

integer

(minimum: 0, maximum: 100)

Quality when saving the output images, from 0 to 100. 100 is best quality, 0 is lowest quality. Not relevant for .png outputs

Default: 80

disable_safety_checker

boolean

Disable safety checker for generated images.

Default: false

go_fast

boolean

Run faster predictions with model optimized for speed (currently fp8 quantized); disable to run in original bf16

Default: false

megapixels

string

Approximate number of megapixels for generated image

Default: "1"

lora_scale

number

(minimum: -1, maximum: 3)

Determines how strongly the main LoRA should be applied. Sane results between 0 and 1 for base inference. For go_fast we apply a 1.5x multiplier to this value; we've generally seen good performance when scaling the base value by that amount. You may still need to experiment to find the best value for your particular lora.

Default: 1

extra_lora

string

Shift + Return to add a new line

Load LoRA weights. Supports Replicate models in the format <owner>/<username> or <owner>/<username>/<version>, HuggingFace URLs in the format huggingface.co/<owner>/<model-name>, CivitAI URLs in the format civitai.com/models/<id>[/<model-name>], or arbitrary .safetensors URLs from the Internet. For example, 'fofr/flux-pixar-cars'

extra_lora_scale

number

(minimum: -1, maximum: 3)

Determines how strongly the extra LoRA should be applied. Sane results between 0 and 1 for base inference. For go_fast we apply a 1.5x multiplier to this value; we've generally seen good performance when scaling the base value by that amount. You may still need to experiment to find the best value for your particular lora.

Default: 1

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

npx create-replicate --model=justmalhar/flux-sketchnotes-v2

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 justmalhar/flux-sketchnotes-v2 using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

const output = await replicate.run(
  "justmalhar/flux-sketchnotes-v2:9e5ac1c8e43065915d7c0e747ae8ed7da58680953a8485d98fe0d97d31ecf6e6",
  {
    input: {
      model: "dev",
      go_fast: false,
      lora_scale: 1,
      megapixels: "1",
      num_outputs: 1,
      aspect_ratio: "1:1",
      output_format: "webp",
      guidance_scale: 3,
      output_quality: 80,
      prompt_strength: 0.8,
      extra_lora_scale: 1,
      num_inference_steps: 28
    }
  }
);
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 justmalhar/flux-sketchnotes-v2 using Replicate’s API. Check out the model's schema for an overview of inputs and outputs.

output = replicate.run(
    "justmalhar/flux-sketchnotes-v2:9e5ac1c8e43065915d7c0e747ae8ed7da58680953a8485d98fe0d97d31ecf6e6",
    input={
        "model": "dev",
        "go_fast": False,
        "lora_scale": 1,
        "megapixels": "1",
        "num_outputs": 1,
        "aspect_ratio": "1:1",
        "output_format": "webp",
        "guidance_scale": 3,
        "output_quality": 80,
        "prompt_strength": 0.8,
        "extra_lora_scale": 1,
        "num_inference_steps": 28
    }
)
print(output)

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 justmalhar/flux-sketchnotes-v2 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": "9e5ac1c8e43065915d7c0e747ae8ed7da58680953a8485d98fe0d97d31ecf6e6",
    "input": {
      "model": "dev",
      "go_fast": false,
      "lora_scale": 1,
      "megapixels": "1",
      "num_outputs": 1,
      "aspect_ratio": "1:1",
      "output_format": "webp",
      "guidance_scale": 3,
      "output_quality": 80,
      "prompt_strength": 0.8,
      "extra_lora_scale": 1,
      "num_inference_steps": 28
    }
  }' \
  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/justmalhar/flux-sketchnotes-v2@sha256:9e5ac1c8e43065915d7c0e747ae8ed7da58680953a8485d98fe0d97d31ecf6e6 \
  -i 'model="dev"' \
  -i 'go_fast=false' \
  -i 'lora_scale=1' \
  -i 'megapixels="1"' \
  -i 'num_outputs=1' \
  -i 'aspect_ratio="1:1"' \
  -i 'output_format="webp"' \
  -i 'guidance_scale=3' \
  -i 'output_quality=80' \
  -i 'prompt_strength=0.8' \
  -i 'extra_lora_scale=1' \
  -i 'num_inference_steps=28'

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/justmalhar/flux-sketchnotes-v2@sha256:9e5ac1c8e43065915d7c0e747ae8ed7da58680953a8485d98fe0d97d31ecf6e6
curl -s -X POST \
  -H "Content-Type: application/json" \
  -d $'{
    "input": {
      "model": "dev",
      "go_fast": false,
      "lora_scale": 1,
      "megapixels": "1",
      "num_outputs": 1,
      "aspect_ratio": "1:1",
      "output_format": "webp",
      "guidance_scale": 3,
      "output_quality": 80,
      "prompt_strength": 0.8,
      "extra_lora_scale": 1,
      "num_inference_steps": 28
    }
  }' \
  http://localhost:5000/predictions

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

Output

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

Run time and cost

This model runs on Nvidia H100 GPU hardware. We don't yet have enough runs of this model to provide performance information.

Readme

This model doesn't have a readme.