huggingface-hub 0.26.3__py3-none-any.whl → 0.27.0rc1__py3-none-any.whl

huggingface_hub/inference/_generated/types/text_to_speech.py

@@ -14,9 +14,7 @@ TextToSpeechEarlyStoppingEnum = Literal["never"]
 
 @dataclass
 class TextToSpeechGenerationParameters(BaseInferenceType):
-    """Parametrization of the text generation process
-    Ad-hoc parametrization of the text generation process
-    """
+    """Parametrization of the text generation process"""
 
     do_sample: Optional[bool] = None
     """Whether to use sampling instead of greedy decoding when generating new tokens."""
@@ -40,11 +38,11 @@ class TextToSpeechGenerationParameters(BaseInferenceType):
     max_length: Optional[int] = None
     """The maximum length (in tokens) of the generated text, including the input."""
     max_new_tokens: Optional[int] = None
-    """The maximum number of tokens to generate. Takes precedence over maxLength."""
+    """The maximum number of tokens to generate. Takes precedence over max_length."""
     min_length: Optional[int] = None
     """The minimum length (in tokens) of the generated text, including the input."""
     min_new_tokens: Optional[int] = None
-    """The minimum number of tokens to generate. Takes precedence over maxLength."""
+    """The minimum number of tokens to generate. Takes precedence over min_length."""
     num_beam_groups: Optional[int] = None
     """Number of groups to divide num_beams into in order to ensure diversity among different
     groups of beams. See [this paper](https://hf.co/papers/1610.02424) for more details.
@@ -76,11 +74,10 @@ class TextToSpeechGenerationParameters(BaseInferenceType):
 
 @dataclass
 class TextToSpeechParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Text To Speech
-    """
+    """Additional inference parameters for Text To Speech"""
 
-    generate: Optional[TextToSpeechGenerationParameters] = None
+    # Will be deprecated in the future when the renaming to `generation_parameters` is implemented in transformers
+    generate_kwargs: Optional[TextToSpeechGenerationParameters] = None
     """Parametrization of the text generation process"""
 
 
@@ -91,7 +88,7 @@ class TextToSpeechInput(BaseInferenceType):
     inputs: str
     """The input text data"""
     parameters: Optional[TextToSpeechParameters] = None
-    """Additional inference parameters"""
+    """Additional inference parameters for Text To Speech"""
 
 
 @dataclass

huggingface_hub/inference/_generated/types/token_classification.py

@@ -4,7 +4,7 @@
 #   - 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 typing import List, Literal, Optional
 
 from .base import BaseInferenceType
 
