Hugging Face's logo

Hub Python Library documentation

Inference types

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v1.22.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Inference types

This page lists the types (e.g. dataclasses) available for each task supported on the Hugging Face Hub. Each task is specified using a JSON schema, and the types are generated from these schemas - with some customization due to Python requirements. Visit @huggingface.js/tasks to find the JSON schemas for each task.

This part of the lib is still under development and will be improved in future releases.

audio_classification

class huggingface_hub.AudioClassificationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.audio_classification.AudioClassificationParameters | None = None )

Inputs for Audio Classification inference

class huggingface_hub.AudioClassificationOutputElement

< >

( label: strscore: float )

Outputs for Audio Classification inference

class huggingface_hub.AudioClassificationParameters

< >

( function_to_apply: typing.Optional[ForwardRef('AudioClassificationOutputTransform')] = Nonetop_k: int | None = None )

Additional inference parameters for Audio Classification

audio_to_audio

class huggingface_hub.AudioToAudioInput

< >

( inputs: typing.Any )

Inputs for Audio to Audio inference

class huggingface_hub.AudioToAudioOutputElement

< >

( blob: typing.Anycontent_type: strlabel: str )

Outputs of inference for the Audio To Audio task A generated audio file with its label.

automatic_speech_recognition

class huggingface_hub.AutomaticSpeechRecognitionGenerationParameters

< >

( do_sample: bool | None = Noneearly_stopping: typing.Union[bool, ForwardRef('AutomaticSpeechRecognitionEarlyStoppingEnum'), NoneType] = Noneepsilon_cutoff: float | None = Noneeta_cutoff: float | None = Nonemax_length: int | None = Nonemax_new_tokens: int | None = Nonemin_length: int | None = Nonemin_new_tokens: int | None = Nonenum_beam_groups: int | None = Nonenum_beams: int | None = Nonepenalty_alpha: float | None = Nonetemperature: float | None = Nonetop_k: int | None = Nonetop_p: float | None = Nonetypical_p: float | None = Noneuse_cache: bool | None = None )

Parametrization of the text generation process

class huggingface_hub.AutomaticSpeechRecognitionInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionParameters | None = None )

Inputs for Automatic Speech Recognition inference

class huggingface_hub.AutomaticSpeechRecognitionOutput

< >

( text: strchunks: list[huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionOutputChunk] | None = None )

Outputs of inference for the Automatic Speech Recognition task

class huggingface_hub.AutomaticSpeechRecognitionOutputChunk

< >

( text: strtimestamp: list )

class huggingface_hub.AutomaticSpeechRecognitionParameters

< >

( generation_parameters: huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionGenerationParameters | None = Nonereturn_timestamps: bool | None = None )

Additional inference parameters for Automatic Speech Recognition

chat_completion

class huggingface_hub.ChatCompletionInput

< >

( messages: listfrequency_penalty: float | None = Nonelogit_bias: list[float] | None = Nonelogprobs: bool | None = Nonemax_tokens: int | None = Nonemodel: str | None = Nonen: int | None = Nonepresence_penalty: float | None = Noneresponse_format: typing.Union[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputResponseFormatText, huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputResponseFormatJSONSchema, huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputResponseFormatJSONObject, NoneType] = Noneseed: int | None = Nonestop: list[str] | None = Nonestream: bool | None = Nonestream_options: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputStreamOptions | None = Nonetemperature: float | None = Nonetool_choice: typing.Union[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputToolChoiceClass, ForwardRef('ChatCompletionInputToolChoiceEnum'), NoneType] = Nonetool_prompt: str | None = Nonetools: list[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputTool] | None = Nonetop_logprobs: int | None = Nonetop_p: float | None = None )

Chat Completion Input. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.ChatCompletionInputFunctionDefinition

< >

( name: strparameters: typing.Anydescription: str | None = None )

class huggingface_hub.ChatCompletionInputFunctionName

< >

( name: str )

class huggingface_hub.ChatCompletionInputJSONSchema

< >

