Skip to content

[Inference Client] Add task parameters and a maintenance script of these parameters #2561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hanouticelina merged 18 commits into from
Oct 9, 2024
Merged

[Inference Client] Add task parameters and a maintenance script of these parameters #2561

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
79b4b40
Add additional parameters to Inference Client tasks
hanouticelina Sep 24, 2024
27faa3d
Add and run task params generation script
hanouticelina Sep 25, 2024
4200f94
Add back missing test
hanouticelina Sep 25, 2024
8f1b89e
Add comments to parameters generation script
hanouticelina Sep 26, 2024
aa8abc0
Merge branch 'main' into align-inference-inputs-with-specs
hanouticelina Sep 26, 2024
4fd4aba
Fix shared classes imports + text-to-speech task
hanouticelina Sep 27, 2024
e91e920
Satisfy end-of-file-fixer hook
hanouticelina Sep 27, 2024
65cec00
Move helper function to avoid duplicates across scripts
hanouticelina Sep 27, 2024
72302ae
Rename helper function for more clarity
hanouticelina Sep 27, 2024
0c58003
Fix bug in node traversing
hanouticelina Oct 1, 2024
9a6af4b
Add comments
hanouticelina Oct 1, 2024
aea264e
improve docstring formatting
hanouticelina Oct 1, 2024
2d69e75
fixes post-review
hanouticelina Oct 4, 2024
646fbee
Merge branch 'main' of github.com:huggingface/huggingface_hub into al…
hanouticelina Oct 4, 2024
c2ee477
Remove aliases from reference package
hanouticelina Oct 9, 2024
80f3bcf
Merge branch 'main' into align-inference-inputs-with-specs
hanouticelina Oct 9, 2024
fb30d07
Fix small bug and regenerate task parameters
hanouticelina Oct 9, 2024
776d63f
Merge branch 'align-inference-inputs-with-specs' of github.com:huggin…
hanouticelina Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ quality:
python utils/check_contrib_list.py
python utils/check_static_imports.py
python utils/generate_async_inference_client.py
python utils/generate_task_parameters.py

mypy src

style:
ruff format $(check_dirs) # formatter
ruff check --fix $(check_dirs) # linter
python utils/check_contrib_list.py --update
python utils/check_static_imports.py --update
python utils/generate_task_parameters.py --update
python utils/generate_async_inference_client.py --update

inference_types_check:
Expand Down
18 changes: 16 additions & 2 deletions docs/source/en/package_reference/inference_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ This part of the lib is still under development and will be improved in future r

[[autodoc]] huggingface_hub.AudioClassificationOutputElement

[[autodoc]] huggingface_hub.AudioClassificationOutputTransform

[[autodoc]] huggingface_hub.AudioClassificationParameters


Expand All @@ -37,6 +39,8 @@ This part of the lib is still under development and will be improved in future r

## automatic_speech_recognition

[[autodoc]] huggingface_hub.AutomaticSpeechRecognitionEarlyStoppingEnum

[[autodoc]] huggingface_hub.AutomaticSpeechRecognitionGenerationParameters

[[autodoc]] huggingface_hub.AutomaticSpeechRecognitionInput
Expand Down Expand Up @@ -151,6 +155,8 @@ This part of the lib is still under development and will be improved in future r

[[autodoc]] huggingface_hub.ImageClassificationOutputElement

[[autodoc]] huggingface_hub.ImageClassificationOutputTransform

[[autodoc]] huggingface_hub.ImageClassificationParameters


Expand Down Expand Up @@ -179,6 +185,8 @@ This part of the lib is still under development and will be improved in future r

## image_to_text

[[autodoc]] huggingface_hub.ImageToTextEarlyStoppingEnum

[[autodoc]] huggingface_hub.ImageToTextGenerationParameters

[[autodoc]] huggingface_hub.ImageToTextInput
Expand Down Expand Up @@ -257,6 +265,8 @@ This part of the lib is still under development and will be improved in future r

[[autodoc]] huggingface_hub.TextClassificationOutputElement

[[autodoc]] huggingface_hub.TextClassificationOutputTransform

[[autodoc]] huggingface_hub.TextClassificationParameters


Expand Down Expand Up @@ -289,6 +299,8 @@ This part of the lib is still under development and will be improved in future r

## text_to_audio

[[autodoc]] huggingface_hub.TextToAudioEarlyStoppingEnum

[[autodoc]] huggingface_hub.TextToAudioGenerationParameters

[[autodoc]] huggingface_hub.TextToAudioInput
Expand All @@ -313,6 +325,8 @@ This part of the lib is still under development and will be improved in future r

## text_to_speech

[[autodoc]] huggingface_hub.TextToSpeechEarlyStoppingEnum

[[autodoc]] huggingface_hub.TextToSpeechGenerationParameters

