Inference Providers documentation

Image Classification

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Image Classification

Image classification is the task of assigning a label or class to an entire image. Images are expected to have only one class for each image.

For more details about the image-classification task, check out its dedicated page! You will find examples and related materials.

Recommended models

Explore all available models and find the one that suits you best here.

Using the API

import os
from huggingface_hub import InferenceClient

client = InferenceClient(
    provider="hf-inference",
    api_key=os.environ["HF_TOKEN"],
)

output = client.image_classification("cats.jpg", model="Falconsai/nsfw_image_detection")

API specification

Request

Headers
authorizationstringAuthentication header in the form 'Bearer: hf_****' when hf_**** is a personal user access token with “Inference Providers” permission. You can generate one from your settings page.
Payload
inputs*stringThe input image data as a base64-encoded string. If no parameters are provided, you can also provide the image data as a raw bytes payload.
parametersobject
        function_to_applyenumPossible values: sigmoid, softmax, none.
        top_kintegerWhen specified, limits the output to the top K most probable classes.

Response

Body
(array)object[]Output is an array of objects.
        labelstringThe predicted class label.
        scorenumberThe corresponding probability.
Update on GitHub