( name: strdescription: str | None = Noneschema: dict[str, object] | None = Nonestrict: bool | None = None )

class huggingface_hub.ChatCompletionInputMessage

< >

( role: strcontent: list[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputMessageChunk] | str | None = Nonename: str | None = Nonetool_calls: list[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputToolCall] | None = None )

class huggingface_hub.ChatCompletionInputMessageChunk

< >

( type: ChatCompletionInputMessageChunkTypeimage_url: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputURL | None = Nonetext: str | None = None )

class huggingface_hub.ChatCompletionInputResponseFormatJSONObject

< >

( type: typing.Literal['json_object'] )

class huggingface_hub.ChatCompletionInputResponseFormatJSONSchema

< >

( type: typing.Literal['json_schema']json_schema: ChatCompletionInputJSONSchema )

class huggingface_hub.ChatCompletionInputResponseFormatText

< >

( type: typing.Literal['text'] )

class huggingface_hub.ChatCompletionInputStreamOptions

< >

( include_usage: bool | None = None )

class huggingface_hub.ChatCompletionInputTool

< >

( function: ChatCompletionInputFunctionDefinitiontype: str )

class huggingface_hub.ChatCompletionInputToolCall

< >

( function: ChatCompletionInputFunctionDefinitionid: strtype: str )

class huggingface_hub.ChatCompletionInputToolChoiceClass

< >

( function: ChatCompletionInputFunctionName )

class huggingface_hub.ChatCompletionInputURL

< >

( url: str )

class huggingface_hub.ChatCompletionOutput

< >

( choices: listcreated: intid: strmodel: strsystem_fingerprint: strusage: ChatCompletionOutputUsage )

Chat Completion Output. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.ChatCompletionOutputComplete

< >

( finish_reason: strindex: intmessage: ChatCompletionOutputMessagelogprobs: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputLogprobs | None = None )

class huggingface_hub.ChatCompletionOutputFunctionDefinition

< >

( arguments: strname: strdescription: str | None = None )

class huggingface_hub.ChatCompletionOutputLogprob

< >

( logprob: floattoken: strtop_logprobs: list )

class huggingface_hub.ChatCompletionOutputLogprobs

< >

( content: list )

class huggingface_hub.ChatCompletionOutputMessage

< >

( role: strcontent: str | None = Nonereasoning: str | None = Nonetool_call_id: str | None = Nonetool_calls: list[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputToolCall] | None = None )

class huggingface_hub.ChatCompletionOutputToolCall

< >

( function: ChatCompletionOutputFunctionDefinitionid: strtype: str )

class huggingface_hub.ChatCompletionOutputTopLogprob

< >

( logprob: floattoken: str )

class huggingface_hub.ChatCompletionOutputUsage

< >

( completion_tokens: intprompt_tokens: inttotal_tokens: int )

class huggingface_hub.ChatCompletionStreamOutput

< >

( choices: listcreated: intid: strmodel: strsystem_fingerprint: strusage: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputUsage | None = None )

Chat Completion Stream Output. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.ChatCompletionStreamOutputChoice

< >

( delta: ChatCompletionStreamOutputDeltaindex: intfinish_reason: str | None = Nonelogprobs: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputLogprobs | None = None )

class huggingface_hub.ChatCompletionStreamOutputDelta

< >

( role: strcontent: str | None = Nonereasoning: str | None = Nonetool_call_id: str | None = Nonetool_calls: list[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputDeltaToolCall] | None = None )

class huggingface_hub.ChatCompletionStreamOutputDeltaToolCall

< >

( function: ChatCompletionStreamOutputFunctionid: strindex: inttype: str )

class huggingface_hub.ChatCompletionStreamOutputFunction

< >

( arguments: strname: str | None = None )

class huggingface_hub.ChatCompletionStreamOutputLogprob

< >

( logprob: floattoken: strtop_logprobs: list )

class huggingface_hub.ChatCompletionStreamOutputLogprobs

< >

( content: list )

class huggingface_hub.ChatCompletionStreamOutputTopLogprob

< >

( logprob: floattoken: str )

