Skip to content

[Bot] Update API inference documentation #1492

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
merged 1 commit into from
Nov 19, 2024
Merged

[Bot] Update API inference documentation #1492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions docs/api-inference/tasks/zero-shot-classification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,10 @@ To use the JavaScript client, see `huggingface.js`'s [package reference](https:/

| Payload | | |
| :--- | :--- | :--- |
| **inputs*** | _object_ | The input text data, with candidate labels |
| **        text*** | _string_ | The text to classify |
| **        candidateLabels*** | _string[]_ | The set of possible class labels to classify the text into. |
| **parameters** | _object_ | Additional inference parameters for Zero Shot Classification |
| **        hypothesis_template** | _string_ | The sentence used in conjunction with candidateLabels to attempt the text classification by replacing the placeholder with the candidate labels. |
| **inputs*** | _string_ | The text to classify |
| **parameters*** | _object_ | Additional inference parameters for Zero Shot Classification |
| **        candidate_labels*** | _string[]_ | The set of possible class labels to classify the text into. |
| **        hypothesis_template** | _string_ | The sentence used in conjunction with `candidate_labels` to attempt the text classification by replacing the placeholder with the candidate labels. |
| **        multi_label** | _boolean_ | Whether multiple candidate labels can be true. If false, the scores are normalized such that the sum of the label likelihoods for each sequence is 1. If true, the labels are considered independent and probabilities are normalized for each candidate. |


Expand Down
Loading