Hugging Face's logo

Hub Python 库文档

推理类型

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始入门

推理类型

此页面列出了 Hugging Face Hub 上支持的每种任务可用的类型（例如，数据类）。每个任务都使用 JSON 模式指定，并且类型是从这些模式生成的 - 由于 Python 要求，进行了一些自定义。访问 @huggingface.js/tasks 以查找每个任务的 JSON 模式。

库的这一部分仍在开发中，将在未来的版本中得到改进。

audio_classification

class huggingface_hub.AudioClassificationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.audio_classification.AudioClassificationParameters] = None )

音频分类推理的输入

class huggingface_hub.AudioClassificationOutputElement

< >

( label: str score: float )

音频分类推理的输出

class huggingface_hub.AudioClassificationParameters

< >

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

音频分类的附加推理参数

audio_to_audio

class huggingface_hub.AudioToAudioInput

< >

( inputs: typing.Any )

音频到音频推理的输入

class huggingface_hub.AudioToAudioOutputElement

< >

( blob: typing.Any content_type: str label: str )

音频到音频任务推理的输出。一个带标签的生成的音频文件。

automatic_speech_recognition

class huggingface_hub.AutomaticSpeechRecognitionGenerationParameters

< >

( do_sample: typing.Optional[bool] = None early_stopping: typing.Union[bool, ForwardRef('AutomaticSpeechRecognitionEarlyStoppingEnum'), NoneType] = None epsilon_cutoff: typing.Optional[float] = None eta_cutoff: typing.Optional[float] = None max_length: typing.Optional[int] = None max_new_tokens: typing.Optional[int] = None min_length: typing.Optional[int] = None min_new_tokens: typing.Optional[int] = None num_beam_groups: typing.Optional[int] = None num_beams: typing.Optional[int] = None penalty_alpha: typing.Optional[float] = None temperature: typing.Optional[float] = None top_k: typing.Optional[int] = None top_p: typing.Optional[float] = None typical_p: typing.Optional[float] = None use_cache: typing.Optional[bool] = None )

文本生成过程的参数化

class huggingface_hub.AutomaticSpeechRecognitionInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionParameters] = None )

自动语音识别推理的输入

class huggingface_hub.AutomaticSpeechRecognitionOutput

< >

( text: str chunks: typing.Optional[typing.List[huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionOutputChunk]] = None )

自动语音识别任务的推理输出

class huggingface_hub.AutomaticSpeechRecognitionOutputChunk

< >

( text: str timestamp: typing.List[float] )

class huggingface_hub.AutomaticSpeechRecognitionParameters

< >

( return_timestamps: typing.Optional[bool] = None generate_kwargs: typing.Optional[huggingface_hub.inference._generated.types.automatic_speech_recognition.AutomaticSpeechRecognitionGenerationParameters] = None )

Additional inference parameters for Automatic Speech Recognition

chat_completion

class huggingface_hub.ChatCompletionInput

< >

( messages: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputMessage] frequency_penalty: typing.Optional[float] = None logit_bias: typing.Optional[typing.List[float]] = None logprobs: typing.Optional[bool] = None max_tokens: typing.Optional[int] = None model: typing.Optional[str] = None n: typing.Optional[int] = None presence_penalty: typing.Optional[float] = None response_format: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputGrammarType] = None seed: typing.Optional[int] = None stop: typing.Optional[typing.List[str]] = None stream: typing.Optional[bool] = None stream_options: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputStreamOptions] = None temperature: typing.Optional[float] = None tool_choice: typing.Union[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputToolChoiceClass, ForwardRef('ChatCompletionInputToolChoiceEnum'), NoneType] = None tool_prompt: typing.Optional[str] = None tools: typing.Optional[typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputTool]] = None top_logprobs: typing.Optional[int] = None top_p: typing.Optional[float] = 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

< >

( arguments: typing.Any name: str description: typing.Optional[str] = None )

class huggingface_hub.ChatCompletionInputFunctionName

< >

( name: str )

class huggingface_hub.ChatCompletionInputGrammarType

< >

( type: ChatCompletionInputGrammarTypeType value: typing.Any )

class huggingface_hub.ChatCompletionInputMessage

< >

( role: str content: typing.Union[typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputMessageChunk], str, NoneType] = None name: typing.Optional[str] = None tool_calls: typing.Optional[typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputToolCall]] = None )