class huggingface_hub.ChatCompletionStreamOutputUsage

< >

( completion_tokens: intprompt_tokens: inttotal_tokens: int )

depth_estimation

class huggingface_hub.DepthEstimationInput

< >

( inputs: typing.Anyparameters: dict[str, typing.Any] | None = None )

Inputs for Depth Estimation inference

class huggingface_hub.DepthEstimationOutput

< >

( depth: typing.Anypredicted_depth: typing.Any )

Outputs of inference for the Depth Estimation task

document_question_answering

class huggingface_hub.DocumentQuestionAnsweringInput

< >

( inputs: DocumentQuestionAnsweringInputDataparameters: huggingface_hub.inference._generated.types.document_question_answering.DocumentQuestionAnsweringParameters | None = None )

Inputs for Document Question Answering inference

class huggingface_hub.DocumentQuestionAnsweringInputData

< >

( image: typing.Anyquestion: str )

One (document, question) pair to answer

class huggingface_hub.DocumentQuestionAnsweringOutputElement

< >

( answer: strend: intscore: floatstart: int )

Outputs of inference for the Document Question Answering task

class huggingface_hub.DocumentQuestionAnsweringParameters

< >

( doc_stride: int | None = Nonehandle_impossible_answer: bool | None = Nonelang: str | None = Nonemax_answer_len: int | None = Nonemax_question_len: int | None = Nonemax_seq_len: int | None = Nonetop_k: int | None = Noneword_boxes: list[list[float] | str] | None = None )

Additional inference parameters for Document Question Answering

feature_extraction

class huggingface_hub.FeatureExtractionInput

< >

( inputs: list[str] | strnormalize: bool | None = Noneprompt_name: str | None = Nonetruncate: bool | None = Nonetruncation_direction: typing.Optional[ForwardRef('FeatureExtractionInputTruncationDirection')] = None )

Feature Extraction Input. Auto-generated from TEI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tei-import.ts.

fill_mask

class huggingface_hub.FillMaskInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.fill_mask.FillMaskParameters | None = None )

Inputs for Fill Mask inference

class huggingface_hub.FillMaskOutputElement

< >

( score: floatsequence: strtoken: inttoken_str: typing.Anyfill_mask_output_token_str: str | None = None )

Outputs of inference for the Fill Mask task

class huggingface_hub.FillMaskParameters

< >

( targets: list[str] | None = Nonetop_k: int | None = None )

Additional inference parameters for Fill Mask

image_classification

class huggingface_hub.ImageClassificationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.image_classification.ImageClassificationParameters | None = None )

Inputs for Image Classification inference

class huggingface_hub.ImageClassificationOutputElement

< >

( label: strscore: float )

Outputs of inference for the Image Classification task

class huggingface_hub.ImageClassificationParameters

< >

( function_to_apply: typing.Optional[ForwardRef('ImageClassificationOutputTransform')] = Nonetop_k: int | None = None )

Additional inference parameters for Image Classification

image_segmentation

class huggingface_hub.ImageSegmentationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.image_segmentation.ImageSegmentationParameters | None = None )

Inputs for Image Segmentation inference

class huggingface_hub.ImageSegmentationOutputElement

< >

( label: strmask: strscore: float | None = None )

Outputs of inference for the Image Segmentation task A predicted mask / segment

class huggingface_hub.ImageSegmentationParameters

< >

( mask_threshold: float | None = Noneoverlap_mask_area_threshold: float | None = Nonesubtask: typing.Optional[ForwardRef('ImageSegmentationSubtask')] = Nonethreshold: float | None = None )

Additional inference parameters for Image Segmentation

image_text_to_image

class huggingface_hub.ImageTextToImageInput

< >

( inputs: str | None = Noneparameters: huggingface_hub.inference._generated.types.image_text_to_image.ImageTextToImageParameters | None = None )

Inputs for Image Text To Image inference. Either inputs (image) or prompt (in parameters) must be provided, or both.

class huggingface_hub.ImageTextToImageOutput

< >

( image: typing.Any )

Outputs of inference for the Image Text To Image task