[[autodoc]] huggingface_hub.TextToSpeechInput
Expand Down Expand Up @@ -349,6 +363,8 @@ This part of the lib is still under development and will be improved in future r

[[autodoc]] huggingface_hub.VideoClassificationOutputElement

[[autodoc]] huggingface_hub.VideoClassificationOutputTransform

[[autodoc]] huggingface_hub.VideoClassificationParameters


Expand Down Expand Up @@ -398,5 +414,3 @@ This part of the lib is still under development and will be improved in future r
[[autodoc]] huggingface_hub.ZeroShotObjectDetectionInputData

[[autodoc]] huggingface_hub.ZeroShotObjectDetectionOutputElement


26 changes: 20 additions & 6 deletions docs/source/ko/package_reference/inference_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ rendered properly in your Markdown viewer.

[[autodoc]] huggingface_hub.AudioClassificationOutputElement

[[autodoc]] huggingface_hub.AudioClassificationOutputTransform

[[autodoc]] huggingface_hub.AudioClassificationParameters


Expand All @@ -34,7 +36,9 @@ rendered properly in your Markdown viewer.



## automatic_speech_recognition[[huggingface_hub.AutomaticSpeechRecognitionGenerationParameters]]
## automatic_speech_recognition[[huggingface_hub.AutomaticSpeechRecognitionEarlyStoppingEnum]]

[[autodoc]] huggingface_hub.AutomaticSpeechRecognitionEarlyStoppingEnum

[[autodoc]] huggingface_hub.AutomaticSpeechRecognitionGenerationParameters

Expand Down Expand Up @@ -150,6 +154,8 @@ rendered properly in your Markdown viewer.

[[autodoc]] huggingface_hub.ImageClassificationOutputElement

[[autodoc]] huggingface_hub.ImageClassificationOutputTransform

[[autodoc]] huggingface_hub.ImageClassificationParameters


Expand All @@ -176,7 +182,9 @@ rendered properly in your Markdown viewer.



## image_to_text[[huggingface_hub.ImageToTextGenerationParameters]]
## image_to_text[[huggingface_hub.ImageToTextEarlyStoppingEnum]]

[[autodoc]] huggingface_hub.ImageToTextEarlyStoppingEnum

[[autodoc]] huggingface_hub.ImageToTextGenerationParameters

Expand Down Expand Up @@ -256,6 +264,8 @@ rendered properly in your Markdown viewer.

[[autodoc]] huggingface_hub.TextClassificationOutputElement

[[autodoc]] huggingface_hub.TextClassificationOutputTransform

[[autodoc]] huggingface_hub.TextClassificationParameters


Expand Down Expand Up @@ -286,7 +296,9 @@ rendered properly in your Markdown viewer.



## text_to_audio[[huggingface_hub.TextToAudioGenerationParameters]]
## text_to_audio[[huggingface_hub.TextToAudioEarlyStoppingEnum]]

[[autodoc]] huggingface_hub.TextToAudioEarlyStoppingEnum

[[autodoc]] huggingface_hub.TextToAudioGenerationParameters

Expand All @@ -310,7 +322,9 @@ rendered properly in your Markdown viewer.



## text_to_speech[[huggingface_hub.TextToSpeechGenerationParameters]]
## text_to_speech[[huggingface_hub.TextToSpeechEarlyStoppingEnum]]

[[autodoc]] huggingface_hub.TextToSpeechEarlyStoppingEnum

[[autodoc]] huggingface_hub.TextToSpeechGenerationParameters

Expand Down Expand Up @@ -348,6 +362,8 @@ rendered properly in your Markdown viewer.

[[autodoc]] huggingface_hub.VideoClassificationOutputElement

[[autodoc]] huggingface_hub.VideoClassificationOutputTransform

[[autodoc]] huggingface_hub.VideoClassificationParameters


Expand Down Expand Up @@ -397,5 +413,3 @@ rendered properly in your Markdown viewer.
[[autodoc]] huggingface_hub.ZeroShotObjectDetectionInputData

[[autodoc]] huggingface_hub.ZeroShotObjectDetectionOutputElement


