Deploy Musicgen Stereo Melody Large Model using Inferless
Meta releases MusicGen, a text-to-music model that converts text descriptions or audio prompts into high-quality music samples.
Our Observations
We have deployed this model using A100 GPU and observed that the model took an average cold start time of 16.17sec
and an average inference time of 13.78sec
for music sample length of 8sec
.
Defining Dependencies
We are using the Audiocraft library from Meta for the model 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
Musicgen-stereo-melody-large/
├── 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 anyvariable
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 theinputs
parameter.def finalize
: This function cleans up all the allocated memory.
import torchaudio
from audiocraft.models import MusicGen
from audiocraft.data.audio import audio_write
import base64
class InferlessPythonModel:
def initialize(self):
self.model = MusicGen.get_pretrained('facebook/musicgen-stereo-melody-large')
self.model.set_generation_params(duration=8)
def infer(self, inputs):
descriptions = [inputs["prompt"]]
wav = self.model.generate(descriptions)
for idx, one_wav in enumerate(wav):
audio_write("temp", one_wav.cpu(), self.model.sample_rate, strategy="loudness", loudness_compressor=True)
with open("temp.wav", "rb") as audio_file:
audio_bytes = audio_file.read()
audio_base64 = base64.b64encode(audio_bytes).decode('utf-8')
return {"generated_audio_base64": audio_base64}
def finalize(self,args):
self.model = 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 a parameter prompt
which is required during the API call. Now lets create the input_schema.py
.
INPUT_SCHEMA = {
"prompt": {
'datatype': 'STRING',
'required': True,
'shape': [1],
'example': ["Rock with saturated guitars, a heavy bass line and crazy drum break and fills."]
}
}
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"
system_packages:
- "libssl-dev"
- "libx11-6"
- "ffmpeg"
python_packages:
- "torch==2.1.0"
- "audiocraft==1.2.0"
Deploying the model on Inferless
Inferless supports multiple ways of importing your model. For this tutorial, we will use GitHub.
Import the Model through GitHub
Click on theRepo(Custom code)
and then click on the Add provider
to connect to your GitHub account. Once your account integration is completed, click on your Github account and continue.
Provide the Model details
Enter the name of the model and pass the GitHub repository URL.
Configure the machine
In this 4th step, the user has to configure the inference setup. On the Inferless platform, we support all the GPUs. For this tutorial, we recommend using A100 GPU. Select A100 from the drop-down menu in the GPU Type.
You also have the flexibility to select from different machine types. Opting for a dedicated
machine type will grant you access to an entire GPU while choosing the shared
option allocates 50% of the VRAM. In this tutorial, we will opt for the dedicated machine type.
Choose the Minimum and Maximum replicas that you would need for your model:
-
Min replica: The number of inference workers to keep on at all times.
-
Max replica: The maximum number of inference workers to allow at any point in time.
If you wish to enable Automatic rebuild for your model setup, toggle the switch. Note that setting up a web-hook is necessary for this feature. Click here for more details.
In the Advance configuration
, we have the option to select the custom runtime. First, click on the Add runtime
to upload the inferless-runtime-config.yaml file, give any name and save it. Choose the runtime from the drop-down menu and then click on continue.
Review and Deploy
In this final stage, carefully review all modifications. Once you’ve examined all changes, proceed to deploy the model by clicking the Submit
button.
Voilà, your model is now deployed!
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