Deploy FLUX.1-schnell using Inferless

Introduction

FLUX.1-schnell, developed by Black Forest Labs, is the fastest model in the FLUX.1 suite of text-to-image generation models. It offers an impressive balance of speed and quality, outperforming many competitors including some non-distilled models. Designed for local development and personal use, FLUX.1-schnell is openly available under an Apache 2.0 license. It utilizes a hybrid architecture of multimodal and parallel diffusion transformer blocks, scaled to 12B parameters, and supports a wide range of aspect ratios and resolutions.

Our Observations

We have deployed this model using A100 GPU and observed that the model took an average cold start time of 11.60 sec and an average inference time of 0.67 sec for image generation.

Defining Dependencies

We are using the HuggingFace Diffusers library for the deployment.

Constructing the GitHub/GitLab Template

Now quickly construct the GitHub/GitLab template, this process is mandatory and make sure you don’t add any file named model.py

FLUX.1-schnell/
├── app.py
├── inferless-runtime-config.yaml
├── inferless.yaml
└── input_schema.py

You can also add other files to this directory.

Create the class for inference

In the app.py we will define the class and import all the required functions

def initialize: In this function, you will initialize your model and define any variable that you want to use during inference.
def infer: This function gets called for every request that you send. Here you can define all the steps that are required for the inference. You can also pass custom values for inference through the inputs parameter.
def finalize: This function cleans up all the allocated memory.

import os
os.environ["HF_HUB_ENABLE_HF_TRANSFER"]='1'
from huggingface_hub import snapshot_download
from diffusers import FluxPipeline
import torch
from io import BytesIO
import base64
import inferless

app = inferless.Cls(gpu="A100")

class InferlessPythonModel:
    @app.load
    def initialize(self):
        model_id = "black-forest-labs/FLUX.1-schnell"
        snapshot_download(repo_id=model_id,allow_patterns=["*.safetensors"])
        self.pipe = FluxPipeline.from_pretrained(model_id, torch_dtype=torch.bfloat16).to("cuda")
    @app.infer
    def infer(self, inputs):
        prompt = inputs["prompt"]
        height = inputs.get("height", 512)
        width = inputs.get("width", 512)
        guidance_scale = inputs.get("guidance_scale", 7.5)
        num_inference_steps = inputs.get("num_inference_steps", 4)
        max_sequence_length = inputs.get("max_sequence_length", 256)

        image = self.pipe(
            prompt,
            height=height,
            width=width,
            guidance_scale=guidance_scale,
            num_inference_steps=num_inference_steps,
            max_sequence_length=max_sequence_length,
        ).images[0]

        buff = BytesIO()
        image.save(buff, format="JPEG")
        img_str = base64.b64encode(buff.getvalue()).decode()

        return {"generated_image_base64": img_str}

    def finalize(self):
        self.pipe = None

Create the Input Schema

We have to create a input_schema.py in the GitHub/Gitlab repository this will help us create the Input parameters. You can checkout our documentation on Input / Output Schema. For this tutorial, we have defined four parameters prompt,height, width, num_inference_steps, guidance_scale and max_sequence_length which are required during the API call. Now lets create the input_schema.py.

INPUT_SCHEMA = {
    "prompt": {
        'datatype': 'STRING',
        'required': True,
        'shape': [1],
        'example': ["A cat holding a sign that says hello world"]
    },
    "height": {
        'datatype': 'INT16',
        'required': False,
        'shape': [1],
        'example': [512]
    },
    "width": {
        'datatype': 'INT16',
        'required': False,
        'shape': [1],
        'example': [512]
    },
    "num_inference_steps": {
        'datatype': 'INT16',
        'required': False,
        'shape': [1],
        'example': [4]
    },
    "guidance_scale": {
        'datatype': 'FP32',
        'required': False,
        'shape': [1],
        'example': [7.5]
    },
    "max_sequence_length": {
        'datatype': 'INT16',
        'required': False,
        'shape': [1],
        'example': [256]
    }
}

Creating the Custom Runtime

This is a mandatory step where we allow the users to upload their own custom runtime through inferless-runtime-config.yaml.

build:
  cuda_version: "12.1.1"
  python_packages:
    - "accelerate==0.33.0"
    - "torch==2.4.0"
    - "transformers==4.44.0"
    - "diffusers==0.30.0"
    - "sentencepiece==0.2.0"
    - "protobuf==5.27.3"
    - "inferless-cli==2.0.9"
    - "hf-transfer==0.1.9"
    - "huggingface-hub==0.27.1"

Test your model with Remote Run

You can use the inferless remote-run(installation guide here) command to test your model or any custom Python script in a remote GPU environment directly from your local machine. Make sure that you use Python3.10 for seamless experience.

Step 1: Add the Decorators and local entry point

To enable Remote Run, simply do the following:

Import the inferless library and initialize Cls(gpu="A100"). The available GPU options are T4, A10 and A100.
Decorated the initialize and infer functions with @app.load and @app.infer respectively.
Create the Local Entry Point by decorating a function (for example, my_local_entry) with @inferless.local_entry_point. Within this function, instantiate your model class, convert any incoming parameters into a RequestObjects object, and invoke the model’s infer method.