16 changes: 16 additions & 0 deletions src/huggingface_hub/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,11 @@
"inference._generated.types": [
"AudioClassificationInput",
"AudioClassificationOutputElement",
"AudioClassificationOutputTransform",
"AudioClassificationParameters",
"AudioToAudioInput",
"AudioToAudioOutputElement",
"AutomaticSpeechRecognitionEarlyStoppingEnum",
"AutomaticSpeechRecognitionGenerationParameters",
"AutomaticSpeechRecognitionInput",
"AutomaticSpeechRecognitionOutput",
Expand Down Expand Up @@ -327,6 +329,7 @@
"FillMaskParameters",
"ImageClassificationInput",
"ImageClassificationOutputElement",
"ImageClassificationOutputTransform",
"ImageClassificationParameters",
"ImageSegmentationInput",
"ImageSegmentationOutputElement",
Expand All @@ -335,6 +338,7 @@
"ImageToImageOutput",
"ImageToImageParameters",
"ImageToImageTargetSize",
"ImageToTextEarlyStoppingEnum",
"ImageToTextGenerationParameters",
"ImageToTextInput",
"ImageToTextOutput",
Expand All @@ -360,6 +364,7 @@
"Text2TextGenerationParameters",
"TextClassificationInput",
"TextClassificationOutputElement",
"TextClassificationOutputTransform",
"TextClassificationParameters",
"TextGenerationInput",
"TextGenerationInputGenerateParameters",
Expand All @@ -372,6 +377,7 @@
"TextGenerationStreamOutput",
"TextGenerationStreamOutputStreamDetails",
"TextGenerationStreamOutputToken",
"TextToAudioEarlyStoppingEnum",
"TextToAudioGenerationParameters",
"TextToAudioInput",
"TextToAudioOutput",
Expand All @@ -380,6 +386,7 @@
"TextToImageOutput",
"TextToImageParameters",
"TextToImageTargetSize",
"TextToSpeechEarlyStoppingEnum",
"TextToSpeechGenerationParameters",
"TextToSpeechInput",
"TextToSpeechOutput",
Expand All @@ -393,6 +400,7 @@
"TranslationParameters",
"VideoClassificationInput",
"VideoClassificationOutputElement",
"VideoClassificationOutputTransform",
"VideoClassificationParameters",
"VisualQuestionAnsweringInput",
"VisualQuestionAnsweringInputData",
Expand Down Expand Up @@ -794,9 +802,11 @@ def __dir__():
from .inference._generated.types import (
AudioClassificationInput, # noqa: F401
AudioClassificationOutputElement, # noqa: F401
AudioClassificationOutputTransform, # noqa: F401
AudioClassificationParameters, # noqa: F401
AudioToAudioInput, # noqa: F401
AudioToAudioOutputElement, # noqa: F401
AutomaticSpeechRecognitionEarlyStoppingEnum, # noqa: F401
AutomaticSpeechRecognitionGenerationParameters, # noqa: F401
AutomaticSpeechRecognitionInput, # noqa: F401
AutomaticSpeechRecognitionOutput, # noqa: F401
Expand Down Expand Up @@ -841,6 +851,7 @@ def __dir__():
FillMaskParameters, # noqa: F401
ImageClassificationInput, # noqa: F401
ImageClassificationOutputElement, # noqa: F401
ImageClassificationOutputTransform, # noqa: F401
ImageClassificationParameters, # noqa: F401
ImageSegmentationInput, # noqa: F401
ImageSegmentationOutputElement, # noqa: F401
Expand All @@ -849,6 +860,7 @@ def __dir__():
ImageToImageOutput, # noqa: F401
ImageToImageParameters, # noqa: F401
ImageToImageTargetSize, # noqa: F401
ImageToTextEarlyStoppingEnum, # noqa: F401
ImageToTextGenerationParameters, # noqa: F401
ImageToTextInput, # noqa: F401
ImageToTextOutput, # noqa: F401
Expand All @@ -874,6 +886,7 @@ def __dir__():
Text2TextGenerationParameters, # noqa: F401
TextClassificationInput, # noqa: F401
TextClassificationOutputElement, # noqa: F401
TextClassificationOutputTransform, # noqa: F401
TextClassificationParameters, # noqa: F401
TextGenerationInput, # noqa: F401
TextGenerationInputGenerateParameters, # noqa: F401
Expand All @@ -886,6 +899,7 @@ def __dir__():
TextGenerationStreamOutput, # noqa: F401
TextGenerationStreamOutputStreamDetails, # noqa: F401
TextGenerationStreamOutputToken, # noqa: F401
TextToAudioEarlyStoppingEnum, # noqa: F401
TextToAudioGenerationParameters, # noqa: F401
TextToAudioInput, # noqa: F401
TextToAudioOutput, # noqa: F401
Expand All @@ -894,6 +908,7 @@ def __dir__():
TextToImageOutput, # noqa: F401
TextToImageParameters, # noqa: F401
TextToImageTargetSize, # noqa: F401
TextToSpeechEarlyStoppingEnum, # noqa: F401
TextToSpeechGenerationParameters, # noqa: F401
TextToSpeechInput, # noqa: F401
TextToSpeechOutput, # noqa: F401
Expand All @@ -907,6 +922,7 @@ def __dir__():
TranslationParameters, # noqa: F401
VideoClassificationInput, # noqa: F401
VideoClassificationOutputElement, # noqa: F401
VideoClassificationOutputTransform, # noqa: F401
VideoClassificationParameters, # noqa: F401
VisualQuestionAnsweringInput, # noqa: F401
VisualQuestionAnsweringInputData, # noqa: F401
Expand Down
Loading