class huggingface_hub.ImageTextToImageParameters

< >

( guidance_scale: float | None = Nonenegative_prompt: str | None = Nonenum_inference_steps: int | None = Noneprompt: str | None = Noneseed: int | None = Nonetarget_size: huggingface_hub.inference._generated.types.image_text_to_image.ImageTextToImageTargetSize | None = None )

Additional inference parameters for Image Text To Image

class huggingface_hub.ImageTextToImageTargetSize

< >

( height: intwidth: int )

The size in pixels of the output image. This parameter is only supported by some providers and for specific models. It will be ignored when unsupported.

image_text_to_video

class huggingface_hub.ImageTextToVideoInput

< >

( inputs: str | None = Noneparameters: huggingface_hub.inference._generated.types.image_text_to_video.ImageTextToVideoParameters | None = None )

Inputs for Image Text To Video inference. Either inputs (image) or prompt (in parameters) must be provided, or both.

class huggingface_hub.ImageTextToVideoOutput

< >

( video: typing.Any )

Outputs of inference for the Image Text To Video task

class huggingface_hub.ImageTextToVideoParameters

< >

( guidance_scale: float | None = Nonenegative_prompt: str | None = Nonenum_frames: float | None = Nonenum_inference_steps: int | None = Noneprompt: str | None = Noneseed: int | None = Nonetarget_size: huggingface_hub.inference._generated.types.image_text_to_video.ImageTextToVideoTargetSize | None = None )

Additional inference parameters for Image Text To Video

class huggingface_hub.ImageTextToVideoTargetSize

< >

( height: intwidth: int )

The size in pixel of the output video frames.

image_to_image

class huggingface_hub.ImageToImageInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.image_to_image.ImageToImageParameters | None = None )

Inputs for Image To Image inference

class huggingface_hub.ImageToImageOutput

< >

( image: typing.Any )

Outputs of inference for the Image To Image task

class huggingface_hub.ImageToImageParameters

< >

( guidance_scale: float | None = Nonenegative_prompt: str | None = Nonenum_inference_steps: int | None = Noneprompt: str | None = Nonetarget_size: huggingface_hub.inference._generated.types.image_to_image.ImageToImageTargetSize | None = None )

Additional inference parameters for Image To Image

class huggingface_hub.ImageToImageTargetSize

< >

( height: intwidth: int )

The size in pixels of the output image. This parameter is only supported by some providers and for specific models. It will be ignored when unsupported.

image_to_text

class huggingface_hub.ImageToTextGenerationParameters

< >

( do_sample: bool | None = Noneearly_stopping: typing.Union[bool, ForwardRef('ImageToTextEarlyStoppingEnum'), NoneType] = Noneepsilon_cutoff: float | None = Noneeta_cutoff: float | None = Nonemax_length: int | None = Nonemax_new_tokens: int | None = Nonemin_length: int | None = Nonemin_new_tokens: int | None = Nonenum_beam_groups: int | None = Nonenum_beams: int | None = Nonepenalty_alpha: float | None = Nonetemperature: float | None = Nonetop_k: int | None = Nonetop_p: float | None = Nonetypical_p: float | None = Noneuse_cache: bool | None = None )

Parametrization of the text generation process

class huggingface_hub.ImageToTextInput

< >

( inputs: typing.Anyparameters: huggingface_hub.inference._generated.types.image_to_text.ImageToTextParameters | None = None )

Inputs for Image To Text inference

class huggingface_hub.ImageToTextOutput

< >

( generated_text: typing.Anyimage_to_text_output_generated_text: str | None = None )

Outputs of inference for the Image To Text task

class huggingface_hub.ImageToTextParameters

< >

( generation_parameters: huggingface_hub.inference._generated.types.image_to_text.ImageToTextGenerationParameters | None = Nonemax_new_tokens: int | None = None )

Additional inference parameters for Image To Text

image_to_video

class huggingface_hub.ImageToVideoInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.image_to_video.ImageToVideoParameters | None = None )

Inputs for Image To Video inference

class huggingface_hub.ImageToVideoOutput

