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

justmalhar / flux-sketchnotes

Generates hand-drawn sketchnotes with great detail. Prompt Prefix: “A sketchnote in the style of TOK”

Warm

Public
6.1K runs
H100

Iterate in playground

Run with an API

Playground API Examples README Versions

Input

prompt

*string

Shift + Return to add a new line

A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background 

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

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 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:749e44eb2d6a1f19a965cb48aba61ec131a8dc42e4d71759d462686aaf41c429",
  {
    input: {
      model: "dev",
      width: 1080,
      height: 1080,
      prompt: "A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background ",
      go_fast: false,
      lora_scale: 1,
      megapixels: "1",
      num_outputs: 4,
      aspect_ratio: "1:1",
      output_format: "jpg",
      guidance_scale: 3.5,
      output_quality: 100,
      prompt_strength: 0.8,
      extra_lora_scale: 1,
      num_inference_steps: 28
    }
  }
);

// To access the file URL:
console.log(output[0].url()); //=> "http://example.com"

// To write the file to disk:
fs.writeFile("my-image.png", output[0]);

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

output = replicate.run(
    "justmalhar/flux-sketchnotes:749e44eb2d6a1f19a965cb48aba61ec131a8dc42e4d71759d462686aaf41c429",
    input={
        "model": "dev",
        "width": 1080,
        "height": 1080,
        "prompt": "A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background ",
        "go_fast": False,
        "lora_scale": 1,
        "megapixels": "1",
        "num_outputs": 4,
        "aspect_ratio": "1:1",
        "output_format": "jpg",
        "guidance_scale": 3.5,
        "output_quality": 100,
        "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 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": "justmalhar/flux-sketchnotes:749e44eb2d6a1f19a965cb48aba61ec131a8dc42e4d71759d462686aaf41c429",
    "input": {
      "model": "dev",
      "width": 1080,
      "height": 1080,
      "prompt": "A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background ",
      "go_fast": false,
      "lora_scale": 1,
      "megapixels": "1",
      "num_outputs": 4,
      "aspect_ratio": "1:1",
      "output_format": "jpg",
      "guidance_scale": 3.5,
      "output_quality": 100,
      "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.

Output

{
  "completed_at": "2024-08-19T12:45:31.004836Z",
  "created_at": "2024-08-19T12:43:59.768000Z",
  "data_removed": false,
  "error": null,
  "id": "e3cqs53dk1rm20chdanbws1f0g",
  "input": {
    "model": "dev",
    "width": 1080,
    "height": 1080,
    "prompt": "A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background ",
    "lora_scale": 1,
    "num_outputs": 4,
    "aspect_ratio": "1:1",
    "output_format": "jpg",
    "guidance_scale": 3.5,
    "output_quality": 100,
    "num_inference_steps": 28
  },
  "logs": "Using seed: 35184\nPrompt: A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background\ntxt2img mode\nUsing dev model\nLoading LoRA weights\nEnsuring enough disk space...\nFree disk space: 9586469498880\nDownloading weights\n2024-08-19T12:44:50Z | INFO  | [ Initiating ] chunk_size=150M dest=/src/weights-cache/93f5ad2c6b2326fe url=https://replicate.delivery/yhqm/e9sBWcEWKkWrJaXImYHkCeKiFc5hwn2HrWBY1a4gedY9FcomA/trained_model.tar\n2024-08-19T12:44:51Z | INFO  | [ Complete ] dest=/src/weights-cache/93f5ad2c6b2326fe size=\"172 MB\" total_elapsed=1.441s url=https://replicate.delivery/yhqm/e9sBWcEWKkWrJaXImYHkCeKiFc5hwn2HrWBY1a4gedY9FcomA/trained_model.tar\nb''\nDownloaded weights in 1.469226598739624 seconds\nLoRA weights loaded successfully\n  0%|          | 0/28 [00:00<?, ?it/s]\n  4%|▎         | 1/28 [00:01<00:27,  1.02s/it]\n  7%|▋         | 2/28 [00:01<00:23,  1.12it/s]\n 11%|█         | 3/28 [00:02<00:23,  1.05it/s]\n 14%|█▍        | 4/28 [00:03<00:23,  1.02it/s]\n 18%|█▊        | 5/28 [00:04<00:22,  1.00it/s]\n 21%|██▏       | 6/28 [00:05<00:22,  1.01s/it]\n 25%|██▌       | 7/28 [00:06<00:21,  1.01s/it]\n 29%|██▊       | 8/28 [00:07<00:20,  1.02s/it]\n 32%|███▏      | 9/28 [00:08<00:19,  1.02s/it]\n 36%|███▌      | 10/28 [00:10<00:18,  1.02s/it]\n 39%|███▉      | 11/28 [00:11<00:17,  1.02s/it]\n 43%|████▎     | 12/28 [00:12<00:16,  1.03s/it]\n 46%|████▋     | 13/28 [00:13<00:15,  1.03s/it]\n 50%|█████     | 14/28 [00:14<00:14,  1.03s/it]\n 54%|█████▎    | 15/28 [00:15<00:13,  1.03s/it]\n 57%|█████▋    | 16/28 [00:16<00:12,  1.03s/it]\n 61%|██████    | 17/28 [00:17<00:11,  1.03s/it]\n 64%|██████▍   | 18/28 [00:18<00:10,  1.03s/it]\n 68%|██████▊   | 19/28 [00:19<00:09,  1.03s/it]\n 71%|███████▏  | 20/28 [00:20<00:08,  1.03s/it]\n 75%|███████▌  | 21/28 [00:21<00:07,  1.03s/it]\n 79%|███████▊  | 22/28 [00:22<00:06,  1.03s/it]\n 82%|████████▏ | 23/28 [00:23<00:05,  1.03s/it]\n 86%|████████▌ | 24/28 [00:24<00:04,  1.03s/it]\n 89%|████████▉ | 25/28 [00:25<00:03,  1.03s/it]\n 93%|█████████▎| 26/28 [00:26<00:02,  1.03s/it]\n 96%|█████████▋| 27/28 [00:27<00:01,  1.03s/it]\n100%|██████████| 28/28 [00:28<00:00,  1.03s/it]\n100%|██████████| 28/28 [00:28<00:00,  1.02s/it]",
  "metrics": {
    "predict_time": 41.064993984,
    "total_time": 91.236836
  },
  "output": [
    "https://replicate.delivery/yhqm/kBiBGD5HftWLVqKrtouDWmgQ2pkIRe4brd3mxLAcgLNqBPUTA/out-0.jpg",
    "https://replicate.delivery/yhqm/T61WBe59uPUzAKdAppZcDVGeK0vOwPAeYEwkZeGO2tfXN4haC/out-1.jpg",
    "https://replicate.delivery/yhqm/DITe0ARRnwwqBq2JFTc39TsQbGpgyrIutIEwDMWYnZK1gHqJA/out-2.jpg",
    "https://replicate.delivery/yhqm/XW4agYGmqRo7MRVx7YTBtRkmge2Ey6jQaeZsrmeAOQOUDeQNB/out-3.jpg"
  ],
  "started_at": "2024-08-19T12:44:49.939842Z",
  "status": "succeeded",
  "urls": {
    "get": "https://api.replicate.com/v1/predictions/e3cqs53dk1rm20chdanbws1f0g",
    "cancel": "https://api.replicate.com/v1/predictions/e3cqs53dk1rm20chdanbws1f0g/cancel"
  },
  "version": "749e44eb2d6a1f19a965cb48aba61ec131a8dc42e4d71759d462686aaf41c429"
}

Generated in

41.1 seconds

Tweak it Share Report

Using seed: 35184
Prompt: A sketchnote in the style of TOK with man explaining supervised vs unsupervised machine learning algorithms, arrows, green black tone, white background
txt2img mode
Using dev model
Loading LoRA weights
Ensuring enough disk space...
Free disk space: 9586469498880
Downloading weights
2024-08-19T12:44:50Z | INFO  | [ Initiating ] chunk_size=150M dest=/src/weights-cache/93f5ad2c6b2326fe url=https://replicate.delivery/yhqm/e9sBWcEWKkWrJaXImYHkCeKiFc5hwn2HrWBY1a4gedY9FcomA/trained_model.tar
2024-08-19T12:44:51Z | INFO  | [ Complete ] dest=/src/weights-cache/93f5ad2c6b2326fe size="172 MB" total_elapsed=1.441s url=https://replicate.delivery/yhqm/e9sBWcEWKkWrJaXImYHkCeKiFc5hwn2HrWBY1a4gedY9FcomA/trained_model.tar
b''
Downloaded weights in 1.469226598739624 seconds
LoRA weights loaded successfully
  0%|          | 0/28 [00:00<?, ?it/s]
  4%|▎         | 1/28 [00:01<00:27,  1.02s/it]
  7%|▋         | 2/28 [00:01<00:23,  1.12it/s]
 11%|█         | 3/28 [00:02<00:23,  1.05it/s]
 14%|█▍        | 4/28 [00:03<00:23,  1.02it/s]
 18%|█▊        | 5/28 [00:04<00:22,  1.00it/s]
 21%|██▏       | 6/28 [00:05<00:22,  1.01s/it]
 25%|██▌       | 7/28 [00:06<00:21,  1.01s/it]
 29%|██▊       | 8/28 [00:07<00:20,  1.02s/it]
 32%|███▏      | 9/28 [00:08<00:19,  1.02s/it]
 36%|███▌      | 10/28 [00:10<00:18,  1.02s/it]
 39%|███▉      | 11/28 [00:11<00:17,  1.02s/it]
 43%|████▎     | 12/28 [00:12<00:16,  1.03s/it]
 46%|████▋     | 13/28 [00:13<00:15,  1.03s/it]
 50%|█████     | 14/28 [00:14<00:14,  1.03s/it]
 54%|█████▎    | 15/28 [00:15<00:13,  1.03s/it]
 57%|█████▋    | 16/28 [00:16<00:12,  1.03s/it]
 61%|██████    | 17/28 [00:17<00:11,  1.03s/it]
 64%|██████▍   | 18/28 [00:18<00:10,  1.03s/it]
 68%|██████▊   | 19/28 [00:19<00:09,  1.03s/it]
 71%|███████▏  | 20/28 [00:20<00:08,  1.03s/it]
 75%|███████▌  | 21/28 [00:21<00:07,  1.03s/it]
 79%|███████▊  | 22/28 [00:22<00:06,  1.03s/it]
 82%|████████▏ | 23/28 [00:23<00:05,  1.03s/it]
 86%|████████▌ | 24/28 [00:24<00:04,  1.03s/it]
 89%|████████▉ | 25/28 [00:25<00:03,  1.03s/it]
 93%|█████████▎| 26/28 [00:26<00:02,  1.03s/it]
 96%|█████████▋| 27/28 [00:27<00:01,  1.03s/it]
100%|██████████| 28/28 [00:28<00:00,  1.03s/it]
100%|██████████| 28/28 [00:28<00:00,  1.02s/it]

Examples

View more examples

Run time and cost

This model costs approximately $0.040 to run on Replicate, or 25 runs per $1, but this varies depending on your inputs. It is also open source and you can run it on your own computer with Docker.

This model runs on Nvidia H100 GPU hardware. Predictions typically complete within 27 seconds.

Readme

Prompt Prefix: “A sketchnote in the style of TOK”