class huggingface_hub.ChatCompletionInputMessageChunk

< >

( type: ChatCompletionInputMessageChunkType image_url: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInputURL] = None text: typing.Optional[str] = None )

class huggingface_hub.ChatCompletionInputStreamOptions

< >

( include_usage: typing.Optional[bool] = None )

class huggingface_hub.ChatCompletionInputTool

< >

( function: ChatCompletionInputFunctionDefinition type: str )

class huggingface_hub.ChatCompletionInputToolCall

< >

( function: ChatCompletionInputFunctionDefinition id: str type: str )

class huggingface_hub.ChatCompletionInputToolChoiceClass

< >

( function: ChatCompletionInputFunctionName )

class huggingface_hub.ChatCompletionInputURL

< >

( url: str )

class huggingface_hub.ChatCompletionOutput

< >

( choices: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputComplete] created: int id: str model: str system_fingerprint: str usage: 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: str index: int message: ChatCompletionOutputMessage logprobs: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputLogprobs] = None )

class huggingface_hub.ChatCompletionOutputFunctionDefinition

< >

( arguments: typing.Any name: str description: typing.Optional[str] = None )

class huggingface_hub.ChatCompletionOutputLogprob

< >

( logprob: float token: str top_logprobs: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputTopLogprob] )

class huggingface_hub.ChatCompletionOutputLogprobs

< >

( content: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputLogprob] )

class huggingface_hub.ChatCompletionOutputMessage

< >

( role: str content: typing.Optional[str] = None tool_call_id: typing.Optional[str] = None tool_calls: typing.Optional[typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputToolCall]] = None )

class huggingface_hub.ChatCompletionOutputToolCall

< >

( function: ChatCompletionOutputFunctionDefinition id: 字符串 type: 字符串 )

class huggingface_hub.ChatCompletionOutputTopLogprob

< >

( logprob: 浮点数 token: 字符串 )

class huggingface_hub.ChatCompletionOutputUsage

< >

( completion_tokens: 整数 prompt_tokens: 整数 total_tokens: 整数 )

class huggingface_hub.ChatCompletionStreamOutput

< >

( choices: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputChoice] created: 整数 id: 字符串 model: 字符串 system_fingerprint: 字符串 usage: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputUsage] = None )

Chat Completion Stream Output. 从 TGI 规范自动生成。更多详情请查看 https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts。

class huggingface_hub.ChatCompletionStreamOutputChoice

< >

( delta: ChatCompletionStreamOutputDelta index: 整数 finish_reason: typing.Optional[字符串] = None logprobs: typing.Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputLogprobs] = None )

class huggingface_hub.ChatCompletionStreamOutputDelta

< >

( role: 字符串 content: typing.Optional[字符串] = None tool_call_id: typing.Optional[字符串] = None tool_calls: typing.Optional[typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputDeltaToolCall]] = None )

class huggingface_hub.ChatCompletionStreamOutputDeltaToolCall

< >

( function: ChatCompletionStreamOutputFunction id: 字符串 index: 整数 type: 字符串 )

class huggingface_hub.ChatCompletionStreamOutputFunction

< >

( arguments: 字符串 name: typing.Optional[字符串] = None )

class huggingface_hub.ChatCompletionStreamOutputLogprob

< >

( logprob: 浮点数 token: 字符串 top_logprobs: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputTopLogprob] )

class huggingface_hub.ChatCompletionStreamOutputLogprobs

< >

( content: typing.List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputLogprob] )

class huggingface_hub.ChatCompletionStreamOutputTopLogprob

< >

( logprob: 浮点数 token: 字符串 )

class huggingface_hub.ChatCompletionStreamOutputUsage

< >

( completion_tokens: 整数 prompt_tokens: 整数 total_tokens: 整数 )

深度估计

class huggingface_hub.DepthEstimationInput

< >

( inputs: typing.Any parameters: typing.Optional[typing.Dict[字符串, typing.Any]] = None )

深度估计推理的输入

class huggingface_hub.DepthEstimationOutput

< >

( depth: typing.Any predicted_depth: typing.Any )

深度估计任务的推理输出

文档问答

class huggingface_hub.DocumentQuestionAnsweringInput

< >

( inputs: DocumentQuestionAnsweringInputData parameters: typing.Optional[huggingface_hub.inference._generated.types.document_question_answering.DocumentQuestionAnsweringParameters] = None )