< >

( video: typing.Any )

Outputs of inference for the Image To Video task

class huggingface_hub.ImageToVideoParameters

< >

( guidance_scale: float | None = Nonenegative_prompt: str | None = Nonenum_frames: float | None = Nonenum_inference_steps: int | None = Noneprompt: str | None = Noneseed: int | None = Nonetarget_size: huggingface_hub.inference._generated.types.image_to_video.ImageToVideoTargetSize | None = None )

Additional inference parameters for Image To Video

class huggingface_hub.ImageToVideoTargetSize

< >

( height: intwidth: int )

The size in pixel of the output video frames.

object_detection

class huggingface_hub.ObjectDetectionBoundingBox

< >

( xmax: intxmin: intymax: intymin: int )

The predicted bounding box. Coordinates are relative to the top left corner of the input image.

class huggingface_hub.ObjectDetectionInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.object_detection.ObjectDetectionParameters | None = None )

Inputs for Object Detection inference

class huggingface_hub.ObjectDetectionOutputElement

< >

( box: ObjectDetectionBoundingBoxlabel: strscore: float )

Outputs of inference for the Object Detection task

class huggingface_hub.ObjectDetectionParameters

< >

( threshold: float | None = None )

Additional inference parameters for Object Detection

question_answering

class huggingface_hub.QuestionAnsweringInput

< >

( inputs: QuestionAnsweringInputDataparameters: huggingface_hub.inference._generated.types.question_answering.QuestionAnsweringParameters | None = None )

Inputs for Question Answering inference

class huggingface_hub.QuestionAnsweringInputData

< >

( context: strquestion: str )

One (context, question) pair to answer

class huggingface_hub.QuestionAnsweringOutputElement

< >

( answer: strend: intscore: floatstart: int )

Outputs of inference for the Question Answering task

class huggingface_hub.QuestionAnsweringParameters

< >

( align_to_words: bool | None = Nonedoc_stride: int | None = Nonehandle_impossible_answer: bool | None = Nonemax_answer_len: int | None = Nonemax_question_len: int | None = Nonemax_seq_len: int | None = Nonetop_k: int | None = None )

Additional inference parameters for Question Answering

sentence_similarity

class huggingface_hub.SentenceSimilarityInput

< >

( inputs: SentenceSimilarityInputDataparameters: dict[str, typing.Any] | None = None )

Inputs for Sentence similarity inference

class huggingface_hub.SentenceSimilarityInputData

< >

( sentences: listsource_sentence: str )

summarization

class huggingface_hub.SummarizationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.summarization.SummarizationParameters | None = None )

Inputs for Summarization inference

class huggingface_hub.SummarizationOutput

< >

( summary_text: str )

Outputs of inference for the Summarization task

class huggingface_hub.SummarizationParameters

< >

( clean_up_tokenization_spaces: bool | None = Nonegenerate_parameters: dict[str, typing.Any] | None = Nonetruncation: typing.Optional[ForwardRef('SummarizationTruncationStrategy')] = None )

Additional inference parameters for summarization.

table_question_answering

class huggingface_hub.TableQuestionAnsweringInput

< >

( inputs: TableQuestionAnsweringInputDataparameters: huggingface_hub.inference._generated.types.table_question_answering.TableQuestionAnsweringParameters | None = None )

Inputs for Table Question Answering inference

class huggingface_hub.TableQuestionAnsweringInputData

< >

( question: strtable: dict )

One (table, question) pair to answer

class huggingface_hub.TableQuestionAnsweringOutputElement

< >

( answer: strcells: listcoordinates: listaggregator: str | None = None )

Outputs of inference for the Table Question Answering task

class huggingface_hub.TableQuestionAnsweringParameters

< >

( padding: typing.Optional[ForwardRef('Padding')] = Nonesequential: bool | None = Nonetruncation: bool | None = None )

Additional inference parameters for Table Question Answering

text2text_generation

class huggingface_hub.Text2TextGenerationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text2text_generation.Text2TextGenerationParameters | None = None )

Inputs for Text2text Generation inference

