huggingface-hub 0.28.1__py3-none-any.whl → 0.29.0rc0__py3-none-any.whl

huggingface_hub/inference/_generated/types/automatic_speech_recognition.py

@@ -3,16 +3,15 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import List, Literal, Optional, Union
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 AutomaticSpeechRecognitionEarlyStoppingEnum = Literal["never"]
 
 
-@dataclass
+@dataclass_with_extra
 class AutomaticSpeechRecognitionGenerationParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
@@ -72,7 +71,7 @@ class AutomaticSpeechRecognitionGenerationParameters(BaseInferenceType):
     """Whether the model should use the past last key/values attentions to speed up decoding"""
 
 
-@dataclass
+@dataclass_with_extra
 class AutomaticSpeechRecognitionParameters(BaseInferenceType):
     """Additional inference parameters for Automatic Speech Recognition"""
 
@@ -83,7 +82,7 @@ class AutomaticSpeechRecognitionParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
 
-@dataclass
+@dataclass_with_extra
 class AutomaticSpeechRecognitionInput(BaseInferenceType):
     """Inputs for Automatic Speech Recognition inference"""
 
@@ -95,15 +94,15 @@ class AutomaticSpeechRecognitionInput(BaseInferenceType):
     """Additional inference parameters for Automatic Speech Recognition"""
 
 
-@dataclass
+@dataclass_with_extra
 class AutomaticSpeechRecognitionOutputChunk(BaseInferenceType):
     text: str
     """A chunk of text identified by the model"""
-    timestamps: List[float]
+    timestamp: List[float]
     """The start and end timestamps corresponding with the text"""
 
 
-@dataclass
+@dataclass_with_extra
 class AutomaticSpeechRecognitionOutput(BaseInferenceType):
     """Outputs of inference for the Automatic Speech Recognition task"""
 

huggingface_hub/inference/_generated/types/base.py

@@ -22,6 +22,22 @@ from typing import Any, Dict, List, Type, TypeVar, Union, get_args
 T = TypeVar("T", bound="BaseInferenceType")
 
 
+def _repr_with_extra(self):
+    fields = list(self.__dataclass_fields__.keys())
+    other_fields = list(k for k in self.__dict__ if k not in fields)
+    return f"{self.__class__.__name__}({', '.join(f'{k}={self.__dict__[k]!r}' for k in fields + other_fields)})"
+
+
+def dataclass_with_extra(cls: Type[T]) -> Type[T]:
+    """Decorator to add a custom __repr__ method to a dataclass, showing all fields, including extra ones.
+
+    This decorator only works with dataclasses that inherit from `BaseInferenceType`.
+    """
+    cls = dataclass(cls)
+    cls.__repr__ = _repr_with_extra  # type: ignore[method-assign]
+    return cls
+
+
 @dataclass
 class BaseInferenceType(dict):
     """Base class for all inference types.
@@ -115,6 +131,11 @@ class BaseInferenceType(dict):
 
         # Add remaining fields as dict attributes
         item.update(other_values)
+
+        # Add remaining fields as extra dataclass fields.
+        # They won't be part of the dataclass fields but will be accessible as attributes.
+        # Use @dataclass_with_extra to show them in __repr__.
+        item.__dict__.update(other_values)
         return item
 
     def __post_init__(self):

huggingface_hub/inference/_generated/types/chat_completion.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, List, Literal, Optional, Union
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputURL(BaseInferenceType):
     url: str
 
@@ -17,14 +16,14 @@ class ChatCompletionInputURL(BaseInferenceType):
 ChatCompletionInputMessageChunkType = Literal["text", "image_url"]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputMessageChunk(BaseInferenceType):
     type: "ChatCompletionInputMessageChunkType"
     image_url: Optional[ChatCompletionInputURL] = None
     text: Optional[str] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputMessage(BaseInferenceType):
     content: Union[List[ChatCompletionInputMessageChunk], str]
     role: str
@@ -34,7 +33,7 @@ class ChatCompletionInputMessage(BaseInferenceType):
 ChatCompletionInputGrammarTypeType = Literal["json", "regex"]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputGrammarType(BaseInferenceType):
     type: "ChatCompletionInputGrammarTypeType"
     value: Any
@@ -44,7 +43,7 @@ class ChatCompletionInputGrammarType(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputStreamOptions(BaseInferenceType):
     include_usage: bool
     """If set, an additional chunk will be streamed before the data: [DONE] message. The usage
