text
stringlengths
3
7.31k
source
stringclasses
40 values
url
stringlengths
53
184
source_section
stringlengths
0
105
file_type
stringclasses
1 value
id
stringlengths
3
6
```python One (document, question) pair to answer ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubdocumentquestionansweringinputdata
#huggingfacehubdocumentquestionansweringinputdata
.md
19_43
```python Outputs of inference for the Document Question Answering task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubdocumentquestionansweringoutputelement
#huggingfacehubdocumentquestionansweringoutputelement
.md
19_44
```python Additional inference parameters for Document Question Answering ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubdocumentquestionansweringparameters
#huggingfacehubdocumentquestionansweringparameters
.md
19_45
```python Feature Extraction Input. Auto-generated from TEI specs. For more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tei-import.ts. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubfeatureextractioninput
#huggingfacehubfeatureextractioninput
.md
19_46
```python Inputs for Fill Mask inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubfillmaskinput
#huggingfacehubfillmaskinput
.md
19_47
```python Outputs of inference for the Fill Mask task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubfillmaskoutputelement
#huggingfacehubfillmaskoutputelement
.md
19_48
```python Additional inference parameters for Fill Mask ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubfillmaskparameters
#huggingfacehubfillmaskparameters
.md
19_49
```python Inputs for Image Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimageclassificationinput
#huggingfacehubimageclassificationinput
.md
19_50
```python Outputs of inference for the Image Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimageclassificationoutputelement
#huggingfacehubimageclassificationoutputelement
.md
19_51
```python Additional inference parameters for Image Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimageclassificationparameters
#huggingfacehubimageclassificationparameters
.md
19_52
```python Inputs for Image Segmentation inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagesegmentationinput
#huggingfacehubimagesegmentationinput
.md
19_53
```python Outputs of inference for the Image Segmentation task A predicted mask / segment ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagesegmentationoutputelement
#huggingfacehubimagesegmentationoutputelement
.md
19_54
```python Additional inference parameters for Image Segmentation ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagesegmentationparameters
#huggingfacehubimagesegmentationparameters
.md
19_55
```python Inputs for Image To Image inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetoimageinput
#huggingfacehubimagetoimageinput
.md
19_56
```python Outputs of inference for the Image To Image task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetoimageoutput
#huggingfacehubimagetoimageoutput
.md
19_57
```python Additional inference parameters for Image To Image ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetoimageparameters
#huggingfacehubimagetoimageparameters
.md
19_58
```python The size in pixel of the output image. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetoimagetargetsize
#huggingfacehubimagetoimagetargetsize
.md
19_59
```python Parametrization of the text generation process ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetotextgenerationparameters
#huggingfacehubimagetotextgenerationparameters
.md
19_60
```python Inputs for Image To Text inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetotextinput
#huggingfacehubimagetotextinput
.md
19_61
```python Outputs of inference for the Image To Text task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetotextoutput
#huggingfacehubimagetotextoutput
.md
19_62
```python Additional inference parameters for Image To Text ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubimagetotextparameters
#huggingfacehubimagetotextparameters
.md
19_63
```python The predicted bounding box. Coordinates are relative to the top left corner of the input image. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubobjectdetectionboundingbox
#huggingfacehubobjectdetectionboundingbox
.md
19_64
```python Inputs for Object Detection inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubobjectdetectioninput
#huggingfacehubobjectdetectioninput
.md
19_65
```python Outputs of inference for the Object Detection task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubobjectdetectionoutputelement
#huggingfacehubobjectdetectionoutputelement
.md
19_66
```python Additional inference parameters for Object Detection ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubobjectdetectionparameters
#huggingfacehubobjectdetectionparameters
.md
19_67
```python Inputs for Question Answering inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubquestionansweringinput
#huggingfacehubquestionansweringinput
.md
19_68
```python One (context, question) pair to answer ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubquestionansweringinputdata
#huggingfacehubquestionansweringinputdata
.md
19_69
```python Outputs of inference for the Question Answering task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubquestionansweringoutputelement
#huggingfacehubquestionansweringoutputelement
.md
19_70
```python Additional inference parameters for Question Answering ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubquestionansweringparameters
#huggingfacehubquestionansweringparameters
.md
19_71
```python Inputs for Sentence similarity inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubsentencesimilarityinput
#huggingfacehubsentencesimilarityinput
.md
19_72
```python SentenceSimilarityInputData(sentences: List[str], source_sentence: str) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubsentencesimilarityinputdata
#huggingfacehubsentencesimilarityinputdata
.md
19_73
```python Inputs for Summarization inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubsummarizationinput
#huggingfacehubsummarizationinput
.md
19_74
```python Outputs of inference for the Summarization task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubsummarizationoutput
#huggingfacehubsummarizationoutput
.md
19_75
```python Additional inference parameters for summarization. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubsummarizationparameters
#huggingfacehubsummarizationparameters
.md
19_76
```python Inputs for Table Question Answering inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtablequestionansweringinput
#huggingfacehubtablequestionansweringinput
.md
19_77
```python One (table, question) pair to answer ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtablequestionansweringinputdata
#huggingfacehubtablequestionansweringinputdata
.md
19_78
```python Outputs of inference for the Table Question Answering task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtablequestionansweringoutputelement
#huggingfacehubtablequestionansweringoutputelement
.md
19_79
```python Additional inference parameters for Table Question Answering ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtablequestionansweringparameters
#huggingfacehubtablequestionansweringparameters
.md
19_80
```python Inputs for Text2text Generation inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtext2textgenerationinput
#huggingfacehubtext2textgenerationinput
.md
19_81
```python Outputs of inference for the Text2text Generation task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtext2textgenerationoutput
#huggingfacehubtext2textgenerationoutput
.md
19_82
```python Additional inference parameters for Text2text Generation ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtext2textgenerationparameters
#huggingfacehubtext2textgenerationparameters
.md
19_83
```python Inputs for Text Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextclassificationinput
#huggingfacehubtextclassificationinput
.md
19_84
```python Outputs of inference for the Text Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextclassificationoutputelement
#huggingfacehubtextclassificationoutputelement
.md
19_85
```python Additional inference parameters for Text Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextclassificationparameters
#huggingfacehubtextclassificationparameters
.md
19_86
```python Text Generation 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. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationinput
#huggingfacehubtextgenerationinput
.md
19_87
```python TextGenerationInputGenerateParameters(adapter_id: Optional[str] = None, best_of: Optional[int] = None, decoder_input_details: Optional[bool] = None, details: Optional[bool] = None, do_sample: Optional[bool] = None, frequency_penalty: Optional[float] = None, grammar: Optional[huggingface_hub.inference._generated.types.text_generation.TextGenerationInputGrammarType] = None, max_new_tokens: Optional[int] = None, repetition_penalty: Optional[float] = None, return_full_text: Optional[bool] = None, seed: Optional[int] = None, stop: Optional[List[str]] = None, temperature: Optional[float] = None, top_k: Optional[int] = None, top_n_tokens: Optional[int] = None, top_p: Optional[float] = None, truncate: Optional[int] = None, typical_p: Optional[float] = None, watermark: Optional[bool] = None) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationinputgenerateparameters
#huggingfacehubtextgenerationinputgenerateparameters
.md
19_88
```python TextGenerationInputGrammarType(type: 'TypeEnum', value: Any) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationinputgrammartype
#huggingfacehubtextgenerationinputgrammartype
.md
19_89
```python Text Generation 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. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationoutput
#huggingfacehubtextgenerationoutput
.md
19_90
```python TextGenerationOutputBestOfSequence(finish_reason: 'TextGenerationOutputFinishReason', generated_text: str, generated_tokens: int, prefill: List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputPrefillToken], tokens: List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken], seed: Optional[int] = None, top_tokens: Optional[List[List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]]] = None) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationoutputbestofsequence
#huggingfacehubtextgenerationoutputbestofsequence
.md
19_91
```python TextGenerationOutputDetails(finish_reason: 'TextGenerationOutputFinishReason', generated_tokens: int, prefill: List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputPrefillToken], tokens: List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken], best_of_sequences: Optional[List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputBestOfSequence]] = None, seed: Optional[int] = None, top_tokens: Optional[List[List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]]] = None) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationoutputdetails
#huggingfacehubtextgenerationoutputdetails
.md
19_92
```python TextGenerationOutputPrefillToken(id: int, logprob: float, text: str) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationoutputprefilltoken
#huggingfacehubtextgenerationoutputprefilltoken
.md
19_93
```python TextGenerationOutputToken(id: int, logprob: float, special: bool, text: str) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationoutputtoken
#huggingfacehubtextgenerationoutputtoken
.md
19_94
```python Text Generation Stream 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. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationstreamoutput
#huggingfacehubtextgenerationstreamoutput
.md
19_95
```python TextGenerationStreamOutputStreamDetails(finish_reason: 'TextGenerationOutputFinishReason', generated_tokens: int, input_length: int, seed: Optional[int] = None) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationstreamoutputstreamdetails
#huggingfacehubtextgenerationstreamoutputstreamdetails
.md
19_96
```python TextGenerationStreamOutputToken(id: int, logprob: float, special: bool, text: str) ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtextgenerationstreamoutputtoken
#huggingfacehubtextgenerationstreamoutputtoken
.md
19_97
```python Parametrization of the text generation process ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoaudiogenerationparameters
#huggingfacehubtexttoaudiogenerationparameters
.md
19_98
```python Inputs for Text To Audio inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoaudioinput
#huggingfacehubtexttoaudioinput
.md
19_99
```python Outputs of inference for the Text To Audio task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoaudiooutput
#huggingfacehubtexttoaudiooutput
.md
19_100
```python Additional inference parameters for Text To Audio ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoaudioparameters
#huggingfacehubtexttoaudioparameters
.md
19_101
```python Inputs for Text To Image inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoimageinput
#huggingfacehubtexttoimageinput
.md
19_102
```python Outputs of inference for the Text To Image task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoimageoutput
#huggingfacehubtexttoimageoutput
.md
19_103
```python Additional inference parameters for Text To Image ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoimageparameters
#huggingfacehubtexttoimageparameters
.md
19_104
```python The size in pixel of the output image ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttoimagetargetsize
#huggingfacehubtexttoimagetargetsize
.md
19_105
```python Parametrization of the text generation process ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttospeechgenerationparameters
#huggingfacehubtexttospeechgenerationparameters
.md
19_106
```python Inputs for Text To Speech inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttospeechinput
#huggingfacehubtexttospeechinput
.md
19_107
```python Outputs for Text to Speech inference Outputs of inference for the Text To Audio task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttospeechoutput
#huggingfacehubtexttospeechoutput
.md
19_108
```python Additional inference parameters for Text To Speech ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtexttospeechparameters
#huggingfacehubtexttospeechparameters
.md
19_109
```python Inputs for Token Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtokenclassificationinput
#huggingfacehubtokenclassificationinput
.md
19_110
```python Outputs of inference for the Token Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtokenclassificationoutputelement
#huggingfacehubtokenclassificationoutputelement
.md
19_111
```python Additional inference parameters for Token Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtokenclassificationparameters
#huggingfacehubtokenclassificationparameters
.md
19_112
```python Inputs for Translation inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtranslationinput
#huggingfacehubtranslationinput
.md
19_113
```python Outputs of inference for the Translation task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtranslationoutput
#huggingfacehubtranslationoutput
.md
19_114
```python Additional inference parameters for Translation ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubtranslationparameters
#huggingfacehubtranslationparameters
.md
19_115
```python Inputs for Video Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvideoclassificationinput
#huggingfacehubvideoclassificationinput
.md
19_116
```python Outputs of inference for the Video Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvideoclassificationoutputelement
#huggingfacehubvideoclassificationoutputelement
.md
19_117
```python Additional inference parameters for Video Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvideoclassificationparameters
#huggingfacehubvideoclassificationparameters
.md
19_118
```python Inputs for Visual Question Answering inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringinput
#huggingfacehubvisualquestionansweringinput
.md
19_119
```python One (image, question) pair to answer ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringinputdata
#huggingfacehubvisualquestionansweringinputdata
.md
19_120
```python Outputs of inference for the Visual Question Answering task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringoutputelement
#huggingfacehubvisualquestionansweringoutputelement
.md
19_121
```python Additional inference parameters for Visual Question Answering ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringparameters
#huggingfacehubvisualquestionansweringparameters
.md
19_122
```python Inputs for Zero Shot Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationinput
#huggingfacehubzeroshotclassificationinput
.md
19_123
```python Outputs of inference for the Zero Shot Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationoutputelement
#huggingfacehubzeroshotclassificationoutputelement
.md
19_124
```python Additional inference parameters for Zero Shot Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationparameters
#huggingfacehubzeroshotclassificationparameters
.md
19_125
```python Inputs for Zero Shot Image Classification inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationinput
#huggingfacehubzeroshotimageclassificationinput
.md
19_126
```python Outputs of inference for the Zero Shot Image Classification task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationoutputelement
#huggingfacehubzeroshotimageclassificationoutputelement
.md
19_127
```python Additional inference parameters for Zero Shot Image Classification ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationparameters
#huggingfacehubzeroshotimageclassificationparameters
.md
19_128
```python The predicted bounding box. Coordinates are relative to the top left corner of the input image. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionboundingbox
#huggingfacehubzeroshotobjectdetectionboundingbox
.md
19_129
```python Inputs for Zero Shot Object Detection inference ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectioninput
#huggingfacehubzeroshotobjectdetectioninput
.md
19_130
```python Outputs of inference for the Zero Shot Object Detection task ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionoutputelement
#huggingfacehubzeroshotobjectdetectionoutputelement
.md
19_131
```python Additional inference parameters for Zero Shot Object Detection ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionparameters
#huggingfacehubzeroshotobjectdetectionparameters
.md
19_132
<!--⚠️ Note that this file is in Markdown but contains specific syntax for our doc-builder (similar to MDX) that may not be rendered properly in your Markdown viewer. -->
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/
.md
20_0
The caching system was updated in v0.8.0 to become the central cache-system shared across libraries that depend on the Hub. Read the [cache-system guide](../guides/manage-cache) for a detailed presentation of caching at HF.
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#cache-system-reference
#cache-system-reference
.md
20_1
```python Explores the cache to return the latest cached file for a given revision if found. This function will not raise any exception if the file in not cached. Args: cache_dir (`str` or `os.PathLike`): The folder where the cached files lie. repo_id (`str`): The ID of the repo on huggingface.co. filename (`str`): The filename to look for inside `repo_id`. revision (`str`, *optional*): The specific model version to use. Will default to `"main"` if it's not provided and no `commit_hash` is provided either. repo_type (`str`, *optional*): The type of the repository. Will default to `"model"`. Returns: `Optional[str]` or `_CACHED_NO_EXIST`: Will return `None` if the file was not cached. Otherwise: - The exact path to the cached file if it's found in the cache - A special value `_CACHED_NO_EXIST` if the file does not exist at the given commit hash and this fact was cached. Example: ```python from huggingface_hub import try_to_load_from_cache, _CACHED_NO_EXIST filepath = try_to_load_from_cache() if isinstance(filepath, str):
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubtrytoloadfromcache
#huggingfacehubtrytoloadfromcache
.md
20_2
... elif filepath is _CACHED_NO_EXIST:
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#file-exists-and-is-cached
#file-exists-and-is-cached
.md
20_3
... else:
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#non-existence-of-file-is-cached
#non-existence-of-file-is-cached
.md
20_4
... ``` ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#file-is-not-cached
#file-is-not-cached
.md
20_5
```python Return a folder path to cache arbitrary files. `huggingface_hub` provides a canonical folder path to store assets. This is the recommended way to integrate cache in a downstream library as it will benefit from the builtins tools to scan and delete the cache properly. The distinction is made between files cached from the Hub and assets. Files from the Hub are cached in a git-aware manner and entirely managed by `huggingface_hub`. See [related documentation](https://huggingface.co/docs/huggingface_hub/how-to-cache). All other files that a downstream library caches are considered to be "assets" (files downloaded from external sources, extracted from a .tar archive, preprocessed for training,...). Once the folder path is generated, it is guaranteed to exist and to be a directory. The path is based on 3 levels of depth: the library name, a namespace and a subfolder. Those 3 levels grants flexibility while allowing `huggingface_hub` to expect folders when scanning/deleting parts of the assets cache. Within a library, it is expected that all namespaces share the same subset of subfolder names but this is not a mandatory rule. The downstream library has then full control on which file structure to adopt within its cache. Namespace and subfolder are optional (would default to a `"default/"` subfolder) but library name is mandatory as we want every downstream library to manage its own cache. Expected tree: ```text assets/ └── datasets/ β”‚ β”œβ”€β”€ SQuAD/ β”‚ β”‚ β”œβ”€β”€ downloaded/ β”‚ β”‚ β”œβ”€β”€ extracted/ β”‚ β”‚ └── processed/ β”‚ β”œβ”€β”€ Helsinki-NLP--tatoeba_mt/ β”‚ β”œβ”€β”€ downloaded/ β”‚ β”œβ”€β”€ extracted/ β”‚ └── processed/ └── transformers/ β”œβ”€β”€ default/ β”‚ β”œβ”€β”€ something/ β”œβ”€β”€ bert-base-cased/ β”‚ β”œβ”€β”€ default/ β”‚ └── training/ hub/ └── models--julien-c--EsperBERTo-small/ β”œβ”€β”€ blobs/ β”‚ β”œβ”€β”€ (...) β”‚ β”œβ”€β”€ (...) β”œβ”€β”€ refs/ β”‚ └── (...) └── [ 128] snapshots/ β”œβ”€β”€ 2439f60ef33a0d46d85da5001d52aeda5b00ce9f/ β”‚ β”œβ”€β”€ (...) └── bbc77c8132af1cc5cf678da3f1ddf2de43606d48/ └── (...) ``` Args: library_name (`str`): Name of the library that will manage the cache folder. Example: `"dataset"`. namespace (`str`, *optional*, defaults to "default"): Namespace to which the data belongs. Example: `"SQuAD"`. subfolder (`str`, *optional*, defaults to "default"): Subfolder in which the data will be stored. Example: `extracted`. assets_dir (`str`, `Path`, *optional*): Path to the folder where assets are cached. This must not be the same folder where Hub files are cached. Defaults to `HF_HOME / "assets"` if not provided. Can also be set with `HF_ASSETS_CACHE` environment variable. Returns: Path to the cache folder (`Path`). Example: ```py >>> from huggingface_hub import cached_assets_path >>> cached_assets_path(library_name="datasets", namespace="SQuAD", subfolder="download") PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/SQuAD/download') >>> cached_assets_path(library_name="datasets", namespace="SQuAD", subfolder="extracted") PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/SQuAD/extracted') >>> cached_assets_path(library_name="datasets", namespace="Helsinki-NLP/tatoeba_mt") PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/Helsinki-NLP--tatoeba_mt/default') >>> cached_assets_path(library_name="datasets", assets_dir="/tmp/tmp123456") PosixPath('/tmp/tmp123456/datasets/default/default') ``` ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath
#huggingfacehubcachedassetspath
.md
20_6
```python Scan the entire HF cache-system and return a [`~HFCacheInfo`] structure. Use `scan_cache_dir` in order to programmatically scan your cache-system. The cache will be scanned repo by repo. If a repo is corrupted, a [`~CorruptedCacheException`] will be thrown internally but captured and returned in the [`~HFCacheInfo`] structure. Only valid repos get a proper report. ```py >>> from huggingface_hub import scan_cache_dir >>> hf_cache_info = scan_cache_dir() HFCacheInfo( size_on_disk=3398085269, repos=frozenset({ CachedRepoInfo( repo_id='t5-small', repo_type='model', repo_path=PosixPath(...), size_on_disk=970726914, nb_files=11, revisions=frozenset({ CachedRevisionInfo( commit_hash='d78aea13fa7ecd06c29e3e46195d6341255065d5', size_on_disk=970726339, snapshot_path=PosixPath(...), files=frozenset({ CachedFileInfo( file_name='config.json', size_on_disk=1197 file_path=PosixPath(...), blob_path=PosixPath(...), ), CachedFileInfo(...), ... }), ), CachedRevisionInfo(...), ... }), ), CachedRepoInfo(...), ... }), warnings=[ CorruptedCacheException("Snapshots dir doesn't exist in cached repo: ..."), CorruptedCacheException(...), ... ], ) ``` You can also print a detailed report directly from the `huggingface-cli` using: ```text > huggingface-cli scan-cache REPO ID REPO TYPE SIZE ON DISK NB FILES REFS LOCAL PATH --------------------------- --------- ------------ -------- ------------------- ------------------------------------------------------------------------- glue dataset 116.3K 15 1.17.0, main, 2.4.0 /Users/lucain/.cache/huggingface/hub/datasets--glue google/fleurs dataset 64.9M 6 main, refs/pr/1 /Users/lucain/.cache/huggingface/hub/datasets--google--fleurs Jean-Baptiste/camembert-ner model 441.0M 7 main /Users/lucain/.cache/huggingface/hub/models--Jean-Baptiste--camembert-ner bert-base-cased model 1.9G 13 main /Users/lucain/.cache/huggingface/hub/models--bert-base-cased t5-base model 10.1K 3 main /Users/lucain/.cache/huggingface/hub/models--t5-base t5-small model 970.7M 11 refs/pr/1, main /Users/lucain/.cache/huggingface/hub/models--t5-small Done in 0.0s. Scanned 6 repo(s) for a total of 3.4G. Got 1 warning(s) while scanning. Use -vvv to print details. ``` Args: cache_dir (`str` or `Path`, `optional`): Cache directory to cache. Defaults to the default HF cache directory. <Tip warning={true}> Raises: `CacheNotFound` If the cache directory does not exist. [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If the cache directory is a file, instead of a directory. </Tip> Returns: a [`~HFCacheInfo`] object. ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir
#huggingfacehubscancachedir
.md
20_7
All structures are built and returned by [`scan_cache_dir`] and are immutable.
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#data-structures
#data-structures
.md
20_8
```python Frozen data structure holding information about the entire cache-system. This data structure is returned by [`scan_cache_dir`] and is immutable. Args: size_on_disk (`int`): Sum of all valid repo sizes in the cache-system. repos (`FrozenSet[CachedRepoInfo]`): Set of [`~CachedRepoInfo`] describing all valid cached repos found on the cache-system while scanning. warnings (`List[CorruptedCacheException]`): List of [`~CorruptedCacheException`] that occurred while scanning the cache. Those exceptions are captured so that the scan can continue. Corrupted repos are skipped from the scan. <Tip warning={true}> Here `size_on_disk` is equal to the sum of all repo sizes (only blobs). However if some cached repos are corrupted, their sizes are not taken into account. </Tip> ```
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md
https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubhfcacheinfo
#huggingfacehubhfcacheinfo
.md
20_9