Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 2.45 KB

README.md

File metadata and controls

38 lines (24 loc) · 2.45 KB

Model Template - FluxUpscalerXS

This is Flux.1-dev ControlNet for low resolution images developed by Jasper research team.

Quick Start

Here is a quick start to help you get up and running with this template on Inferless.

Fork the Repository

Get started by forking the repository. You can do this by clicking on the fork button in the top right corner of the repository page.

This will create a copy of the repository in your own GitHub account, allowing you to make changes and customize it according to your needs.

Create a Custom Runtime in Inferless

To access the custom runtime window in Inferless, simply navigate to the sidebar and click on the Create new Runtime button. A pop-up will appear.

Next, provide a suitable name for your custom runtime and proceed by uploading the inferless-runtime.yaml file given above. Finally, ensure you save your changes by clicking on the save button.

Add Your Hugging Face Access Token

Go into the inferless.yaml and replace <YOUR_HUGGINGFACE_ACCESS_TOKEN> with your hugging face access token. Make sure to check the repo is private to protect your hugging face token.

Import the Model in Inferless

Log in to your inferless account, select the workspace you want the model to be imported into and click the Add Model button.

Select the PyTorch as framework and choose Repo(custom code) as your model source and select your provider, and use the forked repo URL as the Model URL.

Enter all the required details to Import your model. Refer this link for more information on model import.

Customizing the Code

Open the app.py file. This contains the main code for inference. It has three main functions, initialize, infer and finalize.

Initialize - This function is executed during the cold start and is used to initialize the model. If you have any custom configurations or settings that need to be applied during the initialization, make sure to add them in this function.

Infer - This function is where the inference happens. The argument to this function inputs, is a dictionary containing all the input parameters. The keys are the same as the name given in inputs. Refer to input for more.

Finalize - This function is used to perform any cleanup activity for example you can unload the model from the gpu by setting self.model = None.

For more information refer to the Inferless docs.