source
stringclasses 40
values | file_type
stringclasses 1
value | chunk
stringlengths 3
512
| id
int64 0
1.5k
|
|---|---|---|---|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionOutputMessage(role: str, content: Optional[str] = None, tool_calls: Optional[List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputToolCall]] = None)
```
| 600
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionOutputToolCall(function: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutputFunctionDefinition, id: str, type: str)
```
| 601
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionOutputTopLogprob(logprob: float, token: str)
```
| 602
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionOutputUsage(completion_tokens: int, prompt_tokens: int, total_tokens: int)
```
| 603
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Chat Completion 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.
```
| 604
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputChoice(delta: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputDelta, index: int, finish_reason: Optional[str] = None, logprobs: Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputLogprobs] = None)
```
| 605
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputDelta(role: str, content: Optional[str] = None, tool_calls: Optional[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputDeltaToolCall] = None)
```
| 606
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputDeltaToolCall(function: huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputFunction, id: str, index: int, type: str)
```
| 607
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputFunction(arguments: str, name: Optional[str] = None)
```
| 608
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputLogprob(logprob: float, token: str, top_logprobs: List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputTopLogprob])
```
| 609
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputLogprobs(content: List[huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutputLogprob])
```
| 610
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputTopLogprob(logprob: float, token: str)
```
| 611
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
ChatCompletionStreamOutputUsage(completion_tokens: int, prompt_tokens: int, total_tokens: int)
```
| 612
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Depth Estimation inference
```
| 613
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Depth Estimation task
```
| 614
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Document Question Answering inference
```
| 615
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
One (document, question) pair to answer
```
| 616
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Document Question Answering task
```
| 617
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Document Question Answering
```
| 618
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```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.
```
| 619
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Fill Mask inference
```
| 620
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Fill Mask task
```
| 621
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Fill Mask
```
| 622
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Image Classification inference
```
| 623
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Image Classification task
```
| 624
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Image Classification
```
| 625
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Image Segmentation inference
```
| 626
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Image Segmentation task
A predicted mask / segment
```
| 627
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Image Segmentation
```
| 628
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Image To Image inference
```
| 629
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Image To Image task
```
| 630
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Image To Image
```
| 631
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
The size in pixel of the output image.
```
| 632
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Parametrization of the text generation process
```
| 633
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Image To Text inference
```
| 634
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Image To Text task
```
| 635
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Image To Text
```
| 636
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
The predicted bounding box. Coordinates are relative to the top left corner of the input
image.
```
| 637
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Object Detection inference
```
| 638
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Object Detection task
```
| 639
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Object Detection
```
| 640
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Question Answering inference
```
| 641
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
One (context, question) pair to answer
```
| 642
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Question Answering task
```
| 643
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Question Answering
```
| 644
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Sentence similarity inference
```
| 645
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
SentenceSimilarityInputData(sentences: List[str], source_sentence: str)
```
| 646
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Summarization inference
```
| 647
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Summarization task
```
| 648
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for summarization.
```
| 649
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Table Question Answering inference
```
| 650
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
One (table, question) pair to answer
```
| 651
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Table Question Answering task
```
| 652
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Table Question Answering
```
| 653
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Text2text Generation inference
```
| 654
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Text2text Generation task
```
| 655
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Text2text Generation
```
| 656
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Text Classification inference
```
| 657
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Text Classification task
```
| 658
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Text Classification
```
| 659
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```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.
```
| 660
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
| 661
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
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:
| 662
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
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)
| 663
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```
| 664
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
TextGenerationInputGrammarType(type: 'TypeEnum', value: Any)
```
| 665
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```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.
```
| 666
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```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)
```
| 667
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
| 668
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
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:
| 669
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
= None, seed: Optional[int] = None, top_tokens: Optional[List[List[huggingface_hub.inference._generated.types.text_generation.TextGenerationOutputToken]]] = None)
| 670
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```
| 671
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
TextGenerationOutputPrefillToken(id: int, logprob: float, text: str)
```
| 672
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
TextGenerationOutputToken(id: int, logprob: float, special: bool, text: str)
```
| 673
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```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.
```
| 674
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
TextGenerationStreamOutputStreamDetails(finish_reason: 'TextGenerationOutputFinishReason', generated_tokens: int, input_length: int, seed: Optional[int] = None)
```
| 675
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
TextGenerationStreamOutputToken(id: int, logprob: float, special: bool, text: str)
```
| 676
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Parametrization of the text generation process
```
| 677
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Text To Audio inference
```
| 678
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Text To Audio task
```
| 679
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Text To Audio
```
| 680
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Text To Image inference
```
| 681
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Text To Image task
```
| 682
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Text To Image
```
| 683
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
The size in pixel of the output image
```
| 684
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Parametrization of the text generation process
```
| 685
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Text To Speech inference
```
| 686
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs for Text to Speech inference
Outputs of inference for the Text To Audio task
```
| 687
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Text To Speech
```
| 688
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Token Classification inference
```
| 689
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Token Classification task
```
| 690
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Token Classification
```
| 691
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Translation inference
```
| 692
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Translation task
```
| 693
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Translation
```
| 694
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Video Classification inference
```
| 695
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Outputs of inference for the Video Classification task
```
| 696
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Additional inference parameters for Video Classification
```
| 697
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
Inputs for Visual Question Answering inference
```
| 698
|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md
|
.md
|
```python
One (image, question) pair to answer
```
| 699
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.