@@ -54,12 +53,12 @@ class ChatCompletionInputStreamOptions(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputFunctionName(BaseInferenceType):
     name: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputToolChoiceClass(BaseInferenceType):
     function: ChatCompletionInputFunctionName
 
@@ -67,20 +66,20 @@ class ChatCompletionInputToolChoiceClass(BaseInferenceType):
 ChatCompletionInputToolChoiceEnum = Literal["auto", "none", "required"]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputFunctionDefinition(BaseInferenceType):
     arguments: Any
     name: str
     description: Optional[str] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInputTool(BaseInferenceType):
     function: ChatCompletionInputFunctionDefinition
     type: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionInput(BaseInferenceType):
     """Chat Completion Input.
     Auto-generated from TGI specs.
@@ -162,46 +161,46 @@ class ChatCompletionInput(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputTopLogprob(BaseInferenceType):
     logprob: float
     token: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputLogprob(BaseInferenceType):
     logprob: float
     token: str
     top_logprobs: List[ChatCompletionOutputTopLogprob]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputLogprobs(BaseInferenceType):
     content: List[ChatCompletionOutputLogprob]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputFunctionDefinition(BaseInferenceType):
     arguments: Any
     name: str
     description: Optional[str] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputToolCall(BaseInferenceType):
     function: ChatCompletionOutputFunctionDefinition
     id: str
     type: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputMessage(BaseInferenceType):
     role: str
     content: Optional[str] = None
     tool_calls: Optional[List[ChatCompletionOutputToolCall]] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputComplete(BaseInferenceType):
     finish_reason: str
     index: int
@@ -209,14 +208,14 @@ class ChatCompletionOutputComplete(BaseInferenceType):
     logprobs: Optional[ChatCompletionOutputLogprobs] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutputUsage(BaseInferenceType):
     completion_tokens: int
     prompt_tokens: int
     total_tokens: int
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionOutput(BaseInferenceType):
     """Chat Completion Output.
     Auto-generated from TGI specs.
@@ -232,13 +231,13 @@ class ChatCompletionOutput(BaseInferenceType):
     usage: ChatCompletionOutputUsage
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputFunction(BaseInferenceType):
     arguments: str
     name: Optional[str] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputDeltaToolCall(BaseInferenceType):
     function: ChatCompletionStreamOutputFunction
     id: str
@@ -246,32 +245,32 @@ class ChatCompletionStreamOutputDeltaToolCall(BaseInferenceType):
     type: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputDelta(BaseInferenceType):
     role: str
     content: Optional[str] = None
     tool_calls: Optional[ChatCompletionStreamOutputDeltaToolCall] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputTopLogprob(BaseInferenceType):
     logprob: float
     token: str
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputLogprob(BaseInferenceType):
     logprob: float
     token: str
     top_logprobs: List[ChatCompletionStreamOutputTopLogprob]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputLogprobs(BaseInferenceType):
     content: List[ChatCompletionStreamOutputLogprob]
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputChoice(BaseInferenceType):
     delta: ChatCompletionStreamOutputDelta
     index: int
@@ -279,14 +278,14 @@ class ChatCompletionStreamOutputChoice(BaseInferenceType):
     logprobs: Optional[ChatCompletionStreamOutputLogprobs] = None
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutputUsage(BaseInferenceType):
     completion_tokens: int
     prompt_tokens: int
     total_tokens: int
 
 
-@dataclass
+@dataclass_with_extra
 class ChatCompletionStreamOutput(BaseInferenceType):
     """Chat Completion Stream Output.
     Auto-generated from TGI specs.

huggingface_hub/inference/_generated/types/depth_estimation.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, Dict, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class DepthEstimationInput(BaseInferenceType):
     """Inputs for Depth Estimation inference"""
 
@@ -19,7 +18,7 @@ class DepthEstimationInput(BaseInferenceType):
     """Additional inference parameters for Depth Estimation"""
 
 
-@dataclass
+@dataclass_with_extra
 class DepthEstimationOutput(BaseInferenceType):
     """Outputs of inference for the Depth Estimation task"""
 

huggingface_hub/inference/_generated/types/document_question_answering.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, List, Optional, Union
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class DocumentQuestionAnsweringInputData(BaseInferenceType):
     """One (document, question) pair to answer"""
 
@@ -19,7 +18,7 @@ class DocumentQuestionAnsweringInputData(BaseInferenceType):
     """A question to ask of the document"""
 
 
-@dataclass
+@dataclass_with_extra
 class DocumentQuestionAnsweringParameters(BaseInferenceType):
     """Additional inference parameters for Document Question Answering"""
 
@@ -53,7 +52,7 @@ class DocumentQuestionAnsweringParameters(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class DocumentQuestionAnsweringInput(BaseInferenceType):
     """Inputs for Document Question Answering inference"""
 
@@ -63,7 +62,7 @@ class DocumentQuestionAnsweringInput(BaseInferenceType):
     """Additional inference parameters for Document Question Answering"""
 
 
-@dataclass
+@dataclass_with_extra
 class DocumentQuestionAnsweringOutputElement(BaseInferenceType):
     """Outputs of inference for the Document Question Answering task"""
 

huggingface_hub/inference/_generated/types/feature_extraction.py

@@ -3,16 +3,15 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
-from typing import Literal, Optional
+from typing import List, Literal, Optional, Union
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 FeatureExtractionInputTruncationDirection = Literal["Left", "Right"]
 
 
-@dataclass
+@dataclass_with_extra
 class FeatureExtractionInput(BaseInferenceType):
     """Feature Extraction Input.
     Auto-generated from TEI specs.
@@ -20,8 +19,8 @@ class FeatureExtractionInput(BaseInferenceType):
     https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tei-import.ts.
     """
 
-    inputs: str
-    """The text to embed."""
+    inputs: Union[List[str], str]
+    """The text or list of texts to embed."""
     normalize: Optional[bool] = None
     prompt_name: Optional[str] = None
     """The name of the prompt that should be used by for encoding. If not set, no prompt

huggingface_hub/inference/_generated/types/fill_mask.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, List, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class FillMaskParameters(BaseInferenceType):
     """Additional inference parameters for Fill Mask"""
 
@@ -23,7 +22,7 @@ class FillMaskParameters(BaseInferenceType):
     """When passed, overrides the number of predictions to return."""
 
 
-@dataclass
+@dataclass_with_extra
 class FillMaskInput(BaseInferenceType):
     """Inputs for Fill Mask inference"""
 
@@ -33,7 +32,7 @@ class FillMaskInput(BaseInferenceType):
     """Additional inference parameters for Fill Mask"""
 
 
-@dataclass
+@dataclass_with_extra
 class FillMaskOutputElement(BaseInferenceType):
     """Outputs of inference for the Fill Mask task"""
 

huggingface_hub/inference/_generated/types/image_classification.py

@@ -3,16 +3,15 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 ImageClassificationOutputTransform = Literal["sigmoid", "softmax", "none"]
 
 
-@dataclass
+@dataclass_with_extra
 class ImageClassificationParameters(BaseInferenceType):
     """Additional inference parameters for Image Classification"""
 
@@ -22,7 +21,7 @@ class ImageClassificationParameters(BaseInferenceType):
     """When specified, limits the output to the top K most probable classes."""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageClassificationInput(BaseInferenceType):
     """Inputs for Image Classification inference"""
 
@@ -34,7 +33,7 @@ class ImageClassificationInput(BaseInferenceType):
     """Additional inference parameters for Image Classification"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageClassificationOutputElement(BaseInferenceType):
     """Outputs of inference for the Image Classification task"""
 

huggingface_hub/inference/_generated/types/image_segmentation.py

@@ -3,16 +3,15 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 ImageSegmentationSubtask = Literal["instance", "panoptic", "semantic"]
 
 
-@dataclass
+@dataclass_with_extra
 class ImageSegmentationParameters(BaseInferenceType):
     """Additional inference parameters for Image Segmentation"""
 
@@ -26,7 +25,7 @@ class ImageSegmentationParameters(BaseInferenceType):
     """Probability threshold to filter out predicted masks."""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageSegmentationInput(BaseInferenceType):
     """Inputs for Image Segmentation inference"""
 
@@ -38,7 +37,7 @@ class ImageSegmentationInput(BaseInferenceType):
     """Additional inference parameters for Image Segmentation"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageSegmentationOutputElement(BaseInferenceType):
     """Outputs of inference for the Image Segmentation task
     A predicted mask / segment

huggingface_hub/inference/_generated/types/image_to_image.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToImageTargetSize(BaseInferenceType):
     """The size in pixel of the output image."""
 
@@ -17,7 +16,7 @@ class ImageToImageTargetSize(BaseInferenceType):
     width: int
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToImageParameters(BaseInferenceType):
     """Additional inference parameters for Image To Image"""
 
@@ -35,7 +34,7 @@ class ImageToImageParameters(BaseInferenceType):
     """The size in pixel of the output image."""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToImageInput(BaseInferenceType):
     """Inputs for Image To Image inference"""
 
@@ -47,7 +46,7 @@ class ImageToImageInput(BaseInferenceType):
     """Additional inference parameters for Image To Image"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToImageOutput(BaseInferenceType):
     """Outputs of inference for the Image To Image task"""
 

huggingface_hub/inference/_generated/types/image_to_text.py

@@ -3,16 +3,15 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Any, Literal, Optional, Union
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 ImageToTextEarlyStoppingEnum = Literal["never"]
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToTextGenerationParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
@@ -72,7 +71,7 @@ class ImageToTextGenerationParameters(BaseInferenceType):
     """Whether the model should use the past last key/values attentions to speed up decoding"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToTextParameters(BaseInferenceType):
     """Additional inference parameters for Image To Text"""
 
@@ -83,7 +82,7 @@ class ImageToTextParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToTextInput(BaseInferenceType):
     """Inputs for Image To Text inference"""
 
@@ -93,7 +92,7 @@ class ImageToTextInput(BaseInferenceType):
     """Additional inference parameters for Image To Text"""
 
 
-@dataclass
+@dataclass_with_extra
 class ImageToTextOutput(BaseInferenceType):
     """Outputs of inference for the Image To Text task"""
 

huggingface_hub/inference/_generated/types/object_detection.py

@@ -3,13 +3,12 @@
 # See:
 #   - script: https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-codegen.ts
 #   - specs:  https://github.com/huggingface/huggingface.js/tree/main/packages/tasks/src/tasks.
-from dataclasses import dataclass
 from typing import Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class ObjectDetectionParameters(BaseInferenceType):
     """Additional inference parameters for Object Detection"""
 
@@ -17,7 +16,7 @@ class ObjectDetectionParameters(BaseInferenceType):
     """The probability necessary to make a prediction."""
 
 
-@dataclass
+@dataclass_with_extra
 class ObjectDetectionInput(BaseInferenceType):
     """Inputs for Object Detection inference"""
 
@@ -29,7 +28,7 @@ class ObjectDetectionInput(BaseInferenceType):
     """Additional inference parameters for Object Detection"""
 
 
-@dataclass
+@dataclass_with_extra
 class ObjectDetectionBoundingBox(BaseInferenceType):
     """The predicted bounding box. Coordinates are relative to the top left corner of the input
     image.
@@ -45,7 +44,7 @@ class ObjectDetectionBoundingBox(BaseInferenceType):
     """The y-coordinate of the top-left corner of the bounding box."""
 
 
-@dataclass
+@dataclass_with_extra
 class ObjectDetectionOutputElement(BaseInferenceType):
     """Outputs of inference for the Object Detection task"""