Deploy Phi-3-mini-128k-instruct using Inferless

​

Introduction

Microsoft has introduced Phi-3-mini-128k-instruct, a compact yet powerful model designed for instruction-following tasks. This model is a part of the Phi-3 family, known for its efficiency and high performance. The Phi-3-Mini-128K-Instruct exhibited robust, state-of-the-art performance among models with fewer than 13 billion parameters.

​

Our Observations

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

​

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.

Phi-3-128k/
├── 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

1. def initialize: In this function, you will initialize your model and define any variable that you want to use during inference.

2. 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.

3. def finalize: This function cleans up all the allocated memory.

from transformers import pipeline, AutoModelForCausalLM, AutoTokenizer

class InferlessPythonModel:
    def initialize(self):
        self.model = AutoModelForCausalLM.from_pretrained(
            "microsoft/Phi-3-mini-128k-instruct",
            device_map="cuda",
            torch_dtype="auto",
            trust_remote_code=True,
        )
        self.tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-128k-instruct")
        self.pipe = pipeline(
            "text-generation",
            model=self.model,
            tokenizer=self.tokenizer,
        )

    def infer(self, input_data):
        prompt = input_data['prompt']
        roles = input_data['roles']

        generation_args = {
            "max_new_tokens": 500,
            "return_full_text": False,
            "temperature": 0.0,
            "do_sample": False,
        }

        messages = []
        messages.append({ "role": roles , "content" : prompt })
        output = self.pipe(messages, **generation_args)
        return {"result": output[0]['generated_text'] }


    def finalize(self):
        self.generator = None
        print("Pipeline finalized.", flush=True)

​

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 two parameter prompt and roles which are required during the API call. Now lets create the input_schema.py.

INPUT_SCHEMA = {
    "roles": {
        'datatype': 'STRING',
        'required': True,
        'shape': [1],
        'example': ["user"]
    },
    "prompt": {
        'datatype': 'STRING',
        'required': True,
        'shape': [1],
        'example': [
            "Inferless is a machine learning model deployment platform.",
        ]
    }
}

​

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
  python_packages:
  - torch==2.3.0
  - accelerate==0.30.1
  - transformers==4.41.1

​

Method A: Deploying the model on Inferless Platform

Inferless supports multiple ways of importing your model. For this tutorial, we will use GitHub.

​

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

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.

​

Initialization of the model

Create the app.py and inferless-runtime-config.yaml, move the files to the working directory. Run the following command to initialize your model:

inferless init

​

Upload the custom runtime

Once you have created the inferless-runtime-config.yaml file, you can run the following command:

inferless runtime upload

Upon entering this command, you will be prompted to provide the configuration file name. Enter the name and ensure to update it in the inferless.yaml file. Now you are ready for the deployment.

​

Deploy the Model

Execute the following command to deploy your model. Once deployed, you can track the build logs on the Inferless platform:

inferless deploy