import os
os.environ["HF_HUB_ENABLE_HF_TRANSFER"]='1'
from huggingface_hub import snapshot_download
from diffusers import FluxPipeline
import torch
from io import BytesIO
import base64
import inferless
from pydantic import BaseModel, Field
from typing import Optional

app = inferless.Cls(gpu="A100")

@inferless.request
class RequestObjects(BaseModel):
    prompt: str = Field(default="A cat holding a sign that says hello world")
    height: Optional[int] = 512
    width: Optional[int] = 512
    num_inference_steps: Optional[int] = 4
    guidance_scale: Optional[float] = 7.5
    max_sequence_length: Optional[int] = 256

@inferless.response
class ResponseObjects(BaseModel):
    generated_image_base64: str = Field(default='Test output')

class InferlessPythonModel:
    @app.load
    def initialize(self):
        model_id = "black-forest-labs/FLUX.1-schnell"
        snapshot_download(repo_id=model_id,allow_patterns=["*.safetensors"])
        self.pipe = FluxPipeline.from_pretrained(model_id, torch_dtype=torch.bfloat16).to("cuda")
    @app.infer
    def infer(self, request: RequestObjects) -> ResponseObjects:
        image = self.pipe(
            request.prompt,
            height=request.height,
            width=request.width,
            guidance_scale=request.guidance_scale,
            num_inference_steps=request.num_inference_steps,
            max_sequence_length=request.max_sequence_length,
        ).images[0]

        buff = BytesIO()
        image.save(buff, format="JPEG")
        img_str = base64.b64encode(buff.getvalue()).decode()

        generateObject = ResponseObjects(generated_image_base64 = img_str)        
        return generateObject

    def finalize(self):
        self.pipe = None

@inferless.local_entry_point
def my_local_entry(dynamic_params):
    request_objects = RequestObjects(**dynamic_params)
    model_instance = InferlessPythonModel()

    return model_instance.infer(request_objects)

Step 2: Run with Remote GPU

From your local terminal, navigate to the folder containing your app.py and your inferless-runtime-config.yaml and run:

inferless remote-run app.py -c inferless-runtime-config.yaml --prompt "A cat holding a sign that says hello world" --guidance_scale "5.0"

You can pass the other input parameters in the same way (e.g., --height, --width, etc.) as long as your code expects them in the inputs dictionary.

Method A: Deploying the model on Inferless Platform

Inferless supports multiple ways of importing your model. For this tutorial, we will use GitHub. Navigate to your desired workspace in Inferless and Click on Add a custom model button that you see on the top right. An import wizard will open up.

Step 2: Follow the UI to complete the model Import

Select the GitHub/GitLab Integration option to connect your source code repository with the deployment environment.
Navigate to the specific GitHub repository that contains your model’s code. Here, you will need to identify and enter the name of the model you wish to import.
Choose the appropriate type of machine that suits your model’s requirements. Additionally, specify the minimum and maximum number of replicas to define the scalability range for deploying your model.
Optionally, you have the option to enable automatic build and deployment. This feature triggers a new deployment automatically whenever there is a new code push to your repository.
If your model requires additional software packages, configure the Custom Runtime settings by including necessary pip or apt packages. Also, set up environment variables such as Inference Timeout, Container Concurrency, and Scale Down Timeout to tailor the runtime environment according to your needs.
Wait for the validation process to complete, ensuring that all settings are correct and functional. Once validation is successful, click on the “Import” button to finalize the import of your model.

Step 3: Wait for the model build to complete usually takes ~5-10 minutes

Step 4: Use the APIs to call the model

Once the model is in ‘Active’ status you can click on the ‘API’ page to call the model

Here is the Demo:

Method B: Deploying the model on Inferless CLI

Inferless allows you to deploy your model using Inferless-CLI. Follow the steps to deploy using Inferless CLI.

Clone the repository of the model

Let’s begin by cloning the model repository:

git clone https://github.com/inferless/FLUX.1-schnell.git

Deploy the Model

To deploy the model using Inferless CLI, execute the following command:

inferless deploy --gpu A100 --runtime inferless-runtime-config.yaml

Explanation of the Command:

--gpu A100: Specifies the GPU type for deployment. Available options include A10, A100, and T4.
--runtime inferless-runtime-config.yaml: Defines the runtime configuration file. If not specified, the default Inferless runtime is used.

How-to Guides

​Introduction

​Our Observations

​Defining Dependencies

​Constructing the GitHub/GitLab Template

​Create the class for inference

​Create the Input Schema

​Creating the Custom Runtime

​Test your model with Remote Run

​Step 1: Add the Decorators and local entry point

​Step 2: Run with Remote GPU

​Method A: Deploying the model on Inferless Platform

​Step 1: Login to the inferless dashboard can click on Import model button

​Step 2: Follow the UI to complete the model Import

​Step 3: Wait for the model build to complete usually takes ~5-10 minutes

​Step 4: Use the APIs to call the model

​Here is the Demo:

​Method B: Deploying the model on Inferless CLI

​Clone the repository of the model

​Deploy the Model