文档问答推理的输入

class huggingface_hub.DocumentQuestionAnsweringInputData

< >

( image: typing.Any question: 字符串 )

一个待回答的（文档，问题）对

class huggingface_hub.DocumentQuestionAnsweringOutputElement

< >

( answer: 字符串 end: 整数 score: 浮点数 start: 整数 )

文档问答任务的推理输出

class huggingface_hub.DocumentQuestionAnsweringParameters

< >

( doc_stride: typing.Optional[int] = None handle_impossible_answer: typing.Optional[bool] = None lang: typing.Optional[str] = None max_answer_len: typing.Optional[int] = None max_question_len: typing.Optional[int] = None max_seq_len: typing.Optional[int] = None top_k: typing.Optional[int] = None word_boxes: typing.Optional[typing.List[typing.Union[typing.List[float], str]]] = None )

Document Question Answering 的附加推理参数

feature_extraction

class huggingface_hub.FeatureExtractionInput

< >

( inputs: typing.Union[typing.List[str], str] normalize: typing.Optional[bool] = None prompt_name: typing.Optional[str] = None truncate: typing.Optional[bool] = None truncation_direction: typing.Optional[ForwardRef('FeatureExtractionInputTruncationDirection')] = None )

特征提取输入。自动生成自 TEI 规范。欲了解更多详情，请查看 https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tei-import.ts。

fill_mask

class huggingface_hub.FillMaskInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.fill_mask.FillMaskParameters] = None )

Fill Mask 推理的输入

class huggingface_hub.FillMaskOutputElement

< >

( score: float sequence: str token: int token_str: typing.Any fill_mask_output_token_str: typing.Optional[str] = None )

Fill Mask 任务的推理输出

class huggingface_hub.FillMaskParameters

< >

( targets: typing.Optional[typing.List[str]] = None top_k: typing.Optional[int] = None )

Fill Mask 的附加推理参数

image_classification

class huggingface_hub.ImageClassificationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.image_classification.ImageClassificationParameters] = None )

图像分类推理的输入

class huggingface_hub.ImageClassificationOutputElement

< >

( label: str score: float )

图像分类任务的推理输出

class huggingface_hub.ImageClassificationParameters

< >

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

图像分类的附加推理参数

image_segmentation

class huggingface_hub.ImageSegmentationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.image_segmentation.ImageSegmentationParameters] = None )

图像分割推理的输入

class huggingface_hub.ImageSegmentationOutputElement

< >

( label: str mask: str score: typing.Optional[float] = None )

图像分割任务的推理输出。一个预测的掩码/分割

class huggingface_hub.ImageSegmentationParameters

< >

( mask_threshold: typing.Optional[float] = None overlap_mask_area_threshold: typing.Optional[float] = None subtask: typing.Optional[ForwardRef('ImageSegmentationSubtask')] = None threshold: typing.Optional[float] = None )

图像分割的附加推理参数

image_to_image

class huggingface_hub.ImageToImageInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.image_to_image.ImageToImageParameters] = None )

图像到图像推理的输入

class huggingface_hub.ImageToImageOutput

< >

( image: typing.Any )

图像到图像任务的推理输出

class huggingface_hub.ImageToImageParameters

< >

( guidance_scale: typing.Optional[float] = None negative_prompt: typing.Optional[str] = None num_inference_steps: typing.Optional[int] = None prompt: typing.Optional[str] = None target_size: typing.Optional[huggingface_hub.inference._generated.types.image_to_image.ImageToImageTargetSize] = None )

图像到图像的附加推理参数

class huggingface_hub.ImageToImageTargetSize

< >

( height: int width: int )

输出图像的像素尺寸。

image_to_text

class huggingface_hub.ImageToTextGenerationParameters

< >

( do_sample: typing.Optional[bool] = None early_stopping: typing.Union[bool, ForwardRef('ImageToTextEarlyStoppingEnum'), NoneType] = None epsilon_cutoff: typing.Optional[float] = None eta_cutoff: typing.Optional[float] = None max_length: typing.Optional[int] = None max_new_tokens: typing.Optional[int] = None min_length: typing.Optional[int] = None min_new_tokens: typing.Optional[int] = None num_beam_groups: typing.Optional[int] = None num_beams: typing.Optional[int] = None penalty_alpha: typing.Optional[float] = None temperature: typing.Optional[float] = None top_k: typing.Optional[int] = None top_p: typing.Optional[float] = None typical_p: typing.Optional[float] = None use_cache: typing.Optional[bool] = None )