class huggingface_hub.Text2TextGenerationOutput

< >

( generated_text: typing.Anytext2_text_generation_output_generated_text: str | None = None )

Outputs of inference for the Text2text Generation task

class huggingface_hub.Text2TextGenerationParameters

< >

( clean_up_tokenization_spaces: bool | None = Nonegenerate_parameters: dict[str, typing.Any] | None = Nonetruncation: typing.Optional[ForwardRef('Text2TextGenerationTruncationStrategy')] = None )

Additional inference parameters for Text2text Generation

text_classification

class huggingface_hub.TextClassificationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_classification.TextClassificationParameters | None = None )

Inputs for Text Classification inference

class huggingface_hub.TextClassificationOutputElement

< >

( label: strscore: float )

Outputs of inference for the Text Classification task

class huggingface_hub.TextClassificationParameters

< >

( function_to_apply: typing.Optional[ForwardRef('TextClassificationOutputTransform')] = Nonetop_k: int | None = None )

Additional inference parameters for Text Classification

text_generation

class huggingface_hub.TextGenerationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_generation.TextGenerationInputGenerateParameters | None = Nonestream: bool | None = None )

Text Generation Input. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.TextGenerationInputGenerateParameters

< >

( adapter_id: str | None = Nonebest_of: int | None = Nonedecoder_input_details: bool | None = Nonedetails: bool | None = Nonedo_sample: bool | None = Nonefrequency_penalty: float | None = Nonegrammar: huggingface_hub.inference._generated.types.text_generation.TextGenerationInputGrammarType | None = Nonemax_new_tokens: int | None = Nonerepetition_penalty: float | None = Nonereturn_full_text: bool | None = Noneseed: int | None = Nonestop: list[str] | None = Nonetemperature: float | None = Nonetop_k: int | None = Nonetop_n_tokens: int | None = Nonetop_p: float | None = Nonetruncate: int | None = Nonetypical_p: float | None = Nonewatermark: bool | None = None )

class huggingface_hub.TextGenerationInputGrammarType

< >

( type: TypeEnumvalue: typing.Any )

class huggingface_hub.TextGenerationOutput

< >

( generated_text: strdetails: huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputDetails | None = None )

Text Generation Output. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.TextGenerationOutputBestOfSequence

< >

( finish_reason: TextGenerationOutputFinishReasongenerated_text: strgenerated_tokens: intprefill: listtokens: listseed: int | None = Nonetop_tokens: list[list[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]] | None = None )

class huggingface_hub.TextGenerationOutputDetails

< >

( finish_reason: TextGenerationOutputFinishReasongenerated_tokens: intprefill: listtokens: listbest_of_sequences: list[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputBestOfSequence] | None = Noneseed: int | None = Nonetop_tokens: list[list[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]] | None = None )

class huggingface_hub.TextGenerationOutputPrefillToken

< >

( id: intlogprob: floattext: str )

class huggingface_hub.TextGenerationOutputToken

< >

( id: intlogprob: floatspecial: booltext: str )

class huggingface_hub.TextGenerationStreamOutput

< >

( index: inttoken: TextGenerationStreamOutputTokendetails: huggingface_hub.inference._generated.types.text_generation.TextGenerationStreamOutputStreamDetails | None = Nonegenerated_text: str | None = Nonetop_tokens: list[huggingface_hub.inference._generated.types.text_generation.TextGenerationStreamOutputToken] | None = None )

Text Generation Stream Output. Auto-generated from TGI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.

class huggingface_hub.TextGenerationStreamOutputStreamDetails

< >

( finish_reason: TextGenerationOutputFinishReasongenerated_tokens: intinput_length: intseed: int | None = None )

class huggingface_hub.TextGenerationStreamOutputToken

< >

( id: intlogprob: floatspecial: booltext: str )

text_to_audio

class huggingface_hub.TextToAudioGenerationParameters

< >

