Deploy Whisper-large-v3-turbo using Inferless

Introduction

Whisper-large-v3-turbo is an efficient automatic speech recognition model by OpenAI, featuring 809 million parameters and significantly faster than its predecessor, Whisper large-v3. It excels in diverse applications like transcription and translation, processing audio effectively while handling background noise and various accents.

Our Observations

We have deployed the model on an A100 GPU(80GB). Here are our observations:

Library	Inference Time	Cold Start Time
Transformers	0.46 sec	8.14 sec

Note: The inference time and cold start time are average values.

Defining Dependencies

We are using the Transformers to serve the model on a single A100 (80GB).

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.

Whisper-large-v3-turbo/
├── 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 and pass it through inputs(dict) 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
import torch
from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
import inferless

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

class InferlessPythonModel:
    @app.load        
    def initialize(self):
        model_id = "openai/whisper-large-v3-turbo"
        snapshot_download(repo_id=model_id,allow_patterns=["*.safetensors"])
        model = AutoModelForSpeechSeq2Seq.from_pretrained(
            model_id,
            torch_dtype=torch.float16,
            low_cpu_mem_usage=True,
            use_safetensors=True,
            device_map="cuda"
        )
        
        processor = AutoProcessor.from_pretrained(model_id)
        
        self.pipe = pipeline(
            "automatic-speech-recognition",
            model=model,
            tokenizer=processor.tokenizer,
            feature_extractor=processor.feature_extractor,
            torch_dtype=torch.float16,
            return_timestamps=True
        )

    @app.infer
    def infer(self, inputs):
        # Extracting inputs with default values
        audio_url = inputs["audio_url"]
        return_timestamps = inputs.get("return_timestamps", "word") # Can be True, False, or "word"
        max_new_tokens = inputs.get("max_new_tokens")
        language = inputs.get("language")
        task = inputs.get("task") # Can be "transcribe" or "translate"
        temperature = inputs.get("temperature")

        # Convert return_timestamps if needed
        return_timestamps = return_timestamps == "True" if return_timestamps in ["True", "False"] else return_timestamps
        # Call the pipeline with necessary parameters
        result = self.pipe(
        audio_url,
        return_timestamps=return_timestamps,
        generate_kwargs={
            "max_new_tokens": max_new_tokens,
            "language": language,
            "task": task,
            "temperature": temperature,
            },
        )
        # Prepare the output based on the return_timestamps condition
        if not return_timestamps:
            return {"output_text": result["text"]}

        # Extract timestamps and chunk text
        from_timestamp, to_timestamp, chunk_text = zip(
            *[(chunk['timestamp'][0], chunk['timestamp'][1], chunk['text']) for chunk in result['chunks']]
        )

        return {
            "output_text": [result["text"]],
            "from_timestamp": list(from_timestamp),
            "to_timestamp": list(to_timestamp),
            "chunk_text": list(chunk_text),
        }


    def finalize(self):
        self.pipe = None

Create the Input Schema

We have to create a input_schema.py in your 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 the parameter which are required during the API call. Now lets create the input_schema.py.

INPUT_SCHEMA = {
    "audio_url": {
        'datatype': 'STRING',
        'required': True,
        'shape': [1],
        'example': ["https://github.com/rbgo404/Files/raw/main/jeanNL.mp3"]
    },
    "return_timestamps": {
        'datatype': 'STRING',
        'required': False,
        'shape': [1],
        'example': ["word"]
    },
    "max_new_tokens": {
        'datatype': 'INT64',
        'required': False,
        'shape': [1],
        'example': [400]
    },
    "language": {
        'datatype': 'STRING',
        'required': False,
        'shape': [1],
        'example': ['english']
    },
    "task": {
        'datatype': 'STRING',
        'required': False,
        'shape': [1],
        'example': ['transcribe']
    },
    "temperature": {
        'datatype': 'FP64',
        'required': False,
        'shape': [1],
        'example': [0.5]
    }
}

Creating the Custom Runtime

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

build:
  cuda_version: 12.1.1
  system_packages:
    - "ffmpeg"
  python_packages:
    - "accelerate==1.0.0"
    - "transformers==4.45.2"
    - "librosa==0.10.2.post1"
    - "soundfile==0.12.1"
    - "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 initialized Cls(gpu="A10").
Decorated the initialize and infer functions with @app.load and @app.infer respectively.
Add a local entry point to your script which allows you to test the model through the inferless remote-run command. Since @app.load automatically handles initialization when the model is instantiated, you can directly use the infer function without explicitly calling initialize.

import os
os.environ["HF_HUB_ENABLE_HF_TRANSFER"]='1'
from huggingface_hub import snapshot_download
import torch
from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
import inferless
from pydantic import BaseModel, Field
from typing import Optional

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

@inferless.request
class RequestObjects(BaseModel):
  audio_url: str = Field(default="https://github.com/rbgo404/Files/raw/main/jeanNL.mp3")
  return_timestamps: Optional[str] = "word"
  language: Optional[str] = "english"
  task: Optional[str] = "transcribe"
  temperature: Optional[float] = 0.5
  max_new_tokens: Optional[int] = 400

@inferless.response
class ResponseObjects(BaseModel):
  output_text: list = Field(default=['Test output'])
  from_timestamp: list = Field(default=['Test output'])
  to_timestamp: list = Field(default=['Test output'])
  chunk_text: list = Field(default=['Test output'])

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

class InferlessPythonModel:
    @app.load        
    def initialize(self):
        model_id = "openai/whisper-large-v3-turbo"
        snapshot_download(repo_id=model_id,allow_patterns=["*.safetensors"])
        model = AutoModelForSpeechSeq2Seq.from_pretrained(
            model_id,
            torch_dtype=torch.float16,
            low_cpu_mem_usage=True,
            use_safetensors=True,
            device_map="cuda"
        )
        
        processor = AutoProcessor.from_pretrained(model_id)
        
        self.pipe = pipeline(
            "automatic-speech-recognition",
            model=model,
            tokenizer=processor.tokenizer,
            feature_extractor=processor.feature_extractor,
            torch_dtype=torch.float16,
            return_timestamps=True
        )
        
    @app.infer
    def infer(self, request: RequestObjects) -> ResponseObjects:
        return_timestamps = request.return_timestamps == "True" if request.return_timestamps in ["True", "False"] else request.return_timestamps
        # Call the pipeline with necessary parameters
        result = self.pipe(
        request.audio_url,
        return_timestamps=return_timestamps,
        generate_kwargs={
            "max_new_tokens": request.max_new_tokens,
            "language": request.language,
            "task": request.task,
            "temperature": request.temperature,
            },
        )
        # Prepare the output based on the return_timestamps condition
        if not return_timestamps:
            return {"output_text": result["text"]}

        # Extract timestamps and chunk text
        from_timestamp, to_timestamp, chunk_text = zip(
            *[(chunk['timestamp'][0], chunk['timestamp'][1], chunk['text']) for chunk in result['chunks']]
        )

        generateObject = ResponseObjects(output_text = [result["text"]],
                                        from_timestamp= list(from_timestamp),
                                        to_timestamp= list(to_timestamp),
                                        chunk_text= list(chunk_text)
                                        )
        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 --audio_url "https://github.com/rbgo404/Files/raw/main/jeanNL.mp3"

If you want to exclude certain files or directories from being uploaded, use the --exclude or -e flag.

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/Whisper-large-v3-turbo.git

Deploy the Model

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

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

Explanation of the Command:

--gpu A10: 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