文本生成过程的参数化

class huggingface_hub.ImageToTextInput

< >

( inputs: typing.Any parameters: typing.Optional[huggingface_hub.inference._generated.types.image_to_text.ImageToTextParameters] = None )

图像到文本推理的输入

class huggingface_hub.ImageToTextOutput

< >

( generated_text: typing.Any image_to_text_output_generated_text: typing.Optional[str] = None )

图像到文本任务的推理输出

class huggingface_hub.ImageToTextParameters

< >

( max_new_tokens: typing.Optional[int] = None generate_kwargs: typing.Optional[huggingface_hub.inference._generated.types.image_to_text.ImageToTextGenerationParameters] = None )

图像到文本的额外推理参数

object_detection

class huggingface_hub.ObjectDetectionBoundingBox

< >

( xmax: int xmin: int ymax: int ymin: int )

预测的边界框。坐标相对于输入图像的左上角。

class huggingface_hub.ObjectDetectionInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.object_detection.ObjectDetectionParameters] = None )

目标检测推理的输入

class huggingface_hub.ObjectDetectionOutputElement

< >

( box: ObjectDetectionBoundingBox label: str score: float )

目标检测任务的推理输出

class huggingface_hub.ObjectDetectionParameters

< >

( threshold: typing.Optional[float] = None )

目标检测的额外推理参数

question_answering

class huggingface_hub.QuestionAnsweringInput

< >

( inputs: QuestionAnsweringInputData parameters: typing.Optional[huggingface_hub.inference._generated.types.question_answering.QuestionAnsweringParameters] = None )

问题回答推理的输入

class huggingface_hub.QuestionAnsweringInputData

< >

( context: str question: str )

一个 (上下文，问题) 对，用于回答

class huggingface_hub.QuestionAnsweringOutputElement

< >

( answer: 字符串 end: 整数 score: 浮点数 start: 整数 )

问题回答任务的推理输出

class huggingface_hub.QuestionAnsweringParameters

< >

( align_to_words: typing.Optional[bool] = None doc_stride: typing.Optional[int] = None handle_impossible_answer: typing.Optional[bool] = None max_answer_len: typing.Optional[int] = None max_question_len: typing.Optional[int] = None max_seq_len: typing.Optional[int] = None top_k: typing.Optional[int] = None )

问题回答的额外推理参数

sentence_similarity

class huggingface_hub.SentenceSimilarityInput

< >

( inputs: SentenceSimilarityInputData parameters: typing.Optional[typing.Dict[str, typing.Any]] = None )

句子相似度推理的输入

class huggingface_hub.SentenceSimilarityInputData

< >

( sentences: typing.List[str] source_sentence: str )

summarization

class huggingface_hub.SummarizationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.summarization.SummarizationParameters] = None )

文本摘要推理的输入

class huggingface_hub.SummarizationOutput

< >

( summary_text: str )

文本摘要任务的推理输出

class huggingface_hub.SummarizationParameters

< >

( clean_up_tokenization_spaces: typing.Optional[bool] = None generate_parameters: typing.Optional[typing.Dict[str, typing.Any]] = None truncation: typing.Optional[ForwardRef('SummarizationTruncationStrategy')] = None )

摘要的附加推理参数。

表格问答

class huggingface_hub.TableQuestionAnsweringInput

< >

( inputs: TableQuestionAnsweringInputData parameters: typing.Optional[huggingface_hub.inference._generated.types.table_question_answering.TableQuestionAnsweringParameters] = None )

表格问答推理的输入

class huggingface_hub.TableQuestionAnsweringInputData

< >

( question: str table: typing.Dict[str, typing.List[str]] )

待回答的一个（表格，问题）对

class huggingface_hub.TableQuestionAnsweringOutputElement

< >

( answer: str cells: typing.List[str] coordinates: typing.List[typing.List[int]] aggregator: typing.Optional[str] = None )

表格问答任务的推理输出

class huggingface_hub.TableQuestionAnsweringParameters

< >

( padding: typing.Optional[ForwardRef('Padding')] = None sequential: typing.Optional[bool] = None truncation: typing.Optional[bool] = None )

表格问答的附加推理参数