( do_sample: bool | None = Noneearly_stopping: typing.Union[bool, ForwardRef('TextToAudioEarlyStoppingEnum'), NoneType] = Noneepsilon_cutoff: float | None = Noneeta_cutoff: float | None = Nonemax_length: int | None = Nonemax_new_tokens: int | None = Nonemin_length: int | None = Nonemin_new_tokens: int | None = Nonenum_beam_groups: int | None = Nonenum_beams: int | None = Nonepenalty_alpha: float | None = Nonetemperature: float | None = Nonetop_k: int | None = Nonetop_p: float | None = Nonetypical_p: float | None = Noneuse_cache: bool | None = None )

Parametrization of the text generation process

class huggingface_hub.TextToAudioInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_to_audio.TextToAudioParameters | None = None )

Inputs for Text To Audio inference

class huggingface_hub.TextToAudioOutput

< >

( audio: typing.Anysampling_rate: float )

Outputs of inference for the Text To Audio task

class huggingface_hub.TextToAudioParameters

< >

( generation_parameters: huggingface_hub.inference._generated.types.text_to_audio.TextToAudioGenerationParameters | None = None )

Additional inference parameters for Text To Audio

text_to_image

class huggingface_hub.TextToImageInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_to_image.TextToImageParameters | None = None )

Inputs for Text To Image inference

class huggingface_hub.TextToImageOutput

< >

( image: typing.Any )

Outputs of inference for the Text To Image task

class huggingface_hub.TextToImageParameters

< >

( guidance_scale: float | None = Noneheight: int | None = Nonenegative_prompt: str | None = Nonenum_inference_steps: int | None = Nonescheduler: str | None = Noneseed: int | None = Nonewidth: int | None = None )

Additional inference parameters for Text To Image

text_to_speech

class huggingface_hub.TextToSpeechGenerationParameters

< >

( do_sample: bool | None = Noneearly_stopping: typing.Union[bool, ForwardRef('TextToSpeechEarlyStoppingEnum'), NoneType] = Noneepsilon_cutoff: float | None = Noneeta_cutoff: float | None = Nonemax_length: int | None = Nonemax_new_tokens: int | None = Nonemin_length: int | None = Nonemin_new_tokens: int | None = Nonenum_beam_groups: int | None = Nonenum_beams: int | None = Nonepenalty_alpha: float | None = Nonetemperature: float | None = Nonetop_k: int | None = Nonetop_p: float | None = Nonetypical_p: float | None = Noneuse_cache: bool | None = None )

Parametrization of the text generation process

class huggingface_hub.TextToSpeechInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_to_speech.TextToSpeechParameters | None = None )

Inputs for Text To Speech inference

class huggingface_hub.TextToSpeechOutput

< >

( audio: typing.Anysampling_rate: float | None = None )

Outputs of inference for the Text To Speech task

class huggingface_hub.TextToSpeechParameters

< >

( generation_parameters: huggingface_hub.inference._generated.types.text_to_speech.TextToSpeechGenerationParameters | None = None )

Additional inference parameters for Text To Speech

text_to_video

class huggingface_hub.TextToVideoInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.text_to_video.TextToVideoParameters | None = None )

Inputs for Text To Video inference

class huggingface_hub.TextToVideoOutput

< >

( video: typing.Any )

Outputs of inference for the Text To Video task

class huggingface_hub.TextToVideoParameters

< >

( guidance_scale: float | None = Nonenegative_prompt: list[str] | None = Nonenum_frames: float | None = Nonenum_inference_steps: int | None = Noneseed: int | None = None )

Additional inference parameters for Text To Video

token_classification

class huggingface_hub.TokenClassificationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.token_classification.TokenClassificationParameters | None = None )

Inputs for Token Classification inference

class huggingface_hub.TokenClassificationOutputElement

< >

( end: intscore: floatstart: intword: strentity: str | None = Noneentity_group: str | None = None )

Outputs of inference for the Token Classification task

class huggingface_hub.TokenClassificationParameters

< >

( aggregation_strategy: typing.Optional[ForwardRef('TokenClassificationAggregationStrategy')] = Noneignore_labels: list[str] | None = Nonestride: int | None = None )

Additional inference parameters for Token Classification