@@ -14,9 +14,7 @@ TokenClassificationAggregationStrategy = Literal["none", "simple", "first", "ave
 
 @dataclass
 class TokenClassificationParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Token Classification
-    """
+    """Additional inference parameters for Token Classification"""
 
     aggregation_strategy: Optional["TokenClassificationAggregationStrategy"] = None
     """The strategy used to fuse tokens based on model predictions"""
@@ -33,21 +31,22 @@ class TokenClassificationInput(BaseInferenceType):
     inputs: str
     """The input text data"""
     parameters: Optional[TokenClassificationParameters] = None
-    """Additional inference parameters"""
+    """Additional inference parameters for Token Classification"""
 
 
 @dataclass
 class TokenClassificationOutputElement(BaseInferenceType):
     """Outputs of inference for the Token Classification task"""
 
-    label: Any
+    end: int
+    """The character position in the input where this group ends."""
     score: float
     """The associated score / probability"""
-    end: Optional[int] = None
-    """The character position in the input where this group ends."""
-    entity_group: Optional[str] = None
-    """The predicted label for that group of tokens"""
-    start: Optional[int] = None
+    start: int
     """The character position in the input where this group begins."""
-    word: Optional[str] = None
+    word: str
     """The corresponding text"""
+    entity: Optional[str] = None
+    """The predicted label for a single token"""
+    entity_group: Optional[str] = None
+    """The predicted label for a group of one or more tokens"""

huggingface_hub/inference/_generated/types/translation.py

@@ -14,9 +14,7 @@ TranslationTruncationStrategy = Literal["do_not_truncate", "longest_first", "onl
 
 @dataclass
 class TranslationParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Translation
-    """
+    """Additional inference parameters for Translation"""
 
     clean_up_tokenization_spaces: Optional[bool] = None
     """Whether to clean up the potential extra spaces in the text output."""
@@ -41,7 +39,7 @@ class TranslationInput(BaseInferenceType):
     inputs: str
     """The text to translate."""
     parameters: Optional[TranslationParameters] = None
-    """Additional inference parameters"""
+    """Additional inference parameters for Translation"""
 
 
 @dataclass

huggingface_hub/inference/_generated/types/video_classification.py

@@ -14,13 +14,12 @@ VideoClassificationOutputTransform = Literal["sigmoid", "softmax", "none"]
 
 @dataclass
 class VideoClassificationParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Video Classification
-    """
+    """Additional inference parameters for Video Classification"""
 
     frame_sampling_rate: Optional[int] = None
     """The sampling rate used to select frames from the video."""
     function_to_apply: Optional["VideoClassificationOutputTransform"] = None
+    """The function to apply to the model outputs in order to retrieve the scores."""
     num_frames: Optional[int] = None
     """The number of sampled frames to consider for classification."""
     top_k: Optional[int] = None
@@ -34,7 +33,7 @@ class VideoClassificationInput(BaseInferenceType):
     inputs: Any
     """The input video data"""
     parameters: Optional[VideoClassificationParameters] = None
-    """Additional inference parameters"""
+    """Additional inference parameters for Video Classification"""
 
 
 @dataclass

huggingface_hub/inference/_generated/types/visual_question_answering.py

@@ -21,9 +21,7 @@ class VisualQuestionAnsweringInputData(BaseInferenceType):
 
 @dataclass
 class VisualQuestionAnsweringParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Visual Question Answering
-    """
+    """Additional inference parameters for Visual Question Answering"""
 
     top_k: Optional[int] = None
     """The number of answers to return (will be chosen by order of likelihood). Note that we
@@ -39,14 +37,13 @@ class VisualQuestionAnsweringInput(BaseInferenceType):
     inputs: VisualQuestionAnsweringInputData
     """One (image, question) pair to answer"""
     parameters: Optional[VisualQuestionAnsweringParameters] = None
-    """Additional inference parameters"""
+    """Additional inference parameters for Visual Question Answering"""
 
 
 @dataclass
 class VisualQuestionAnsweringOutputElement(BaseInferenceType):
     """Outputs of inference for the Visual Question Answering task"""
 
-    label: Any
     score: float
     """The associated score / probability"""
     answer: Optional[str] = None

huggingface_hub/inference/_generated/types/zero_shot_classification.py

@@ -10,24 +10,14 @@ from .base import BaseInferenceType
 
 
 @dataclass
-class ZeroShotClassificationInputData(BaseInferenceType):
-    """The input text data, with candidate labels"""
+class ZeroShotClassificationParameters(BaseInferenceType):
+    """Additional inference parameters for Zero Shot Classification"""
 
     candidate_labels: List[str]
     """The set of possible class labels to classify the text into."""
-    text: str
-    """The text to classify"""
-
-
-@dataclass
-class ZeroShotClassificationParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Zero Shot Classification
-    """
-
     hypothesis_template: Optional[str] = None
-    """The sentence used in conjunction with candidateLabels to attempt the text classification
-    by replacing the placeholder with the candidate labels.
+    """The sentence used in conjunction with `candidate_labels` to attempt the text
+    classification by replacing the placeholder with the candidate labels.
     """
     multi_label: Optional[bool] = None
     """Whether multiple candidate labels can be true. If false, the scores are normalized such
@@ -40,10 +30,10 @@ class ZeroShotClassificationParameters(BaseInferenceType):
 class ZeroShotClassificationInput(BaseInferenceType):
     """Inputs for Zero Shot Classification inference"""
 
-    inputs: ZeroShotClassificationInputData
-    """The input text data, with candidate labels"""
-    parameters: Optional[ZeroShotClassificationParameters] = None
-    """Additional inference parameters"""
+    inputs: str
+    """The text to classify"""
+    parameters: ZeroShotClassificationParameters
+    """Additional inference parameters for Zero Shot Classification"""
 
 
 @dataclass

huggingface_hub/inference/_generated/types/zero_shot_image_classification.py

@@ -4,30 +4,20 @@
 #   - 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 typing import List, Optional
 
 from .base import BaseInferenceType
 
 
 @dataclass
-class ZeroShotImageClassificationInputData(BaseInferenceType):
-    """The input image data, with candidate labels"""
+class ZeroShotImageClassificationParameters(BaseInferenceType):
+    """Additional inference parameters for Zero Shot Image Classification"""
 
     candidate_labels: List[str]
     """The candidate labels for this image"""
-    image: Any
-    """The image data to classify"""
-
-
-@dataclass
-class ZeroShotImageClassificationParameters(BaseInferenceType):
-    """Additional inference parameters
-    Additional inference parameters for Zero Shot Image Classification
-    """
-
     hypothesis_template: Optional[str] = None
-    """The sentence used in conjunction with candidateLabels to attempt the text classification
-    by replacing the placeholder with the candidate labels.
+    """The sentence used in conjunction with `candidate_labels` to attempt the image
+    classification by replacing the placeholder with the candidate labels.
     """
 
 
@@ -35,10 +25,10 @@ class ZeroShotImageClassificationParameters(BaseInferenceType):
 class ZeroShotImageClassificationInput(BaseInferenceType):
     """Inputs for Zero Shot Image Classification inference"""
 
-    inputs: ZeroShotImageClassificationInputData
-    """The input image data, with candidate labels"""
-    parameters: Optional[ZeroShotImageClassificationParameters] = None
-    """Additional inference parameters"""
+    inputs: str
+    """The input image data to classify as a base64-encoded string."""
+    parameters: ZeroShotImageClassificationParameters
+    """Additional inference parameters for Zero Shot Image Classification"""
 
 
 @dataclass

huggingface_hub/inference/_generated/types/zero_shot_object_detection.py

@@ -4,29 +4,27 @@
 #   - 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 typing import List
 
 from .base import BaseInferenceType
 
 
 @dataclass
-class ZeroShotObjectDetectionInputData(BaseInferenceType):
-    """The input image data, with candidate labels"""
+class ZeroShotObjectDetectionParameters(BaseInferenceType):
+    """Additional inference parameters for Zero Shot Object Detection"""
 
     candidate_labels: List[str]
     """The candidate labels for this image"""
-    image: Any
-    """The image data to generate bounding boxes from"""
 
 
 @dataclass
 class ZeroShotObjectDetectionInput(BaseInferenceType):
     """Inputs for Zero Shot Object Detection inference"""
 
-    inputs: ZeroShotObjectDetectionInputData
-    """The input image data, with candidate labels"""
-    parameters: Optional[Dict[str, Any]] = None
-    """Additional inference parameters"""
+    inputs: str
+    """The input image data as a base64-encoded string."""
+    parameters: ZeroShotObjectDetectionParameters
+    """Additional inference parameters for Zero Shot Object Detection"""
 
 
 @dataclass

huggingface_hub/keras_mixin.py

@@ -301,7 +301,7 @@ def push_to_hub_keras(
     *,
     config: Optional[dict] = None,
     commit_message: str = "Push Keras model using huggingface_hub.",
-    private: bool = False,
+    private: Optional[bool] = None,
     api_endpoint: Optional[str] = None,
     token: Optional[str] = None,
     branch: Optional[str] = None,
@@ -330,8 +330,9 @@ def push_to_hub_keras(
                 ID of the repository to push to (example: `"username/my-model"`).
         commit_message (`str`, *optional*, defaults to "Add Keras model"):
             Message to commit while pushing.
-        private (`bool`, *optional*, defaults to `False`):
+        private (`bool`, *optional*):
             Whether the repository created should be private.
+            If `None` (default), the repo will be public unless the organization's default is private.
         api_endpoint (`str`, *optional*):
             The API endpoint to use when pushing the model to the hub.
         token (`str`, *optional*):

huggingface_hub/lfs.py

@@ -39,6 +39,7 @@ from .utils import (
 )
 from .utils._lfs import SliceFileObj
 from .utils.sha import sha256, sha_fileobj
+from .utils.tqdm import is_tqdm_disabled
 
 
 if TYPE_CHECKING:
@@ -430,17 +431,13 @@ def _upload_parts_hf_transfer(
     if len(desc) > 40:
         desc = f"(…){desc[-40:]}"
 
-    # set `disable=None` rather than `disable=False` by default to disable progress bar when no TTY attached
-    # see https://github.com/huggingface/huggingface_hub/pull/2000
-    disable = True if (logger.getEffectiveLevel() == logging.NOTSET) else None
-
     with tqdm(
         unit="B",
         unit_scale=True,
         total=total,
         initial=0,
         desc=desc,
-        disable=disable,
+        disable=is_tqdm_disabled(logger.getEffectiveLevel()),
         name="huggingface_hub.lfs_upload",
     ) as progress:
         try:

huggingface_hub/repocard_data.py

@@ -185,7 +185,7 @@ class CardData:
 
         data_dict = copy.deepcopy(self.__dict__)
         self._to_dict(data_dict)
-        return _remove_none(data_dict)
+        return {key: value for key, value in data_dict.items() if value is not None}
 
     def _to_dict(self, data_dict):
         """Use this method in child classes to alter the dict representation of the data. Alter the dict in-place.
@@ -252,8 +252,8 @@ class ModelCardData(CardData):
             The identifier of the base model from which the model derives. This is applicable for example if your model is a
             fine-tune or adapter of an existing model. The value must be the ID of a model on the Hub (or a list of IDs
             if your model derives from multiple models). Defaults to None.
-        datasets (`List[str]`, *optional*):
-            List of datasets that were used to train this model. Should be a dataset ID
+        datasets (`Union[str, List[str]]`, *optional*):
+            Dataset or list of datasets that were used to train this model. Should be a dataset ID
             found on https://hf.co/datasets. Defaults to None.
         eval_results (`Union[List[EvalResult], EvalResult]`, *optional*):
             List of `huggingface_hub.EvalResult` that define evaluation results of the model. If provided,
@@ -312,7 +312,7 @@ class ModelCardData(CardData):
         self,
         *,
         base_model: Optional[Union[str, List[str]]] = None,
-        datasets: Optional[List[str]] = None,
+        datasets: Optional[Union[str, List[str]]] = None,
         eval_results: Optional[List[EvalResult]] = None,
         language: Optional[Union[str, List[str]]] = None,
         library_name: Optional[str] = None,

huggingface_hub/serialization/__init__.py

@@ -19,6 +19,8 @@ from ._tensorflow import get_tf_storage_size, split_tf_state_dict_into_shards
 from ._torch import (
     get_torch_storage_id,
     get_torch_storage_size,
+    load_state_dict_from_file,
+    load_torch_model,
     save_torch_model,
     save_torch_state_dict,
     split_torch_state_dict_into_shards,