文本到文本生成

class huggingface_hub.Text2TextGenerationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text2text_generation.Text2TextGenerationParameters] = None )

文本到文本生成推理的输入

class huggingface_hub.Text2TextGenerationOutput

< >

( generated_text: typing.Any text2_text_generation_output_generated_text: typing.Optional[str] = None )

文本到文本生成任务的推理输出

class huggingface_hub.Text2TextGenerationParameters

< >

( clean_up_tokenization_spaces: typing.Optional[bool] = None generate_parameters: typing.Optional[typing.Dict[str, typing.Any]] = None truncation: typing.Optional[ForwardRef('Text2TextGenerationTruncationStrategy')] = None )

文本到文本生成的附加推理参数

文本分类

class huggingface_hub.TextClassificationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_classification.TextClassificationParameters] = None )

文本分类推理的输入

class huggingface_hub.TextClassificationOutputElement

< >

( label: str score: float )

文本分类任务的推理输出

class huggingface_hub.TextClassificationParameters

< >

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

文本分类的附加推理参数

文本生成

class huggingface_hub.TextGenerationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_generation.TextGenerationInputGenerateParameters] = None stream: typing.Optional[bool] = None )

文本生成输入。从 TGI 规范自动生成。更多详情，请查看https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts。

class huggingface_hub.TextGenerationInputGenerateParameters

< >

( adapter_id: typing.Optional[str] = None best_of: typing.Optional[int] = None decoder_input_details: typing.Optional[bool] = None details: typing.Optional[bool] = None do_sample: typing.Optional[bool] = None frequency_penalty: typing.Optional[float] = None grammar: typing.Optional[huggingface_hub.inference._generated.types.text_generation.TextGenerationInputGrammarType] = None max_new_tokens: typing.Optional[int] = None repetition_penalty: typing.Optional[float] = None return_full_text: typing.Optional[bool] = None seed: typing.Optional[int] = None stop: typing.Optional[typing.List[str]] = None temperature: typing.Optional[float] = None top_k: typing.Optional[int] = None top_n_tokens: typing.Optional[int] = None top_p: typing.Optional[float] = None truncate: typing.Optional[int] = None typical_p: typing.Optional[float] = None watermark: typing.Optional[bool] = None )

class huggingface_hub.TextGenerationInputGrammarType

< >

( type: TypeEnum value: typing.Any )

class huggingface_hub.TextGenerationOutput

< >

( generated_text: str details: typing.Optional[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputDetails] = None )

文本生成输出。从 TGI 规范自动生成。更多详情，请查看https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts。

class huggingface_hub.TextGenerationOutputBestOfSequence

< >

( finish_reason: TextGenerationOutputFinishReason generated_text: str generated_tokens: int prefill: typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputPrefillToken] tokens: typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken] seed: typing.Optional[int] = None top_tokens: typing.Optional[typing.List[typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]]] = None )

类 huggingface_hub.TextGenerationOutputDetails

< >

( finish_reason: TextGenerationOutputFinishReason generated_tokens: int prefill: typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputPrefillToken] tokens: typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken] best_of_sequences: typing.Optional[typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputBestOfSequence]] = None seed: typing.Optional[int] = None top_tokens: typing.Optional[typing.List[typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]]] = None )

类 huggingface_hub.TextGenerationOutputPrefillToken

< >

( id: int logprob: float text: str )

类 huggingface_hub.TextGenerationOutputToken

< >

( id: int logprob: float special: bool text: str )

类 huggingface_hub.TextGenerationStreamOutput

< >

( index: int token: TextGenerationStreamOutputToken details: typing.Optional[huggingface_hub.inference._generated.types.text_generation.TextGenerationStreamOutputStreamDetails] = None generated_text: typing.Optional[str] = None top_tokens: typing.Optional[typing.List[huggingface_hub.inference._generated.types.text_generation.TextGenerationStreamOutputToken]] = None )

文本生成流式输出。 从 TGI 规范自动生成。 更多详情，请查看 https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts。

类 huggingface_hub.TextGenerationStreamOutputStreamDetails

< >

( finish_reason: TextGenerationOutputFinishReason generated_tokens: int input_length: int seed: typing.Optional[int] = None )

类 huggingface_hub.TextGenerationStreamOutputToken

< >

( id: int logprob: float special: bool text: str )

text_to_audio