translation

class huggingface_hub.TranslationInput

< >

( inputs: strparameters: huggingface_hub.inference._generated.types.translation.TranslationParameters | None = None )

Inputs for Translation inference

class huggingface_hub.TranslationOutput

< >

( translation_text: str )

Outputs of inference for the Translation task

class huggingface_hub.TranslationParameters

< >

( clean_up_tokenization_spaces: bool | None = Nonegenerate_parameters: dict[str, typing.Any] | None = Nonesrc_lang: str | None = Nonetgt_lang: str | None = Nonetruncation: typing.Optional[ForwardRef('TranslationTruncationStrategy')] = None )

Additional inference parameters for Translation

video_classification

class huggingface_hub.VideoClassificationInput

< >

( inputs: typing.Anyparameters: huggingface_hub.inference._generated.types.video_classification.VideoClassificationParameters | None = None )

Inputs for Video Classification inference

class huggingface_hub.VideoClassificationOutputElement

< >

( label: strscore: float )

Outputs of inference for the Video Classification task

class huggingface_hub.VideoClassificationParameters

< >

( frame_sampling_rate: int | None = Nonefunction_to_apply: typing.Optional[ForwardRef('VideoClassificationOutputTransform')] = Nonenum_frames: int | None = Nonetop_k: int | None = None )

Additional inference parameters for Video Classification

visual_question_answering

class huggingface_hub.VisualQuestionAnsweringInput

< >

( inputs: VisualQuestionAnsweringInputDataparameters: huggingface_hub.inference._generated.types.visual_question_answering.VisualQuestionAnsweringParameters | None = None )

Inputs for Visual Question Answering inference

class huggingface_hub.VisualQuestionAnsweringInputData

< >

( image: typing.Anyquestion: str )

One (image, question) pair to answer

class huggingface_hub.VisualQuestionAnsweringOutputElement

< >

( score: floatanswer: str | None = None )

Outputs of inference for the Visual Question Answering task

class huggingface_hub.VisualQuestionAnsweringParameters

< >

( top_k: int | None = None )

Additional inference parameters for Visual Question Answering

zero_shot_classification

class huggingface_hub.ZeroShotClassificationInput

< >

( inputs: strparameters: ZeroShotClassificationParameters )

Inputs for Zero Shot Classification inference

class huggingface_hub.ZeroShotClassificationOutputElement

< >

( label: strscore: float )

Outputs of inference for the Zero Shot Classification task

class huggingface_hub.ZeroShotClassificationParameters

< >

( candidate_labels: listhypothesis_template: str | None = Nonemulti_label: bool | None = None )

Additional inference parameters for Zero Shot Classification

zero_shot_image_classification

class huggingface_hub.ZeroShotImageClassificationInput

< >

( inputs: strparameters: ZeroShotImageClassificationParameters )

Inputs for Zero Shot Image Classification inference

class huggingface_hub.ZeroShotImageClassificationOutputElement

< >

( label: strscore: float )

Outputs of inference for the Zero Shot Image Classification task

class huggingface_hub.ZeroShotImageClassificationParameters

< >

( candidate_labels: listhypothesis_template: str | None = None )

Additional inference parameters for Zero Shot Image Classification

zero_shot_object_detection

class huggingface_hub.ZeroShotObjectDetectionBoundingBox

< >

( xmax: intxmin: intymax: intymin: int )

The predicted bounding box. Coordinates are relative to the top left corner of the input image.

class huggingface_hub.ZeroShotObjectDetectionInput

< >

( inputs: strparameters: ZeroShotObjectDetectionParameters )

Inputs for Zero Shot Object Detection inference

class huggingface_hub.ZeroShotObjectDetectionOutputElement

< >

( box: ZeroShotObjectDetectionBoundingBoxlabel: strscore: float )

Outputs of inference for the Zero Shot Object Detection task

class huggingface_hub.ZeroShotObjectDetectionParameters

< >

( candidate_labels: list )

Additional inference parameters for Zero Shot Object Detection

Update on GitHub

←Mixins & serialization methods Inference Client→