Import Models from Hugging Face
Step-by-step instructions for importing models into the Clarifai platform
You can import models from external sources and use them on the Clarifai platform. With this feature, you can seamlessly integrate pre-trained models, developed externally, into the Clarifai platform, allowing you to expand the range of capabilities and possibilities for leveraging artificial intelligence (AI) in various applications.
By utilizing this feature, you gain the flexibility to import models that have been trained on specific tasks or datasets, taking advantage of external expertise or specialized knowledge.
Whether it's a custom model created by a data scientist, a state-of-the-art model developed by a research institution, or a community-driven model from open-source projects, this feature simplifies the process of incorporating these models into the Clarifai ecosystem.
This feature offers a user-friendly interface that streamlines the importing process, ensuring smooth integration with the Clarifai platform. Once imported, the models become seamlessly accessible, empowering you to tap into advanced AI capabilities without the need to build models from scratch.
The model import functionality is exclusively available to Enterprise users.
How to Import a Model
In this example, we’ll demonstrate how to import a model from Hugging Face, which is a popular hub for a wide range of open source models.
Let’s go through the step-by-step instructions for importing a model from Hugging Face and deploying it on your own Clarifai app.
The imported model will be automatically deployed and ready to be evaluated, fine-tuned and customized, combined with other models and agent operators in a workflow, or used to serve inference requests as it is.
Step 1: Find a model on Hugging Face
Log in to the Hugging Face platform and look for the model you want to import. You can search, filter, and sort by popularity to get the best model that meets your needs.
After selecting a model, you’ll be redirected to its individual page, where you can further assess whether you can import it to the Clarifai platform.
Click the Use in Transformers button and ensure that the model is supported by the Transformers machine learning library. If it cannot be used by the Transformers library, then it could be incompatible with our platform.
Click the Edit model card button and ensure that the model’s card doesn't mention
trust_remote_code=Truecondition. This condition is necessary for certain model architectures that are not yet included in the Hugging Face Transformers library. Unfortunately, we can't import such models at the moment.Click the Files and versions tab and check the size of the model. We only allow importing models that are less than 5GB.
Check the license of the model to ensure you can comfortably use the model.
Step 2: Import the model
After identifying a Hugging Face model, you can now import it to the Clarifai platform.
Go to the individual page of an application you own, and select the Models option on the collapsible left sidebar.
On the models listing page, click the Add Model button at the upper-right corner of the page.
On the Add a model window that pops up, select the Import model from Hugging Face option and click the Continue button.
You'll be redirected to the Model Importer page where you can import the Hugging Face model.
Let’s talk about the fields to fill in the form.
Clarifai Model ID
Carefully pick a memorable, human-readable model ID. You can be faithful to the original model ID, while trying to follow Clarifai’s model ID convention: [use case]-[language (for text or audio) ]-[input type)] -[architecture (optional)]-[public dataset(optional)].
Clarifai Model Notes
Provide a short description of what the model is about. Later, you can go to the model's individual page, under the Notes section, and edit its description using Markdown.
HuggingFace Pipeline Name
Pick the model type from the drop-down list. We support most of the Hugging Face model types.
HuggingFace Model Name
Provide the name of the model as it appears on the Hugging Face platform. You can use the Hugging Face’s copy button to copy the model name, such as cardiffnlp/twitter-roberta-base-sentiment.
HuggingFace Tokenizer
Optionally, you can provide the name of the tokenizer you want to import. Only provide it if it is supported by the specified pipeline.
Select the Checkbox
Select the checkbox to acknowledge importing the Hugging Face model.
Import Model
Finally, click the Import Model button to complete importing your first Hugging Face model!
Step 3: Use the model
You’ll be redirected to the individual page of the model.
If you check the model's versions table, you’ll notice that the model is still being uploaded. It takes a few minutes for the model to be uploaded—large models can take longer.
After the model has been uploaded, the status will change to “Model is trained and ready.”
You can now click the Use Model button at the upper-right corner of the page to start using the model.
Also, you can go to the Overview tab and add public preview examples, model description, notes, use case, toolkit (which is "Huggingface"), license, and more.