类 huggingface_hub.TextToAudioGenerationParameters

< >

( do_sample: typing.Optional[bool] = None early_stopping: typing.Union[bool, ForwardRef('TextToAudioEarlyStoppingEnum'), NoneType] = None epsilon_cutoff: typing.Optional[float] = None eta_cutoff: typing.Optional[float] = None max_length: typing.Optional[int] = None max_new_tokens: typing.Optional[int] = None min_length: typing.Optional[int] = None min_new_tokens: typing.Optional[int] = None num_beam_groups: typing.Optional[int] = None num_beams: typing.Optional[int] = None penalty_alpha: typing.Optional[float] = None temperature: typing.Optional[float] = None top_k: typing.Optional[int] = None top_p: typing.Optional[float] = None typical_p: typing.Optional[float] = None use_cache: typing.Optional[bool] = None )

文本生成过程的参数化

类 huggingface_hub.TextToAudioInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_to_audio.TextToAudioParameters] = None )

文本到音频推理的输入

类 huggingface_hub.TextToAudioOutput

< >

( audio: typing.Any sampling_rate: float )

文本到音频任务的推理输出

类 huggingface_hub.TextToAudioParameters

< >

( generate_kwargs: typing.Optional[huggingface_hub.inference._generated.types.text_to_audio.TextToAudioGenerationParameters] = None )

文本到音频的额外推理参数

text_to_image

类 huggingface_hub.TextToImageInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_to_image.TextToImageParameters] = None )

文本到图像推理的输入

类 huggingface_hub.TextToImageOutput

< >

( image: typing.Any )

文本到图像任务的推理输出

类 huggingface_hub.TextToImageParameters

< >

( guidance_scale: typing.Optional[float] = None height: typing.Optional[int] = None negative_prompt: typing.Optional[str] = None num_inference_steps: typing.Optional[int] = None scheduler: typing.Optional[str] = None seed: typing.Optional[int] = None width: typing.Optional[int] = None )

文本到图像的额外推理参数

text_to_speech

类 huggingface_hub.TextToSpeechGenerationParameters

< >

( do_sample: typing.Optional[bool] = None early_stopping: typing.Union[bool, ForwardRef('TextToSpeechEarlyStoppingEnum'), NoneType] = None epsilon_cutoff: typing.Optional[float] = None eta_cutoff: typing.Optional[float] = None max_length: typing.Optional[int] = None max_new_tokens: typing.Optional[int] = None min_length: typing.Optional[int] = None min_new_tokens: typing.Optional[int] = None num_beam_groups: typing.Optional[int] = None num_beams: typing.Optional[int] = None penalty_alpha: typing.Optional[float] = None temperature: typing.Optional[float] = None top_k: typing.Optional[int] = None top_p: typing.Optional[float] = None typical_p: typing.Optional[float] = None use_cache: typing.Optional[bool] = None )

文本生成过程的参数化

class huggingface_hub.TextToSpeechInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_to_speech.TextToSpeechParameters] = None )

Text To Speech inference inputs

class huggingface_hub.TextToSpeechOutput

< >

( audio: typing.Any sampling_rate: typing.Optional[float] = None )

Text To Speech 任务的推理输出

class huggingface_hub.TextToSpeechParameters

< >

( generate_kwargs: typing.Optional[huggingface_hub.inference._generated.types.text_to_speech.TextToSpeechGenerationParameters] = None )

Text To Speech 的额外推理参数

text_to_video

class huggingface_hub.TextToVideoInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.text_to_video.TextToVideoParameters] = None )

Text To Video 推理的输入

class huggingface_hub.TextToVideoOutput

< >

( video: typing.Any )

Text To Video 任务的推理输出

class huggingface_hub.TextToVideoParameters

< >

( guidance_scale: typing.Optional[float] = None negative_prompt: typing.Optional[typing.List[str]] = None num_frames: typing.Optional[float] = None num_inference_steps: typing.Optional[int] = None seed: typing.Optional[int] = None )

Text To Video 的额外推理参数

token_classification

class huggingface_hub.TokenClassificationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.token_classification.TokenClassificationParameters] = None )

Token Classification 推理的输入

class huggingface_hub.TokenClassificationOutputElement

< >

( end: int score: float start: int word: str entity: typing.Optional[str] = None entity_group: typing.Optional[str] = None )

Token Classification 任务的推理输出

