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

huggingface_hub/inference/_generated/types/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 Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class QuestionAnsweringInputData(BaseInferenceType):
     """One (context, question) pair to answer"""
 
@@ -19,7 +18,7 @@ class QuestionAnsweringInputData(BaseInferenceType):
     """The question to be answered"""
 
 
-@dataclass
+@dataclass_with_extra
 class QuestionAnsweringParameters(BaseInferenceType):
     """Additional inference parameters for Question Answering"""
 
@@ -51,7 +50,7 @@ class QuestionAnsweringParameters(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class QuestionAnsweringInput(BaseInferenceType):
     """Inputs for Question Answering inference"""
 
@@ -61,7 +60,7 @@ class QuestionAnsweringInput(BaseInferenceType):
     """Additional inference parameters for Question Answering"""
 
 
-@dataclass
+@dataclass_with_extra
 class QuestionAnsweringOutputElement(BaseInferenceType):
     """Outputs of inference for the Question Answering task"""
 

huggingface_hub/inference/_generated/types/sentence_similarity.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, List, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class SentenceSimilarityInputData(BaseInferenceType):
     sentences: List[str]
     """A list of strings which will be compared against the source_sentence."""
@@ -19,7 +18,7 @@ class SentenceSimilarityInputData(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class SentenceSimilarityInput(BaseInferenceType):
     """Inputs for Sentence similarity inference"""
 

huggingface_hub/inference/_generated/types/summarization.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, Dict, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 SummarizationTruncationStrategy = Literal["do_not_truncate", "longest_first", "only_first", "only_second"]
 
 
-@dataclass
+@dataclass_with_extra
 class SummarizationParameters(BaseInferenceType):
     """Additional inference parameters for summarization."""
 
@@ -24,7 +23,7 @@ class SummarizationParameters(BaseInferenceType):
     """The truncation strategy to use."""
 
 
-@dataclass
+@dataclass_with_extra
 class SummarizationInput(BaseInferenceType):
     """Inputs for Summarization inference"""
 
@@ -34,7 +33,7 @@ class SummarizationInput(BaseInferenceType):
     """Additional inference parameters for summarization."""
 
 
-@dataclass
+@dataclass_with_extra
 class SummarizationOutput(BaseInferenceType):
     """Outputs of inference for the Summarization task"""
 

huggingface_hub/inference/_generated/types/table_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 Dict, List, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class TableQuestionAnsweringInputData(BaseInferenceType):
     """One (table, question) pair to answer"""
 
@@ -22,7 +21,7 @@ class TableQuestionAnsweringInputData(BaseInferenceType):
 Padding = Literal["do_not_pad", "longest", "max_length"]
 
 
-@dataclass
+@dataclass_with_extra
 class TableQuestionAnsweringParameters(BaseInferenceType):
     """Additional inference parameters for Table Question Answering"""
 
@@ -37,7 +36,7 @@ class TableQuestionAnsweringParameters(BaseInferenceType):
     """Activates and controls truncation."""
 
 
-@dataclass
+@dataclass_with_extra
 class TableQuestionAnsweringInput(BaseInferenceType):
     """Inputs for Table Question Answering inference"""
 
@@ -47,7 +46,7 @@ class TableQuestionAnsweringInput(BaseInferenceType):
     """Additional inference parameters for Table Question Answering"""
 
 
-@dataclass
+@dataclass_with_extra
 class TableQuestionAnsweringOutputElement(BaseInferenceType):
     """Outputs of inference for the Table Question Answering task"""
 

huggingface_hub/inference/_generated/types/text2text_generation.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, Dict, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 Text2TextGenerationTruncationStrategy = Literal["do_not_truncate", "longest_first", "only_first", "only_second"]
 
 
-@dataclass
+@dataclass_with_extra
 class Text2TextGenerationParameters(BaseInferenceType):
     """Additional inference parameters for Text2text Generation"""
 
@@ -24,7 +23,7 @@ class Text2TextGenerationParameters(BaseInferenceType):
     """The truncation strategy to use"""
 
 
-@dataclass
+@dataclass_with_extra
 class Text2TextGenerationInput(BaseInferenceType):
     """Inputs for Text2text Generation inference"""
 
@@ -34,7 +33,7 @@ class Text2TextGenerationInput(BaseInferenceType):
     """Additional inference parameters for Text2text Generation"""
 
 
-@dataclass
+@dataclass_with_extra
 class Text2TextGenerationOutput(BaseInferenceType):
     """Outputs of inference for the Text2text Generation task"""
 

huggingface_hub/inference/_generated/types/text_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
 
 
 TextClassificationOutputTransform = Literal["sigmoid", "softmax", "none"]
 
 
-@dataclass
+@dataclass_with_extra
 class TextClassificationParameters(BaseInferenceType):
     """Additional inference parameters for Text Classification"""
 
@@ -22,7 +21,7 @@ class TextClassificationParameters(BaseInferenceType):
     """When specified, limits the output to the top K most probable classes."""
 
 
-@dataclass
+@dataclass_with_extra
 class TextClassificationInput(BaseInferenceType):
     """Inputs for Text Classification inference"""
 
@@ -32,7 +31,7 @@ class TextClassificationInput(BaseInferenceType):
     """Additional inference parameters for Text Classification"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextClassificationOutputElement(BaseInferenceType):
     """Outputs of inference for the Text Classification task"""
 

huggingface_hub/inference/_generated/types/text_generation.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, List, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 TypeEnum = Literal["json", "regex"]
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationInputGrammarType(BaseInferenceType):
     type: "TypeEnum"
     value: Any
@@ -22,7 +21,7 @@ class TextGenerationInputGrammarType(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationInputGenerateParameters(BaseInferenceType):
     adapter_id: Optional[str] = None
     """Lora adapter id"""
@@ -73,7 +72,7 @@ class TextGenerationInputGenerateParameters(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationInput(BaseInferenceType):
     """Text Generation Input.
     Auto-generated from TGI specs.
@@ -89,14 +88,14 @@ class TextGenerationInput(BaseInferenceType):
 TextGenerationOutputFinishReason = Literal["length", "eos_token", "stop_sequence"]
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationOutputPrefillToken(BaseInferenceType):
     id: int
     logprob: float
     text: str
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationOutputToken(BaseInferenceType):
     id: int
     logprob: float
@@ -104,7 +103,7 @@ class TextGenerationOutputToken(BaseInferenceType):
     text: str
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationOutputBestOfSequence(BaseInferenceType):
     finish_reason: "TextGenerationOutputFinishReason"
     generated_text: str
@@ -115,7 +114,7 @@ class TextGenerationOutputBestOfSequence(BaseInferenceType):
     top_tokens: Optional[List[List[TextGenerationOutputToken]]] = None
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationOutputDetails(BaseInferenceType):
     finish_reason: "TextGenerationOutputFinishReason"
     generated_tokens: int
@@ -126,7 +125,7 @@ class TextGenerationOutputDetails(BaseInferenceType):
     top_tokens: Optional[List[List[TextGenerationOutputToken]]] = None
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationOutput(BaseInferenceType):
     """Text Generation Output.
     Auto-generated from TGI specs.
@@ -138,7 +137,7 @@ class TextGenerationOutput(BaseInferenceType):
     details: Optional[TextGenerationOutputDetails] = None
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationStreamOutputStreamDetails(BaseInferenceType):
     finish_reason: "TextGenerationOutputFinishReason"
     generated_tokens: int
@@ -146,7 +145,7 @@ class TextGenerationStreamOutputStreamDetails(BaseInferenceType):
     seed: Optional[int] = None
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationStreamOutputToken(BaseInferenceType):
     id: int
     logprob: float
@@ -154,7 +153,7 @@ class TextGenerationStreamOutputToken(BaseInferenceType):
     text: str
 
 
-@dataclass
+@dataclass_with_extra
 class TextGenerationStreamOutput(BaseInferenceType):
     """Text Generation Stream Output.
     Auto-generated from TGI specs.

huggingface_hub/inference/_generated/types/text_to_audio.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
 
 
 TextToAudioEarlyStoppingEnum = Literal["never"]
 
 
-@dataclass
+@dataclass_with_extra
 class TextToAudioGenerationParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
@@ -72,7 +71,7 @@ class TextToAudioGenerationParameters(BaseInferenceType):
     """Whether the model should use the past last key/values attentions to speed up decoding"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToAudioParameters(BaseInferenceType):
     """Additional inference parameters for Text To Audio"""
 
@@ -81,7 +80,7 @@ class TextToAudioParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToAudioInput(BaseInferenceType):
     """Inputs for Text To Audio inference"""
 
@@ -91,7 +90,7 @@ class TextToAudioInput(BaseInferenceType):
     """Additional inference parameters for Text To Audio"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToAudioOutput(BaseInferenceType):
     """Outputs of inference for the Text To Audio task"""
 

huggingface_hub/inference/_generated/types/text_to_image.py

@@ -3,21 +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
-class TextToImageTargetSize(BaseInferenceType):
-    """The size in pixel of the output image"""
-
-    height: int
-    width: int
-
-
-@dataclass
+@dataclass_with_extra
 class TextToImageParameters(BaseInferenceType):
     """Additional inference parameters for Text To Image"""
 
@@ -25,6 +16,8 @@ class TextToImageParameters(BaseInferenceType):
     """A higher guidance scale value encourages the model to generate images closely linked to
     the text prompt, but values too high may cause saturation and other artifacts.
     """
+    height: Optional[int] = None
+    """The height in pixels of the output image"""
     negative_prompt: Optional[str] = None
     """One prompt to guide what NOT to include in image generation."""
     num_inference_steps: Optional[int] = None
@@ -35,11 +28,11 @@ class TextToImageParameters(BaseInferenceType):
     """Override the scheduler with a compatible one."""
     seed: Optional[int] = None
     """Seed for the random number generator."""
-    target_size: Optional[TextToImageTargetSize] = None
-    """The size in pixel of the output image"""
+    width: Optional[int] = None
+    """The width in pixels of the output image"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToImageInput(BaseInferenceType):
     """Inputs for Text To Image inference"""
 
@@ -49,7 +42,7 @@ class TextToImageInput(BaseInferenceType):
     """Additional inference parameters for Text To Image"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToImageOutput(BaseInferenceType):
     """Outputs of inference for the Text To Image task"""
 

huggingface_hub/inference/_generated/types/text_to_speech.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
 
 
 TextToSpeechEarlyStoppingEnum = Literal["never"]
 
 
-@dataclass
+@dataclass_with_extra
 class TextToSpeechGenerationParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
@@ -72,7 +71,7 @@ class TextToSpeechGenerationParameters(BaseInferenceType):
     """Whether the model should use the past last key/values attentions to speed up decoding"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToSpeechParameters(BaseInferenceType):
     """Additional inference parameters for Text To Speech"""
 
@@ -81,7 +80,7 @@ class TextToSpeechParameters(BaseInferenceType):
     """Parametrization of the text generation process"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToSpeechInput(BaseInferenceType):
     """Inputs for Text To Speech inference"""
 
@@ -91,7 +90,7 @@ class TextToSpeechInput(BaseInferenceType):
     """Additional inference parameters for Text To Speech"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToSpeechOutput(BaseInferenceType):
     """Outputs of inference for the Text To Speech task"""
 

huggingface_hub/inference/_generated/types/text_to_video.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 TextToVideoParameters(BaseInferenceType):
     """Additional inference parameters for Text To Video"""
 
@@ -29,7 +28,7 @@ class TextToVideoParameters(BaseInferenceType):
     """Seed for the random number generator."""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToVideoInput(BaseInferenceType):
     """Inputs for Text To Video inference"""
 
@@ -39,7 +38,7 @@ class TextToVideoInput(BaseInferenceType):
     """Additional inference parameters for Text To Video"""
 
 
-@dataclass
+@dataclass_with_extra
 class TextToVideoOutput(BaseInferenceType):
     """Outputs of inference for the Text To Video task"""
 

huggingface_hub/inference/_generated/types/token_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 List, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 TokenClassificationAggregationStrategy = Literal["none", "simple", "first", "average", "max"]
 
 
-@dataclass
+@dataclass_with_extra
 class TokenClassificationParameters(BaseInferenceType):
     """Additional inference parameters for Token Classification"""
 
@@ -24,7 +23,7 @@ class TokenClassificationParameters(BaseInferenceType):
     """The number of overlapping tokens between chunks when splitting the input text."""
 
 
-@dataclass
+@dataclass_with_extra
 class TokenClassificationInput(BaseInferenceType):
     """Inputs for Token Classification inference"""
 
@@ -34,7 +33,7 @@ class TokenClassificationInput(BaseInferenceType):
     """Additional inference parameters for Token Classification"""
 
 
-@dataclass
+@dataclass_with_extra
 class TokenClassificationOutputElement(BaseInferenceType):
     """Outputs of inference for the Token Classification task"""
 

huggingface_hub/inference/_generated/types/translation.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, Dict, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 TranslationTruncationStrategy = Literal["do_not_truncate", "longest_first", "only_first", "only_second"]
 
 
-@dataclass
+@dataclass_with_extra
 class TranslationParameters(BaseInferenceType):
     """Additional inference parameters for Translation"""
 
@@ -32,7 +31,7 @@ class TranslationParameters(BaseInferenceType):
     """The truncation strategy to use."""
 
 
-@dataclass
+@dataclass_with_extra
 class TranslationInput(BaseInferenceType):
     """Inputs for Translation inference"""
 
@@ -42,7 +41,7 @@ class TranslationInput(BaseInferenceType):
     """Additional inference parameters for Translation"""
 
 
-@dataclass
+@dataclass_with_extra
 class TranslationOutput(BaseInferenceType):
     """Outputs of inference for the Translation task"""
 

huggingface_hub/inference/_generated/types/video_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 Any, Literal, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
 VideoClassificationOutputTransform = Literal["sigmoid", "softmax", "none"]
 
 
-@dataclass
+@dataclass_with_extra
 class VideoClassificationParameters(BaseInferenceType):
     """Additional inference parameters for Video Classification"""
 
@@ -26,7 +25,7 @@ class VideoClassificationParameters(BaseInferenceType):
     """When specified, limits the output to the top K most probable classes."""
 
 
-@dataclass
+@dataclass_with_extra
 class VideoClassificationInput(BaseInferenceType):
     """Inputs for Video Classification inference"""
 
@@ -36,7 +35,7 @@ class VideoClassificationInput(BaseInferenceType):
     """Additional inference parameters for Video Classification"""
 
 
-@dataclass
+@dataclass_with_extra
 class VideoClassificationOutputElement(BaseInferenceType):
     """Outputs of inference for the Video Classification task"""
 

huggingface_hub/inference/_generated/types/visual_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, Optional
 
-from .base import BaseInferenceType
+from .base import BaseInferenceType, dataclass_with_extra
 
 
-@dataclass
+@dataclass_with_extra
 class VisualQuestionAnsweringInputData(BaseInferenceType):
     """One (image, question) pair to answer"""
 
@@ -19,7 +18,7 @@ class VisualQuestionAnsweringInputData(BaseInferenceType):
     """The question to answer based on the image."""
 
 
-@dataclass
+@dataclass_with_extra
 class VisualQuestionAnsweringParameters(BaseInferenceType):
     """Additional inference parameters for Visual Question Answering"""
 
@@ -30,7 +29,7 @@ class VisualQuestionAnsweringParameters(BaseInferenceType):
     """
 
 
-@dataclass
+@dataclass_with_extra
 class VisualQuestionAnsweringInput(BaseInferenceType):
     """Inputs for Visual Question Answering inference"""
 
@@ -40,7 +39,7 @@ class VisualQuestionAnsweringInput(BaseInferenceType):
     """Additional inference parameters for Visual Question Answering"""
 
 
-@dataclass
+@dataclass_with_extra
 class VisualQuestionAnsweringOutputElement(BaseInferenceType):
     """Outputs of inference for the Visual Question Answering task"""