class huggingface_hub.TokenClassificationParameters

< >

( aggregation_strategy: typing.Optional[ForwardRef('TokenClassificationAggregationStrategy')] = None ignore_labels: typing.Optional[typing.List[str]] = None stride: typing.Optional[int] = None )

Token Classification 的额外推理参数

translation

class huggingface_hub.TranslationInput

< >

( inputs: str parameters: typing.Optional[huggingface_hub.inference._generated.types.translation.TranslationParameters] = None )

Translation 推理的输入

class huggingface_hub.TranslationOutput

< >

( translation_text: str )

Translation 任务的推理输出

class huggingface_hub.TranslationParameters

< >

( clean_up_tokenization_spaces: typing.Optional[bool] = None generate_parameters: typing.Optional[typing.Dict[str, typing.Any]] = None src_lang: typing.Optional[str] = None tgt_lang: typing.Optional[str] = None truncation: typing.Optional[ForwardRef('TranslationTruncationStrategy')] = None )

Translation 的额外推理参数

video_classification

class huggingface_hub.VideoClassificationInput

< >

( inputs: typing.Any parameters: typing.Optional[huggingface_hub.inference._generated.types.video_classification.VideoClassificationParameters] = None )

Video Classification 推理的输入

class huggingface_hub.VideoClassificationOutputElement

< >

( label: str score: float )

Video Classification 任务的推理输出

class huggingface_hub.VideoClassificationParameters

< >

( frame_sampling_rate: typing.Optional[int] = None function_to_apply: typing.Optional[ForwardRef('VideoClassificationOutputTransform')] = None num_frames: typing.Optional[int] = None top_k: typing.Optional[int] = None )

视频分类的附加推理参数

visual_question_answering

class huggingface_hub.VisualQuestionAnsweringInput

< >

( inputs: VisualQuestionAnsweringInputData parameters: typing.Optional[huggingface_hub.inference._generated.types.visual_question_answering.VisualQuestionAnsweringParameters] = None )

视觉问答推理的输入

class huggingface_hub.VisualQuestionAnsweringInputData

< >

( image: typing.Any question: 字符串 )

一个（图像，问题）对，用于回答

class huggingface_hub.VisualQuestionAnsweringOutputElement

< >

( score: float answer: typing.Optional[str] = None )

视觉问答任务的推理输出

class huggingface_hub.VisualQuestionAnsweringParameters

< >

( top_k: typing.Optional[int] = None )

视觉问答的附加推理参数

zero_shot_classification

class huggingface_hub.ZeroShotClassificationInput

< >

( inputs: str parameters: ZeroShotClassificationParameters )

零样本分类推理的输入

class huggingface_hub.ZeroShotClassificationOutputElement

< >

( label: str score: float )

零样本分类任务的推理输出

class huggingface_hub.ZeroShotClassificationParameters

< >

( candidate_labels: typing.List[str] hypothesis_template: typing.Optional[str] = None multi_label: typing.Optional[bool] = None )

零样本分类的附加推理参数

zero_shot_image_classification

class huggingface_hub.ZeroShotImageClassificationInput

< >

( inputs: str parameters: ZeroShotImageClassificationParameters )

零样本图像分类推理的输入

class huggingface_hub.ZeroShotImageClassificationOutputElement

< >

( label: str score: float )

零样本图像分类任务的推理输出

class huggingface_hub.ZeroShotImageClassificationParameters

< >

( candidate_labels: typing.List[str] hypothesis_template: typing.Optional[str] = None )

零样本图像分类的附加推理参数

zero_shot_object_detection

class huggingface_hub.ZeroShotObjectDetectionBoundingBox

< >

( xmax: int xmin: int ymax: int ymin: int )

预测的边界框。坐标相对于输入图像的左上角。

class huggingface_hub.ZeroShotObjectDetectionInput

< >

( inputs: str parameters: ZeroShotObjectDetectionParameters )

零样本目标检测推理的输入

class huggingface_hub.ZeroShotObjectDetectionOutputElement

< >

( box: ZeroShotObjectDetectionBoundingBox label: str score: float )

零样本目标检测任务的推理输出

class huggingface_hub.ZeroShotObjectDetectionParameters

< >

( candidate_labels: typing.List[str] )

零样本目标检测的附加推理参数

< > Update on GitHub

←Mixins & serialization methods Inference Client→